Help:Style Guide

Revision as of 00:08, 17 October 2018 by Rjt (talk | contribs) (Terms: Tidied writing a little)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Under-construction monkies.gif This document is a work in progress. Everything in this document is subject to change.


Conventions

In order to make documents easy to read we will follow a number of conventions. At the moment they are used in the Bylaws document only. We have templates available to make it easier to keep them consistent too. These conventions should always be explained at the beginning of any Official Document in which they're used.

Terms

A term is anything that requires a strict definition. Terms are italicised, and italicised and underlined at the place where they’re defined. For the writers' convenience, terms do not need to be italicised more than once per section, although they should be if it makes the text clearer. One exception to this rule is when a term is introduced but not yet defined in a section; in this case, they should be italicised every time they’re used in this section until they’re defined, then underlined and italicised. Terms and definitions should also be compiled into the wiki's Glossary.

  • To mark something as a term you can use the template {{Term|t}}, where t is replaced by the term you are using.
  • To mark something as a term with a definition you can use the template {{Termdef|t}}, where t is replaced by the term you are using.

Placeholders

A placeholder is a made-up name for referencing something, e.g. Person A is a placeholder to reference some person in some situation. Placeholders will be bolded.

  • To mark something as a placeholder you can use the template {{Placeholder|p}}, where p is replaced by the term you are using.

Referencing Sections

Every time a section of a document is referenced, it should be referenced as § NName, where N is the number of the section and Name is the name of the section. When writing the document, list N as TBD if you do not yet know which section should be referenced, or if said section does not yet exist. Section references will become a hyperlink, and will have a section symbol (§) prepended.

  • To mark something as a section you can use the template {{Section|n|t}}, where n is the number of the section (see the table of contents to get the number), and t is the title of the section.