Style guide: Difference between revisions

Line 18: Line 18:


Add pictures like this, each with a suitable description. Alternating them left and right can help keep them aligned with the related text.
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 to create yourseld for the Wiki, please licence them under Own Work, Creative Commons Attribution-Share Alike 3.0 (CC-BY-SA-3.0). (Note: we will shortly be moving to 4.0.)


===Subsection===
===Subsection===

Revision as of 17:13, 17 December 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

Warning03.png
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.
Warning03.png
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

A cat.

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 to create yourseld for the Wiki, please licence them under Own Work, Creative Commons Attribution-Share Alike 3.0 (CC-BY-SA-3.0). (Note: we will shortly be moving to 4.0.)

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.