Detailed Wiki Help

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.

(The Wiki language used is based on external link: Radeox).

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.

The wiki toolbar:

Wiki toolbar

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)
Ca^^2+^^Ca2+superscript
[my new page]my new pagelinks to a new Wiki page with the name given in brackets
[Nice page name|horrid page name]Nice page namelinks to wiki page with custom name
http://www.bbc.co.uk/external link: http://www.bbc.co.uk/creates 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)
h2 Title a minor headline (displayed as <h2> would be in the local CSS styling)
 
h6 Title a minor headline (displayed as <h6> 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
\\
 new line
\ creates extra space between paragraphs
\XXdisplay the special character "X", for example, \{ will display {
\\\\display a \

Tables

Tables can be used on wiki pages

{table}
heading | heading | heading
cell | cell | cell
cell | cell | cell
{table}

will render as

headingheadingheading
cellcellcell
cellcellcell

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 a link to an external site

You can just type in the URL of a web page to create a link but it is good practice to display descriptive test rather than the raw web address. You may use the {link:} macro to achieve this, for example,

{link:BBC website|external link: http://www.bbc.co.uk}

will display as external link: BBC website

Add an email link

followed by an email address will create an email link in the page, for example,

{mailto:weblearn@oucs.ox.ac.uk}

will display as weblearn@oucs.ox.ac.uk

Create an automatic index for your Wiki

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

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.

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.) For example,

{image:/access/content/group/info/hidden/visible/images/wiki-toolbar.jpg|Wiki toolbar}

would show the image whose relative URL was "/access/content/group/info/hidden/visible/images/wiki-toolbar.jpg". The alternative text shown would be "Wiki toolbar". Viz:

Wiki toolbar

NB The image must be stored in WebLearn in the Resources tool; do not include the 'http://weblearn.ox.ac.uk' part of the URL.

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

{image:/access/content/group/info/hidden/visible/images/wiki-toolbar.jpg|Wiki toolbar|ext|float-left}

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

{image:/access/content/group/info/hidden/visible/images/wiki-toolbar.jpg|Wiki toolbar|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 the current site. For example,

{image:worksite:/hidden/visible/images/wiki-toolbar.jpg|Wiki toolbar}

Note how the URL is much shorter, /access/content/group/info has been removed and replaced with worksite:.

Create an anchor tag

Typing {anchor} creates an HTML anchor tag around the text it contains, for example,

{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 (LaTeX) formatting

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

Typing {math:display} {math} will display LaTeX between the two tags, for example,

{math:display}
U_n+2 U_n+1 U_n
{math}

will display as

U_n+2 U_n+1 U_n

Find out more on the jsMath web site

Display a quotation

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

Like this!

Adding CSS styles

It is possible to allow external link: CSS styling to be applied to the document, for example, define a style,

{style}
.indent { padding-left:3em; }
{style}

then use the style to apply a left margin to all enclosed text. So

{block:indent}like this{block}

will render

like this

The {span} macro can also be used, for example, define a style,

{style}
.underline { text-decoration:underline; }
{style}

then use the style to underline the specified text. So

It is possible to {span:underline}underline{span} some words.

which will render as

It is possible to underline some words.

Summary of all macros

Available Macros

MacroDescriptionParameters
anchorCreates an anchor around a section of rwiki rendered content.1: A name to assign to this anchor.
apiGenerates links to Java or Ruby API documentation.1: class name, e.g. java.lang.Object or java.lang.Object@Java131
2: mode, e.g. Java12, Ruby, defaults to Java (optional)
api-docsDisplays a list of known online API documentations and mappings.none
asinGenerates links to DVD/CD dealers or comparison services. Configuration is read from conf/asinservices.txt1: asin number
bgcolorChange the background colour of some text0,colour: Change the background colour of the contents
blockPlaces a div around a block of rwiki rendered content.1,class: The class to assign to this block,
style: the css style to apply inline
id: An id to assign to this block.
anchor: An anchor to assign to this block
codeDisplays a chunk of code with syntax highlighting, for example Java, XML and SQL. The none type will do nothing and is useful for unknown code types.1: syntax highlighter to use, defaults to java (optional)
colorChange the colour of some text0,colour: Change the foreground colour of the contents
1,bgcolour: Change the background colour of the contents
commentThis is a macro that creates inline comment with calloutnone
file-pathDisplays a file system path. The file path should use slashes. Defaults to windows.1: file path
helloSay hello example macro.1: name to print
imagePlaces an Image in the page1,img: URL to the image, image URL must be relative or absolute but cannot be external, It may also start with worksite:/ or sakai:/ if referencing resources in the worksite or the whole of sakai. When referencing resources in other worksites (e.g. sakai:/) you must include the site id
2,alt: (optional) Alt text
3,ext: (optional) ignored at the moment
4,class: (optional) css class applied to the image
5,target: (optional) Target window
6,title: (optional) Title the image, (will default to the same value as alt)
Remember if using positional parameters, you must include dummies for the optional parameters
index 1:space, The space which to index, defaults to the space of the current page.
2:nohead, if nohead, the header line will not be produced
inter-wikiDisplays a list of known InterWiki mappings.none
isbnGenerates links to book dealers or comparison services. Configuration is read from conf/bookservices.txt.1: isbn number
linkGenerated a link1,text: Text of the link
2,url: URL of the link, if this is external and no target is specified, a new window will open
3,img: (optional) if 'none' then no small URL image will be used
4,target: (optional) Target window, if 'none' is specified, the url will use the current window
Remember if using positional parameters, you must include dummies for the optional parameters
list-of-macrosDisplays a list of available macros.unexplained, lazy programmer, probably funzel
mailtoDisplays an email address.1: mail address
mathThis is a basic macro that places span/div tags with an appropriate class around the maths text.
The contents of this macro are pre-escaped, however, you cannot put {maths} in the contents of this macro, place {{}maths} instead.1: put "display" here for the maths to be placed in a div
preRenders the contents as-isunexplained, lazy programmer, probably funzel
quoteDisplay quotations.1: source (optional)
2: displayed description, default is Source (optional)
recent-changesExpands to a list of recently changed pages1: Optional, If format is yyyy-MM-dd Changes since date. If format is 30d number of days, If format is 12h, number of hours, defaults to last 30 days,
rfcGenerates links to RFCs.unexplained, lazy programmer, probably funzel
sakai-sectionsGenerate a list of links that point to section subsites1,useids: (optional) if true will generate with ID's otherwise will use names, names it the default
Remember if using positional parameters, you must include dummies for the optional parameters
spanPlaces a span around a section of rwiki rendered content.1,class: The class to assign to this block.
id: An id to assign to this block.
anchor: An anchor to assign to this block
styleAdds a style element, if no href is used, the internal content, otherwise a link to a style sheet is used.1,href: (optional) Link to a stylesheet
2,media: (optional) media type defaults to all.
tableDisplays a table.none
worksiteinfoGenerates worksite information1,info: The type of info to provide, worksiteinfo:title gives Title (default), worksiteinfo:description, worksiteinfo:shortdescription, worksiteinfo:wikispace
Remember if using positional parameters, you must include dummies for the optional parameters
xrefGenerates links to Java Xref source code.1: class name, e.g. java.lang.Object or java.lang.Object@Nanning
2: line number (optional)

Usage:

{macroname(:attribute=value|unamedvalue|other=values… optional but note the colon)} contents {macroname}

Auto-save

The wiki has an auto-save facility but for this to operate external link: Adobe Flash must be installed. Once Flash is present, if a browser window closes unexpectedly then unsaved text can be saved by returning to the page and visiting the Recovered Content tab within the Wiki tool. You may see a message as the Flash Autosave is loaded. All unsaved text should now be visible.