Style guide: Difference between revisions
mNo edit summary |
|||
| (14 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Introduction == | == Introduction == | ||
This page presents a style guide for use with Collapsible. It's totally up for suggested changes and enhancements. There | This page presents a vague attempt at a style guide for use with Collapsible. It's totally up for suggested changes and enhancements. There will be a lot missing. | ||
== Headings == | == Headings == | ||
All | All headings within the article should start at Level 2, and subheadings under them nested at Level 3, 4, 5, 6 (smallest). L1 headings compete with page title, and so can look a bit confusing. This is in accordance to the way Wikipedia do it<ref>https://en.wikipedia.org/wiki/Help:Section#Creation_and_numbering_of_sections</ref> | ||
== Units == | == Units == | ||
| Line 19: | Line 18: | ||
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. | 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 == | ||
| Line 24: | Line 27: | ||
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'. | 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'. | ||
== | == Language == | ||
The wiki will begin in English (British or US English can be used), and we'll look to translate out pages later when they're looking complete. | |||
== 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 == | == Citations == | ||
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 />'''. | ||
An example of an article doing this is [[Radio|here]]. | |||
== Actual citations for this page == | |||
<references /> | |||
Latest revision as of 03:32, 3 July 2024
Introduction
This page presents a vague attempt at a style guide for use with Collapsible. It's totally up for suggested changes and enhancements. There will be a lot missing.
Headings
All headings within the article should start at Level 2, and subheadings under them nested at Level 3, 4, 5, 6 (smallest). L1 headings compete with page title, and so can look a bit confusing. This is in accordance to the way Wikipedia do it[1]
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'.
Language
The wiki will begin in English (British or US English can be used), and we'll look to translate out pages later when they're looking complete.
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
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 />.
An example of an article doing this is here.