Skip to main content

History: Wiki Guidelines

Preview of version: 23

This is a list of Ogre Wiki Editing Rules.
Not that you are bound to follow these rules, but it would be good if we all use the same Ogre wiki editing conventions and practices. ๐Ÿ˜Š

No HTML allowed

Wiki markup is good, use it. ๐Ÿ˜Š
If you need a particular style, and can't find it on the Wiki Styles page, make a request, and a CSS editor will add it to the 'common' stylesheet.
You can apply a css class to almost any tag. (class="myClass").

Using styles (CSS) with wiki markup, over hand-written HTML, has several advantages.
The most obvious advantage is 'reuse' - once a style has been added to the common stylesheet, it can be used again, and again.

Attention When adding a style, be sure to add an example of to the Wiki Styles page - not everyone has the rights to view/edit CSS. ๐Ÿ˜‰

All pages must be in a structure

Adding a page is as easy as using 'Add Page' in the structure header.
The page will be created just after the page you're on, so do it from the right page.
If you want a page to be a child of the page you're on, check 'Child' before adding it.

The benefit of having all pages in structures is that it's impossible for a page to become lost.

Each page should have a description

When creating a new page, be sure to give it a description.
You do that in the Properties tab.

Giving a page a description serves many purposes:
It will show up before the page name header, and it will be used in toc's on other pages (as link descriptions).
And it removes the need to write a description in the wiki page itself.

We have seen pages in this wiki with three (even four) different descriptions:
One in the page, another in another page linking to it, and so on.
Page descriptions saves time, and ensures consistency. ๐Ÿ˜Š

Create pages with human readable names

Because the name of a page is used as the first header (h1) of a page, use names like 'Wiki Guidelines' instead of 'WikiGuidelines'.

Create pages with short names

Use the description field for page description. Think of the page name as the keywords in a Google search.
To find this page, you'd enter 'Wiki Guidelines' into the search box, wouldn't you?

Make use of minor edits

When making really small modifications to a wiki page, consider saving as a minor edit, as this does not notify subscribers (unnecessarily).

Use edit comments

When making a change to a wiki page, unless it's a minor change or part of the porting effort, put some words in the Edit Comments textfield (just below the editing textarea).

Use alias with page rename

If you are renaming a page, be sure to give the new page an alias of the old page's name.

So, if you're renaming 'OgreModels' to 'Ogre Models', you give the new 'Ogre Models' page an alias of 'OgreModels'.
This means that any incoming links to OgreModels will go to Ogre Models.

And it's written like this:

Copy to clipboard
--- Alias: (alias(OgreModels))

Placed at the very bottom of the page.

Page aliases are also good when a page could have several possible names.
Good for finding a page.


Alias: Ogre Wiki:Formatting Guidelines

History

Information Version
Sat 05 of Jun, 2010 11:26 GMT-0000 jacmoe 37
Sat 05 of Jun, 2010 10:58 GMT-0000 jacmoe 36
Fri 04 of Jun, 2010 00:54 GMT-0000 jacmoe 35
Fri 04 of Jun, 2010 00:53 GMT-0000 jacmoe 34
Fri 04 of Jun, 2010 00:33 GMT-0000 jacmoe 33
Thu 03 of Jun, 2010 23:35 GMT-0000 jacmoe 32
Thu 03 of Jun, 2010 03:09 GMT-0000 jacmoe 31
Tue 01 of Jun, 2010 06:02 GMT-0000 jacmoe 30
Tue 01 of Jun, 2010 06:01 GMT-0000 jacmoe 29
Tue 01 of Jun, 2010 05:43 GMT-0000 jacmoe 28
Wed 23 of Dec, 2009 22:12 GMT-0000 jacmoe 27
Wed 23 of Dec, 2009 22:11 GMT-0000 jacmoe 26
Tue 22 of Dec, 2009 16:14 GMT-0000 jacmoe 25
Tue 22 of Dec, 2009 16:13 GMT-0000 jacmoe 24
Tue 22 of Dec, 2009 16:12 GMT-0000 jacmoe 23
Tue 22 of Dec, 2009 16:11 GMT-0000 jacmoe 22
Sun 20 of Dec, 2009 13:51 GMT-0000 jacmoe 21
Sun 20 of Dec, 2009 13:45 GMT-0000 jacmoe 20
Sun 20 of Dec, 2009 13:43 GMT-0000 jacmoe 19
Sun 20 of Dec, 2009 13:42 GMT-0000 jacmoe 18
Wed 16 of Dec, 2009 22:07 GMT-0000 jacmoe 17
Wed 16 of Dec, 2009 22:06 GMT-0000 jacmoe 16
Wed 16 of Dec, 2009 22:01 GMT-0000 jacmoe 15
Wed 16 of Dec, 2009 22:00 GMT-0000 jacmoe 14
Wed 16 of Dec, 2009 22:00 GMT-0000 jacmoe 13