Help:OgreWiki Handbook
From Ogre Wiki
The OGRE community is growing rapidly. With the tremendous influx of new talent, new tutorials and new-bies, the need for a well designed, high quality repository of information has increased dramatically. The purpose of the handbook is to offer both help on Wiki editing, but more importantly a set of guidelines on structure and writing to facilitate readers and writers getting the most out of community documentation.
Also, take part in the Talk pages attached to each article and in the Community Portal. These will help us communicate to create a better organized and useful Wiki.
- Guidelines
- Design Principles - Organization of the Ogre Wiki explained. Read this before posting anything.
- Article Writing Guidelines - Read this before writing an article.
- Formatting Guidelines - How to format your page to match the uniform look.
- Naming Guidelines - Naming conventions for easier reading.
- Wiki Howto
- Editing Help - A quick reference guide on Wiki markup.
- Using Template Messages
- All about Categories
If possible, please use wiki code instead of HTML tags.
Wiki code is better for overview, especially for tables.
Also there were difficult detectable bugs in the past because of using HTML tags. They confused the MediaWiki interpreter and the page style was heavy demolished.
- Wiki Digest - The Ogre Wiki Digest is meant to be a "base" to all the articles found on the Wiki
- OgreWiki Handbook - Read these guidelines before creating new articles
- Editing - Learn how to edit the wiki
- Wikimedia Help - Further information on wiki markup
- Advanced editing
- Colors and big color table
- Wikitext examples
- Reference card
- HTML in wikitext
- Lists
- Image syntax (extended) | Images and other uploaded files | easily add galleries
- Tables | Sorting tables
- Magic words
- Mathematical symbols
- Templates | Advanced templates | Infoboxes | optional parameters (needs wiki software update)
- Rename/Move a page | Redirecting a page | Deleting a page
- Sandbox - A wiki page to play around in. There you can make any changes you like.
- Source code:
| first way: | set <pre> ... </pre> tags to begin/end of source (recommended) |
| second way: | start every line with space (also empty lines needs a space) |
- Syntax highlighting:
-
In this wiki this option not available until today.
- But there is a program for preformating sources. Maybe it helps. qbnz.com/highlighter
- Special characters:
- Ä ä Ö ö ß Ü ü | „“ ’ ‚‘ “” «» ‹› »« ›‹ – | + − · × ÷ ≈ ≠ ± ≤ ≥ ² ³ ½ † # * ‰ § € ¢ £ ¥ $ ¿ ¡ ∞ ‣ • 〈〉 … ← → ↔ |
- How to use pipe '|' symbols in templates (e.g. boxes):
- write {{!}} to display it
- Example: this | are pipes | by | mini templates
- or use {{!!}} to add an additional space symbol before and after it (useful for horizontal lists)
- Exampe: this | pipes have | extra | spaces
- How to add comments to templates
... template content ... <noinclude> ---- ... description ... </noinclude>
