Jump to content

QESTonline:Guidelines: Difference between revisions

From QESTonline
naming
m fixed table syntax
Line 19: Line 19:
==Tables==
==Tables==
Tables should be of the '''spectratable''' class. The class can be specified at the top of the table
Tables should be of the '''spectratable''' class. The class can be specified at the top of the table
<pre>{|class="spectratable"|
<pre>{| class="spectratable" |
| Row 1, Column 1
! Header Row, Column 1
| Row 1, Column 2
! Header Row, Column 2
|-
|-
| Row 2, Column 1
| Content Row 1, Column 1
| Row 2, Column 2
| Content Row 1, Column 2
|-
| Content Row 2, Column 1
| Content Row 2, Column 2
|}</pre>
|}</pre>


More information on the syntax for tables (in case you want to merge cells or do something else a little bit fancy) can be found at [http://en.wikipedia.org/wiki/Help:Table|Help:Table] (Wikipedia).


==Naming Conventions==
==Naming Conventions==

Revision as of 01:33, 5 April 2006

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" |
! Header Row, Column 1
! Header Row, Column 2
|-
| Content Row 1, Column 1
| Content Row 1, Column 2
|-
| Content Row 2, Column 1
| Content Row 2, Column 2
|}

More information on the syntax for tables (in case you want to merge cells or do something else a little bit fancy) can be found at [1] (Wikipedia).

Naming Conventions

  • Pages should generally be named using Title case.
  • The guidelines laid out in Naming conventions (Wikipedia) are a good place to look if you are unsure.

Examples of names:

Users
Adding users
Removing users
Adding and removing users
Editing users

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 which pages link to the redirect page, and change them to link to the correct page instead.

It can be useful to add redirect pages for singular/plural variations of the same thing. e.g. it could be useful to redirect User to Users (or vice-versa).


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 administrator - even if that page just has a couple of lines, and directs the user to a different page in the wiki.
  • Include the name of the website in brackets after external links.
    E.g. See the help page (WikiMedia) for editing information.