Wiki

Revision as of 12:40, 7 February 2019

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.

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.

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.

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 non, delete this section.

@@ Line 1: / Line 1: @@
-This is a '''Style Guide''' for the Restart Wiki
+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.
 ==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.
+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===