Help:Contents

From Okapi Framework
Jump to: navigation, search

User Registration

We do welcome anyone who wish to contribute to the wiki.
However, because of the high level of spam the wiki gets when it's not protected, the edit and creation of pages is limited to registered users and the self-registration is disabled.

To request a user account please send an email to wiki administrator with a username and a valid email address and you will receive an initial password soon after.

Wiki Help at MediaWiki

Writing Guidelines

Here are a few examples of how to markup the content:

Usage Example Result
Use <cite> for user interface text. Never click the <cite>Exit</cite> button Never click the Exit button
Use <code> for source code, paths, and filenames. The <code>TextUnit</code> class The TextUnit class
Use <span class="hi"> for highlighted text. This is <span class="hi">the thing</span> This is the thing
Use <span class="green"> for green highlighted text. This is <span class="green">the thing</span> This is the thing
Use <span class="blue"> for blue highlighted text. This is <span class="blue">the thing</span> This is the thing
Use <tt> for key names. The shortcut is <tt>Ctrl+O</tt> The shortcut is Ctrl+O
Use '' or <i> for resource property names. The ''approved'' target property The approved target property
Use ''' or <b> to denote emphasis. Be careful not to emphasize too many things. This is '''important''' This is important

A few additional hints:

  • Spelling — In English, use US English spelling only. Please, spell-check your contributions. Some browsers have integrated spell-checking that will work with the wiki editor. If that is not the case, you can use third-party tools that allow you to spell-check the content of forms. For example, the Google Toolbar offers such spell-checker.
  • Terminology — Some terms are defined in the Glossary section, please use them.
  • Slashes in path — Use slashes ('/') rather than backslashes ('\') in all real links. You can use slashes or backslashes as the platform requires in the links that are only displayed.

Special Pages for Administration