Style guide: Difference between revisions

From Collapsible Systems Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 2: Line 2:


This page presents a style guide for use with Collapsible. It's totally up for suggested changes and enhancements. There is a lot to fit in.  
This page presents a style guide for use with Collapsible. It's totally up for suggested changes and enhancements. There is a lot to fit in.  
Aside from the [[Linkdump|Link Dump]], all other pages are articles and should have an introduction under ''Introduction'' that clearly states why the given page has been created and its utility and relevance as regards the broader Collapsible frame.


== Headings ==
== Headings ==
Line 32: Line 31:
British or US English can be used.
British or US English can be used.


== Citations ==
== Article structure ==
 
Aside from the [[Linkdump|Link Dump]], all other pages are articles and should have an introduction under ''Introduction'' that clearly states why the given page has been created and its utility and relevance as regards the broader Collapsible frame.


Citations should be placed at the end of the sentence. They can be added using the <ref>Citation here</ref> tag.
Citations should be placed at the end of the sentence. They can be added using the <ref>Citation here</ref> tag. A heading Citations should be added to the bottom of the page. Under this heading, all that's needed for the citations to automagically appear is adding the following tag: <references \>

Revision as of 05:55, 29 August 2023

Introduction

This page presents a style guide for use with Collapsible. It's totally up for suggested changes and enhancements. There is a lot to fit in.

Headings

All sub-topics within the article should have headings at Level 2, and subsequent headings under them at Level 4. This is because the sizes seem to work out best across desktop and phone, different browsers.

Units

Metric is the default, with Imperial in brackets. For instance, "For raised garden beds longer than 3 meters (9.8 feet), place stakes every 1.5 meters (4.9 feet)". Unit abbreviations can be used.

Technical Terms

New terms should be introduced in italics. Important terms can be in bold.

Acronyms

First uses of an acronym in the given article should always follow the full term, for instance "Software Defined Radio (SDR)", after which point the acronym can be used on its own.

Region

Articles should cite regional specific relevance wherever it occurs, including headings per region where useful. For instance, an article on Foraging would cite mushrooms or plants by the regions in which they can be found.

New pages

New pages should start with a capital letter, and if they have more than one word, 2nd and subsequent words should be lower case. For instance 'Style guide'.

English

British or US English can be used.

Article structure

Aside from the Link Dump, all other pages are articles and should have an introduction under Introduction that clearly states why the given page has been created and its utility and relevance as regards the broader Collapsible frame.

Citations should be placed at the end of the sentence. They can be added using the <ref>Citation here</ref> tag. A heading Citations should be added to the bottom of the page. Under this heading, all that's needed for the citations to automagically appear is adding the following tag: <references \>