CLWIKI Syntax rules

From ClarolineDoc

Table of contents

1 Wiki Syntax 1.1 Basic syntax 1.1.1 Creating wiki pages and links between them 1.1.2 Hyperlinks 1.1.3 Images handling 1.1.3.1 Image inclusion 1.1.3.2 Link to an image 1.1.4 Layout 1.1.5 Lists 1.1.6 Paragraph 1.2 Advanced syntax 1.2.1 Footnotes 1.2.2 Preformated text 1.2.3 Cite block 1.2.4 Horizontal line 1.2.5 Forced line break 1.2.6 Acronym 1.2.7 Inline cite 1.2.8 Code 1.2.9 Named anchor 1.3 Tables

Wiki Syntax

Basic syntax

Creating wiki pages and links between them

• Wiki words : wiki words are words written like WikiWord. Wiki2xhtml will automatically recognise them as Wiki page links. To create a wiki page or to create a link to a wiki page, edit an existing one and add the title of the page in WikiWord syntax, for example MyPage, then save the page. Wiki2xhtml will automaticaly replace the Wiki Word MyPage with a link to the Wiki page MyPage ;

• Wiki links : wiki links are like Hyperlinks (see below) expect that they do not contain any protocol scheme (like http:// or ftp://) and thatthey are automaticaly recognise as links to Wiki pages. To create a new page or create a link to an existing one using Wiki links, edit a page and add [page title] or [name of link|title of page] to its content. You can also use this syntax to change the text of a WikiWord link : [name of link|WikiWord].

Hyperlinks

   [url], [name|url], [name|url|language] or [name|url|language|title]. ;

Images handling

Image inclusion

   ((url|alternate text)), ((url|alternate text|position)) or ((url|alternate text|position|long description)).

The position argument can take the following values : L (left), R (right) or C (centeré). ;

You can also use the syntax as Hyperlinks. For example [title|image.gif]. Note that this syntax is deprecated, consider to use the preceding one;

Link to an image

Same as Hyperlinks but put a 0 in fourth argument to avoid image recognition and get an hyperlink to an image. For example [image|image.gif||0] will display a link to image.gif instead of display the imge itself

Layout

• Italic : surround your text with two single quotes ''text'';
• Bold : surround your text with three single quotes underscores '''text''' ;
• Underline : surround your text with two underscores __text__ ;
• Stroke : surround your text with two minus symbols --text-- ;
• Title : !!!, !!, ! respectively for titles, sub-titles and sub-sub-titles ;

Lists

Line starting with * (unordered list) or # (ordered list). You can mix lists (*#*) to create multi-level lists. ;

Paragraph

Separate paragraphs with one or more new lines ;

Advanced syntax

Footnotes

   $$footnote text$$ ;

Preformated text

   begin each line of preformated text with a blank space ;

Cite block

   > or ;: before each line ;

Horizontal line

   ---- ;

Forced line break

   %%% ;

Acronym

   ??acronym?? or ??acronym|definition?? ;

Inline cite

   ((cite)), ((cite|language)) or ((cite|language|url)) ;

Code

   @@your code here@@ ;

Named anchor

   ~anchor~ ;

Tables

Wiki table syntax has been added to Claroline Wiki engine in Claroline 1.8.

To create a table, use the following syntax :

   {|
   ||first cell of the first line|second cell off the first line|...||
   ||first cell of the second line|second cell off the second line|...||
   |}

Results in the following table :

first cell of the first line	second cell off the first line	...
first cell of the second line	second cell off the second line	...

Since Claroline 1.8.2, it's possible to add caption and column titles in Wiki tables :

   {|Caption for the table
   ||!title of first column|!title of second column|...||
   ||first cell of the first line|second cell off the first line|...||
   ||first cell of the second line|second cell off the second line|...||
   |}

which generates the following table :

Caption for the table

title for the first column	title for the second column	...
first cell of the first line	second cell off the first line	...
first cell of the second line	second cell off the second line	...

Exact table rendering may vary in function of the Wiki css file contents (see claroline/wiki/wiki.css).