ContactsLaw Documentation:Style Guide: Difference between revisions

From ContactsLaw Documentation
Line 30: Line 30:


== Formatting ==
== Formatting ==
* Use '''bold''' formatting to introduce the main topic of the article (and other key terms)
* Use ''italic'' formatting for notes and remarks
* Use <code>monospace</code> formatting for code, expressions and other syntax
* Less is more, don't over-decorate
* NEVER USE ALL CAPS


== Special Features ==
== Special Features ==

Revision as of 09:37, 24 April 2024

Contributions to this wiki should follow this style guide.

How To Use This Wiki

This wiki is implemented using MediaWiki, which is the same software that powers Wikipedia.

For general help with MediaWiki, refer to MediaWiki Help.

Key topics include:

Naming Conventions

Article Names

  • Use the singular form (e.g. Contact, not Contacts)
  • Capitalise Each Word
  • Choose the shortest possible name (that isn't ambiguous)
  • Prefix with a category name to resolve ambiguity (e.g. Document:Template)

Headings

  • Capitalise Each Word
  • Be consistent with other articles
  • External Links should always be last (if included)

Formatting

  • Use bold formatting to introduce the main topic of the article (and other key terms)
  • Use italic formatting for notes and remarks
  • Use monospace formatting for code, expressions and other syntax
  • Less is more, don't over-decorate
  • NEVER USE ALL CAPS

Special Features

External Links