Best Practice

From Airangel Wiki
Jump to: navigation, search

A few quick notes around how to keep everything on the wiki in a similar format.

Headings

Try to use h2 tags sparingly, too many can make a page seem cluttered. H2 tags should be used when there are two very different topics or elements being discussed. Use H3 tags when starting a new section and H4 for subsections.

Hyperlinks

When referencing a topic that has a page within the Wiki, or an external reference, try your best to embed the link.

Images

Where relevant, you should put images into a page. These can be uploaded here and embed using these formatting codes:

[[File:File.jpg]] To use the full version of the file

[[File:File.png|200px|thumb|left|alt text]] to use a 200 pixel wide rendition in the left margin with “alt text” as a description

[[Media:File.ogg]] for directly linking to the file without displaying the file

Informative Text

When describing a step by step process that includes lots of button presses, be sure to highlight the steps in CAPTIAL AND BOLD LETTERS. When there are several steps, try to include arrows > to > guide the user.