Introduction

This is a user supported and documented wiki. Everyone is encouraged to participate in making this collection of documents complete, clear and concise.

If you find some Wiki contents unclear / out-of-date you can post your ideas on the Documentation forum or become a Documentation Author by requesting an account via the forums.

Becoming a Documentation Author

To request a Wiki Account simply post on the account request thread here.

Author Guidelines

In order to make things easier for readers and authors there are a some 'best practices' to follow.

Wiki Structure

The documentation is divided into WikiGroups, in general, keep pages in the right group, and when adding pages, extend the names of the pages in a sensible way. The groups and site structure are described on the Site Structure page.

How to Author Wiki pages

Most authors only need to read the Basic Editing help page. Feel free to practice in sandbox.

Common Tasks

Here's some help with a number of documentation author tasks that are not so obvious how to do:

Include an image

  1. Write "Attach:filename.jpg" in the wiki page where you want it to appear.
  2. Save the page, and view the resulting wiki page.
  3. Click on the question mark, '?', that has now appeared after the filename
  4. Select image to upload

Upload a zip file
You may attach zip files in the same way as images.

Updating an upload file

  1. Click the Attach File in the Actions section of the Author Bar.
  2. Enter the name of the file you want to replace. Note: do not use spaces in file names
  3. Browse and select the file you want to upload.
  4. Click Upload. Note: the file will be given the name specified in step 2, not its name on your PC.'

Advanced Wiki Editing

Documentation regarding advanced editing of wiki pages can be found here here.

Wiki Recipes (plugins)

For those that are comfortable with editing the wiki you can take advantage of some extra markup, made available by wiki recipes (plugins). See the Available Recipes page for details.

Page last modified on October 18, 2015, at 12:25 AM