QESTonline:Guidelines

Page Header and Footer

Where the page is a part of a guide, or a set of pages, "Navigation" links should be provided at the top and bottom of the page. These should be labelled "Prev" and "Next". There should also be a link back to the main page that it is accessed from (usually the user guide main page - add an anchor where possible using a #). These links should be separated by a pair of pipes '||'

[[QestOnline:Guidelines Prev|Prev]] || 
[[QestOnline:Guidelines Next|Next]] || 
[[Main Page#Editing|Main Page]]
----

In the footer, you should also specify the categories that the page is in, using the following syntax.

----
[[QestOnline:Guidelines Prev|Prev]] || 
[[QestOnline:Guidelines Next|Next]] || 
[[Main Page#Editing|Main Page]]

[[Category:Help|{{PAGENAME}}]]

Tables

Tables should be of the spectratable class. The class can be specified at the top of the table

{|class="spectratable"|
| Row 1, Column 1
| Row 1, Column 2
|-
| Row 2, Column 1
| Row 2, Column 2
|}

Naming Conventions

It is extremely hard to give hard & fast rules for naming of pages, but consistency is the most important thing. Whenever adding a page, see if there is a similar page already in the wiki, and try to use something similar.

Use plurals when describing a type of object.

Examples of names:

Users
Adding Users
Removing Users
Adding and Removing Users
Editing Users

LM: should the names use upper case only for the first letter? I believe that may be better as far as the wiki goes..?

When adding a page, avoid replication. If you later find that there are two pages that are about the same thing, see if it makes sense to turn one of them into a redirect page. Syntax for a redirect page is is:

#redirect [[Redirect Target]]

You don't need any extra information on the redirect page. You can also use the what links here tool to find and adjust links to the redirect page.

Tags

Use bold and italics to highlight important words, however, use them sparingly. They tend to make the text harder to read if used excessively.

'''bold'''
''italics''

Images

Images should use the frame option. Smaller images can be placed to the side of text, however, large images should have the center tag to prevent text being placed in a very small column to the side of the image.

Image Names should be prefixed by the page on which the image appears.

[[Image:Guidelines Example.png|frame|center]]
[[Image:Guidelines Example.png|frame]]

Other stuff

• When referring to a specific object, add a link. e.g. system administraror - even if that page just has a couple of lines, and directs the user to a different page in the wiki.