Wiki Formatting Guide

Once you have read through this, test your formatting skills in the SandBox.

---

1. Text Formatting

Note: Anything between 2 sets of double-quotes is not formatted.

2. Headers

Use between five = (for the biggest header) and two = (for the smallest header) on both sides of a text.

3. Horizontal separator

---

4. Forced line break

---

5. Lists / Indents

Indent text using 4 spaces (which will auto-convert into tabs) or using "~". To make bulleted / ordered lists, use the following codes (you can use 4 spaces instead of "~"):

~- bulleted list:

• bulleted list
• Line two

~1) numbered list:

1. numbered list
2. Line two

~A) Using uppercase characters:

1. Using uppercase characters
2. Line two

~a) Using lowercase characters:

1. Using lowercase characters
2. Line two

~I) using uppercase roman numerals:

1. using Latin numbers
2. Line two

~i) using lowercase roman numerals:

1. using Latin numbers
2. Line two

---

6. Inline comments

~& Comment
~~& Subcomment
~~~& Subsubcomment

• Comment
  • Subcomment
    • Subsubcomment

#!Quoted text block
hooray.#!

Quoted text block hooray.

---

7. Images

To place images on a Wiki page, use:
{{image class="center" alt="DVD logo" title="An Image Link" url="images/dvdvideo.gif" link="RecentChanges"}}

Links can be external, or internal Wiki links. You don't have to enter a link at all, and in that case just an image will be inserted. You can also use the classes 'left' and 'right' to float images left and right. You don't need to use all those attributes, only url is essential.

---

8. Links

To link to other wiki pages, write

• a WikiName
• or a forced link with [[ and ]] around it (everything after the first space will be shown as description)
  • Example: [[JennaPage Jenna's Home Page]] Jenna's Home Page
• or an image with a link

To link to external pages, write

• a http address inside the page
• or a forced link with [[ and ]] around it (everything after the first space will be shown as description)
  • Example: [[http://example.com/jenna/ Jenna's Home Page]]
• or an image with a link
• or an InterWiki link (see InterWiki page for wiki list)
  • Examples:
    • Google:CSS∞
    • Thesaurus:Happy∞

---

9. Tables

To create a table use this code:
{{table columns="3" cellpadding="1" cells="BIG;GREEN;FROGS;yes;yes;no;no;no;###"}} to give:

BIG	GREEN	FROGS
yes	yes	no
no	no

### means the cell is empty.

---

10. Colored Text

{{color c="blue" text="This is a test."}} gives:

This is a test.

If you want to use hex values:

{{color hex="#DD0000" text="This is another test."}} to give:

This is another test.

---

11. Floats

Left floated box - use two < signs before and after the block

---

12. Code formatters

Simply use %%(formatter) code %% - see below for a list of available formatters.

Example:
%%(php) PHP code%%:

LANGUAGE	FORMATTER
Actionscript	actionscript
ADA	ada
Apache Log	apache
ASM	asm
ASP	asp
Bash	bash
C	c
C for Macs	c_mac
c#	csharp
C++	cpp
CAD DCL	caddcl
CadLisp	cadlisp
CSS	css
Delphi	delphi
HTML	html4strict
Java	java
Javascript	javascript
Lisp	lisp
Lua	lua
NSIS	nsis
Objective C	objc
OpenOffice BASIC	oobas
Pascal	pascal
Perl	perl
PHP	php
Python	phyton
Q(uick)BASIC	qbasic
Smarty	smarty
SQL	sql
VB.NET	vbnet
Visual BASIC	vb
Visual Fox Pro	visualfoxpro
XML	xml

---

13. FreeMind maps

There are two options for including maps:

Option 1: Upload a FreeMind∞ file to a webserver, and then place a link to it on a wiki page:

Option 2: Paste the FreeMind data directly into a wiki page:

• Open a FreeMind file with a text editor.
• Select all, and copy the data.
• Browse to your Wiki site and paste the Freemind data into a page.

---

14. Embedded HTML

Use two doublequotes around the html tags.

""
[html code]
""

By default, some HTML tags are removed by the parser to protect against potentially dangerous code.

---

15. Table Of Contents

I have added support for automatic table of contents generation based on headers. You include a header in the table of contents by appending a link target to it in parenthesis, like:
====(test) Test Header====

The table will be produced hierarchially based on the size of the header, but the largest must occurr first.

you specify where you want the table of contents using:
{{toc}}

The toc action takes two optional parameters:
title="str" - sets the title displayed on the table of contents to str.
format="f f f f" - sets the formatting for each level of the table of contents (where f is a format string, below), different levels seperated by spaces.

values for format strings:

Complete example:
{{toc title="The Table" format="roman num bullet"}}

---

CategoryWiki