Style Guide

From OnanWiki

Jump to: navigation, search

Contents

[edit] Discussion pages

  1. When prompted for 'subject/heading' information do not supply a value unless your comment represents a new discussion topic that is not already being addressed in the discussion.
  2. Close all comments with a sinble line containing four 'tildes' (~) followed by another line containing four 'hypens' (-) to sign your entry, and delimit it from subsequent comments by others.

[edit] GUI / menu navigation

  1. When describing Windows menu navigation, list the menu options in bold, separated by a vertical bar. (Example: Tools | Options | Set Date]
  2. Dialog button references are wrapped in square brackets and bolded. (Example: [OK] [Cancel])
  3. The style requirements of this section apply also to text referring to menus and buttons of the the Meade LX200GPS Autostar 2.

[edit] HTML tags

  1. Wherever wikitext can render content with the same appearance as raw HTML code (e.g., bold text, numbered lists, etc.) wikitext is preferred over HTML.
  2. Use of raw HTML should be limited to situations in which wikitext is inadequate to the task at hand, or in which the wikitext presents output incorrectly.

[edit] Proper names

  1. Name of computer software is italicized. (Example: TheSky6)

[edit] Section headings

  1. First-level section headings (e.g., "=Heading Text=") should be avoided to eliminate confusion with the page name heading.

[edit] Skins

  1. The default 'skin' for this wiki is 'OnanWiki' which is based on the default 'MonoBook' skin. Editors and contributors should develop and modify articles using this skin to ensure formatting and presentation consistency across the entire wiki.

[edit] Tables

  1. Except in circumstances requiring HTML table coding to achieve a desired effect, tables should be coded using the in-built wikitext conventions.
  2. All tables with borders should include table headers (using "!" tags), border value of 1 and cell padding values of 5. For example:
    {| border="1" cellpadding="5"<br>!Role

!Responsible |- |'''Wiki Administrator''' |Kibat, Mike |}

Personal tools