Help Page

How to format your Wiki pages

Wiki pages may be formatted using codes given below. These codes provide simple text styles such as bold, italic and lists.

There are also a number of 'macros' which can automatically provide certain information, as well as being used for more complex tasks, such as including tables, images and attachments.

Formatting short-cut icons

You can insert common formatting commands using the links in the toolbar at the top of the wiki page editor. These links include bold, italic, headings, tables, uploading attachments and including images.

Simple text formatting

Type these codesDisplays asDescriptions
__bold__boldsimple bold text
~~italics~~italicssimple italic text
--strike--strikestrike through text
CH%%4%%CH4subscript (for more mathematical formatting, see below)
[my new page]my new pagelinks to a new Wiki page with the name given in brackets link: an automatic link to an external website or an online document.
h1 Title a major headline (displayed as <H1> would be in the local CSS styling)
h3 Title a minor headline (displayed as <H3> would be in the local CSS styling)
{bgcolor:yellow}Some text{bgcolor}Highlighted textHighlights the text between the brackets (note US spelling!)
{color:red}Some text{color}Red text Changes the colour of the text between the brackets (note US spelling!)
---- display a horizontal line across the page
- list item create a bulleted list
* list item create a bulleted list which displays slightly differently to the one above
# list item create an automatically numbered list
a. list item create an automatically alphabetical list
A. list item uppercase alphabetical list
i. list item lowercase Roman numerical list
I. list item uppercase Roman numerical list
g., h., k., j. list item Greek, Hiragana, Katakana & Hebrew numerical lists
(empty line) divides text into paragraphs
\ creates extra space between paragraphs
\XXdisplay the special character "X" (for example, \{ will display {)
\\\\ display a \

Macros and More

For a full list of macros and parameters, type {list-of-macros} in any page. This list gives an introduction to the most useful.

Add an email link

{mailto:} followed by an email address will create an email link in the page.

e.g. {} will display as

Create an automatic index for your Wiki

Typing {index} will create an automatically updated index of pages for your Wiki.

(No example as it takes up a lot of space!)

Create an automatic list of recently changed pages

Typing {recent-changes} will create an automatically updated list of the recently changed pages in your Wiki, together with the name of the person who last changed the page and the date and time of the change. By default, it shows all the pages changed in the last 30 days.

  • {recent-changes:12h} - recently changed pages in the last 12 hours.
  • {recent-changes:7d} - recently changed pages in the last 7 days.
  • {recent-changes:2006-12-25} - recently changed pages since 25 Dec, 2006.

(No example as it takes up a lot of space!)

Add an image to your page

Typing {image:} and including the URL of the image will display a image in your page. (This is just the same as clicking the image icon in the edit screen, which is easier to use.)

{image:/images/bear.jpg|A Bear} would show the image whose relative URL was "/images/bear.jpg". The alternative text shown would be "A Bear".

To float your image left, so that text flows round it, include the extra text "|ext|float-left", as below:

{image:/images/bear.jpg|A Bear|ext|float-left}

To float your image right, so that text flows round it, include the extra text "|ext|float-right", as below:

{image:/images/bear.jpg|A Bear|ext|float-right}

The image URL may be relative or absolute but cannot be external. The URL may also start with "worksite:/" to display images from this worksite. To display images from your other worksites, you may start a URL with "sakai:/" and include the site ID.

Create an anchor tag

Typing {anchor} creates an HTML anchor tag around the text it contains.

e.g. {anchor:myLink}Jump to this point {anchor}

The link to jump to that point should appear as follows:

[Go to this exciting point|Name of current page here#myLink]

Using mathematical formatting

RWiki uses JS Math so that you can display maths entered in TeX form.

Typing {math:display} {math} will display TeX between the two tags.

e.g. {math:display}U_n+2} U_n+1} U_n {math}

U_n+2} U_n+1} U_n

Find out more here

Display a quotation

To display a quotation, type {quote} on either side of the text you want to display as a quote.

Like this!

Sakai related macros

{sakai-sections} Generate a list of links that point to subsites that are automatically generated for each section in your worksite. Note that there is no interface within the wiki to manage permissions on a section by section level.

{worksiteinfo} Lists the information about the current site