Standards and Practices

From here on out I plan to keep the wiki in a rather pretty state, and expect all contributors to help keep that statement true. All documents posted herein are held to the same standards mentioned below and all exceptions will of course be noted.

To begin with, no one is to play with the coloring, save table coloring to keep things pretty. Text color and formatting is to be left to default so the wiki CSS can modify it as needed for the user. Please also remember to proof read your entries. Wiki entries should be only as verbose as is necessary to convey the message. If you find yourself rambling or ranting I suggest you consider posting your entry on a forum or blog first and if people find its message to be meaningful or suggest it go to the wiki, bravo.

=Formatting= I could probably go on for a week and a half about formatting and focus entirely on text. That said, i would rather only highlight things that are typically allowed a lot of creative freedom and hope that the world comes together and doesn't try to rebel against me. As with most everything that I do, the acronym KISS is quite appropriate.

Text
As stated before it is highly suggested that you proofread your entries before you choose to move them into the wiki. Formatting text is to follow typical wiki standards. Bold is to emphasize a word that is to be remembered or is key, and italics for quotes or further emphasis. Underlines are to be used sparingly if at all.

Coloring text is strictly prohibited.

Italic Text

Bold Text

Italic Text

Bold Text

Definitions
Eventually i want to create a page with all definitions for the whole wiki, but for now follow wiki syntax to keep things simple.

;Entry:This is the Definition


 * Entry:This is the Definition

Tables
Tables are to be kept simple. Dont embed tables in tables or anything along those lines unless you absolutely need to. Doing so for formatting reasons tends to make things appear artificial and forced. Let the wiki focus on formatting and the writer focus on content. Borders are entirely optional.

Sections and Sub-Sections
In an effort to keep the documents from getting too elaborate, try to keep the number of sections below 3 levels deep. A section is used here to organize information. First entries are broad overviews and all subsequent sections are used to drill down into the details of the subject previously mentioned.

=First Section=

First Sub Sub Section
=Second Section=

Lists
Lists are methods of grouping data together in an orderly fashion. Try to keep these lists no more than two levels deep.

* First Item
 * First Sub Item
 * Second Sub Item
 * Second Item
 * First Sub Item
 * Second Sub Item


 * First Item
 * First Sub Item
 * Second Sub Item
 * Second Item
 * First Sub Item
 * Second Sub Item

Code
Code blocks should be dropped into pre tags for most efficient output. Single line entries are acceptable to be displayed in wiki syntax by using a space before the text begins. A commented line stating the language or other important information about the code being displayed, preferably on the first line, is very nice to see but not required. Context is key.

Single line space definition
c:/Code/Somewhere/Ogre/defines.cpp
 * 1) define MAX_KNOT_NAME_LENGTH 128

c:/Code/Somewhere/Ogre/defines.cpp
 * 1) define MAX_KNOT_NAME_LENGTH 128

Multiple line pre tagged entry
c:/Code/Somewhere/Ogre/Robots.cpp &lt;pre&gt; //- Robot::~Robot(void) {	while(!mDestinations.empty) mDestinations.pop_front; } &lt;pre&gt;

c:/Code/Somewhere/Ogre/Robots.cpp //- Robot::~Robot(void) {	while(!mDestinations.empty) mDestinations.pop_front; }

=Templates= There are bound to be more templates added, but for a quick view of what is available and how to use them please consult the Templates Demo Page.

Each of the templates below accepts a parameter called width to control the width of the box, if your entry needs such things. The parameters will evolve over time, although backwards compatibility is a concern. Currently each defaults to a width of 450px;

Citations and Quotes
"What would I do if I had only six months left to live? I'd type faster."

- Isaac Asimov "What would I do if I had only six months left to live? I'd type faster."

- Isaac Asimov

Downloads
=Suggestions= If you have any suggestions or questions about these standards and practices please feel free to email me. I am quite quick to reply.