Style guide: Difference between revisions
(Marked this version for translation) |
|||
| (20 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
This is a '''Style Guide''' for the Restart Wiki | <languages/> | ||
<translate> | |||
<!--T:1--> | |||
This is a '''Style Guide''' for the Restart Wiki. All pages should start with a brief description of the purpose of the page. This will appear in Page Previews when a user hovers over a link to the page. | |||
<!--T:2--> | |||
When creating a new page, please also create an associated Discussion page based on the one for this page. | |||
==Main section== | ==Summary== <!--T:3--> | ||
<!--T:4--> | |||
All pages should start with a summary, to enable the reader to see at a glance what the page is about and whether it is likely to give the information required. This is subtly different from the description of the page's purpose, given above. | |||
===Safety=== <!--T:5--> | |||
<!--T:6--> | |||
[[File:Warning03.png|30px|left]] | |||
::Consider whether your page should include a specific section on safety. | |||
::*if for example it deals with mains-powered equipment or high voltages | |||
::*or if special care is required in handling hot or sharp tools | |||
::*or hazardous substances. | |||
[[File:Warning03.png|30px|left]] | |||
::Should we use a second icon for a second unrelated warning (taking care it doesn't collide with the first)? Also, check it doesn't steal left margin from the next section header. | |||
==Main section== <!--T:7--> | |||
<!--T:8--> | |||
[[File:GingerCat.jpg|180px|thumb|right|A cat.]] | |||
The meat of the page goes here, typically organised under several top-level headings. | The meat of the page goes here, typically organised under several top-level headings. | ||
===Subsection=== | <!--T:9--> | ||
Add pictures like this, each with a suitable description. Alternating them left and right can help keep them aligned with the related text. | |||
<!--T:10--> | |||
N.B. All pictures must include appropriate licencing information. For ones you create yourself for the Wiki, please licence them under Own Work, Creative Commons Attribution-Share Alike 4.0 (CC-BY-SA-4.0). | |||
<!--T:18--> | |||
Wherever possible, technical terms such as [[Glossary:Electricity|electricity]] should be linked to the Glossary definition (as demonstrated) rather than being defined in the text. | |||
===Subsection=== <!--T:11--> | |||
<!--T:12--> | |||
Organise the information using subsections to make it easy to navigate. | Organise the information using subsections to make it easy to navigate. | ||
====Sub-subsection==== | ====Sub-subsection==== <!--T:13--> | ||
<!--T:14--> | |||
A 3rd level of subsection may be useful. | A 3rd level of subsection may be useful. | ||
== | ==External links== <!--T:15--> | ||
<!--T:16--> | |||
* External links as bullet points | * External links (if any) as bullet points. | ||
* If none, delete this section. | |||
<!--T:17--> | |||
[[Category:General]] | [[Category:General]] | ||
</translate> | |||
Latest revision as of 20:15, 29 December 2021
This is a Style Guide for the Restart Wiki. All pages should start with a brief description of the purpose of the page. This will appear in Page Previews when a user hovers over a link to the page.
When creating a new page, please also create an associated Discussion page based on the one for this page.
Summary
All pages should start with a summary, to enable the reader to see at a glance what the page is about and whether it is likely to give the information required. This is subtly different from the description of the page's purpose, given above.
Safety
- Consider whether your page should include a specific section on safety.
- if for example it deals with mains-powered equipment or high voltages
- or if special care is required in handling hot or sharp tools
- or hazardous substances.
- Consider whether your page should include a specific section on safety.
- Should we use a second icon for a second unrelated warning (taking care it doesn't collide with the first)? Also, check it doesn't steal left margin from the next section header.
Main section
The meat of the page goes here, typically organised under several top-level headings.
Add pictures like this, each with a suitable description. Alternating them left and right can help keep them aligned with the related text.
N.B. All pictures must include appropriate licencing information. For ones you create yourself for the Wiki, please licence them under Own Work, Creative Commons Attribution-Share Alike 4.0 (CC-BY-SA-4.0).
Wherever possible, technical terms such as electricity should be linked to the Glossary definition (as demonstrated) rather than being defined in the text.
Subsection
Organise the information using subsections to make it easy to navigate.
Sub-subsection
A 3rd level of subsection may be useful.
External links
- External links (if any) as bullet points.
- If none, delete this section.