Editing Documents

From Documentation

Current revision

Please Visit the Sandbox if you'd like to test anything in this section

Style Guide

We are currently in the process of making a Style Guide for our online Documentation. As things are confirmed, they will be added to this Guide.

Text Editing

I do not have any desire to re-invent the wheel, and a Quick guide to Wiki Text Formatting is available at:

http://tmbw.net/wiki/index.php/Basic_Wiki_Formatting

The only addendum I would add, is that the preferred method of marking up text is <strong> and <em> rather than <b> and <i>

Indentation

There are two easy ways of text indentation. For presentation of code, you can simply put a space at the front of the line(s) of text. This will produce the text within a box.

Like this.

Alternatively, you can place a ":" at the start of the line, which will result in text indentation, with no decoration.

Thusly

Hiding the Table of Contents

By default, once a wiki entry reaches a certain number of elements, a table of content is displayed at the top of the screen. Often, as with this page, that is deemed unnecessary, and can be removed simply by placing

__NOTOC

Anywhere in the article source.

Linking Within the Wiki

To create a link to another document within the Wiki structure, simply put double square brackets around the text you would like to become a link.

For instance:

[[Edit Me]] 

becomes

Edit Me 

in the real world. If the page you are linking to does not exist yet, don't worry, because following that link will allow you to edit it, at which point the page will cease to not exist.

If you would like a different name for your link you can do that by using the "|":

[[Edit Me|Please Edit Me]]

becomes

Please Edit Me

Note:

If you are the first person to edit a page, please ensure you add a summary to the page.

The input is at the bottom of the edit box.

Failing to do this might result in an error being generated by the Wiki software

Linking the outside world

It is similarly easy to create a link to an outside website. Simply put a single square bracket around the address and the description. So

[http://www.fs.com.au Functional Website]

becomes

Functional Website

or, without the description

http://www.fs.com.au

becomes

http://www.fs.com.au

Redirecting

If you ever need to change a page so that it redirects to another page, edit the page you want to redirect from, and use this command:

#REDIRECT [[targetpagename]]

Note - The command must start at the first character of the first line of the page. REDIRECT must be in FULL CAPS. If the target page has spaces in its name, replace the spaces with underscores ( _ )