Consortium Activities Projects Forge Events

XWiki Syntax

1 XWiki Syntax

XWiki allows you to create internet pages without using HTML thanks to the Wiki Syntax. This Wiki Syntax is a simple way to modify the aspect of a document as well as create links between documents.

This document briefly explains the wiki syntax.

{pre}
<table class="wiki-table" border="1" cellspacing="0" cellpadding="2" width="80%">
<tr><th width="25%">Description:</th>
<th width="10%">Example:</th>
<th width="10%">Result:</th>
</tr>
<tr>

<td>
Titles </td>
<td>
<pre>

1 Title 1

1.1 Title 2

</pre>
</td>
<td>
<h3 class="heading-1">Title 1</h3>
<h3 class="heading-1-1">Title 2</h3>
</td>
</tr>
<tr>

<td>
Paragraphs </td>
<td>
<pre>

Here is a paragraph.
This text continues the same paragraph.

This paragraph is a new one.

This paragraph is another new one.

</pre>
</td>
<td>
Here is a paragraph.
This text continues the same paragraph.This paragraph is a new one.This paragraph is another new one.
</td>
</tr>
<tr>
<td>

Lists </td>
<td>
<pre>

* List item
* List item

* Recursive list level 1
** Recursive list level 2
*** Recursive list level 3
*** Recursive list level 3
** Recursive list level 2
** Recursive list level 2
* Recursive list level 1

1. Enumerated list
1. Enumerated list

a. Alphabetical enumerated list
a. Alphabetical enumerated list

A. Uppercase alphabetical enumerated list
A. Uppercase alphabetical enumerated list

i. Roman enumerated list
i. Roman enumerated list

I. Uppercase roman enumerated list
I. Uppercase roman enumerated list

g. Greek enumerated list
g. Greek enumerated list

h. Hirigana (jap.) enumerated list
h. Hirigana (jap.) enumerated list

k. Katakana (jap.) enumerated list
k. Katakana (jap.) enumerated list
</pre>
</td>
<td>
<ul class="star">
<li>List item</li>
<li>List item</li>
<li>Recursive list level 1</li>
<ul class="star">

<li>Recursive list level 2</li>
<ul class="star">
<li>Recursive list level 3</li>
<li>Recursive list level 3</li>
</ul>
<li>Recursive list level 2</li>
<li>Recursive list level 2</li>
</ul>
<li>Recursive list level 1</li>
</ul>
<ol>

<li>Enumerated list</li>
<li>Enumerated list</li>
</ol>
<ol class="alpha">
<li>Alphabetical enumerated list</li>
<li>Alphabetical enumerated list</li>
</ol>
<ol class="ALPHA">
<li>Uppercase alphabetical enumerated list</li>
<li>Uppercase alphabetical enumerated list</li>
</ol>

<ol class="roman">
<li>Roman enumerated list</li>
<li>Roman enumerated list</li>
</ol>
<ol class="ROMAN">
<li>Uppercase roman enumerated list</li>
<li>Uppercase roman enumerated list</li>
</ol>
<ol class="greek">
<li>Greek enumerated list</li>
<li>Greek enumerated list</li>

</ol>
<ol class="hiragana">
<li>Hirigana (jap.) enumerated list</li>
<li>Hirigana (jap.) enumerated list</li>
</ol>
<ol class="katakana">
<li>Katakana (jap.) enumerated list</li>
<li>Katakana (jap.) enumerated list</li>
</ol> 
</td>
</tr>
<tr>
<td>

Bold 
There are two ways to mark text as bold.
</td>
<td>
<pre>

Here is some text with a *bold* word.
Here is some text with a __bold__ word.

</pre>
</td>
<td>
Here is some text with a bold word.
Here is some text with a bold word.

</td>
</tr>
<tr>
<td>
Italics </td>
<td>
<pre>

~~Here is some text in italics~~

</pre>
</td>
<td>
Here is some text in italics
</td>
</tr>

<tr>
<td>
Striked Text </td>
<td>
<pre>

--Here is some striked text--

</pre>
</td>
<td>
<strike class="strike">Here is some striked text</strike>
</td>
</tr>
<tr>
<td>

Wiki Links </td>
<td>
<pre>

Wiki Links:

* [WebHome]
* [Web Home]
* [web home>WebHome]
* [Main.WebHome]
* [web home|Main.WebHome]

</pre>
</td>
<td>
Wiki Links:
<ul class="star">
<li><a href="/xwiki/bin/view/Doc/WebHome">WebHome</a></li>
<li><a href="/xwiki/bin/view/Doc/WebHome">Web Home</a></li>
<li><a href="/xwiki/bin/view/Doc/WebHome">web home</a></li>

<li><a href="/xwiki/bin/view/Main/WebHome">Main.WebHome</a></li>
<li><a href="/xwiki/bin/view/Main/WebHome">web home</a></li>
</ul></td>
</tr>
<tr>
<td>
External Links </td>
<td>
<pre>

* http://www.xwiki.org
* [http://www.xwiki.org]
* [lien xwiki.org>http://www.xwiki.org]
* {link:lien xwiki.org|http://www.xwiki.org}

</pre>
</td>
<td>

<ul class="star">
<li><a href="http://www.xwiki.org">&#104;ttp://www.xwiki.org</a></li>
<li><a href="http://www.xwiki.org">&#104;ttp://www.xwiki.org</a></li>
<li><a href="http://www.xwiki.org">&#108;ien xwiki.org</a></li>
<li><a href="http://www.xwiki.org">lien xwiki.org</a></li>
</ul></td>
</tr>
<tr>
<td>
Quotes </td>
<td>
<pre>

{quote:http://www.xwiki.org}
Here is some text with a quote
{quote}

{quote:http://www.xwiki.org}
~~Here is some text with a quote~~
{quote}

</pre>
</td>
<td>
<blockquote class="quote">
Here is some text with a quote
<a href="http://www.xwiki.org">Source</a></blockquote><blockquote class="quote">
Here is some text with a quote
<a href="http://www.xwiki.org">Source</a></blockquote>
</td>
</tr>
<tr>
<td>

Tables 
The syntax for tables allows to easily create content in table format. It even allows to make some calculation on the content !
</td>
<td>
<pre>

{table}
Title 1 | Title 2
Word 1 | Word 2
{table}

{table}
Category | Sales (K?)
Category 1 | 100
Category 2 | 50
Category 3 | 50
Total | =sum(B2:B4)
{table}

</pre>
</td>
<td>
<table class="wiki-table" cellpadding="0" cellspacing="0" border="0"><tr><th>Title 1</th><th>Title 2</th></tr><tr class="table-odd"><td>Word 1</td><td>Word 2</td></tr></table><table class="wiki-table" cellpadding="0" cellspacing="0" border="0"><tr><th>Category</th><th>Sales (K?)</th></tr><tr class="table-odd"><td>Category 1</td><td>100</td></tr><tr class="table-even"><td>Category 2</td><td>50</td></tr><tr class="table-odd"><td>Category 3</td><td>50</td></tr><tr class="table-even"><td>Total</td><td>200</td></tr></table>

</td>
</tr>
<tr>
<td>
No wiki rendering but HTML rendering 
This allows to show wiki syntax in a wiki page.
</td>
<td>
<pre>
{&#112;re}
No *bold rendering* in wiki syntax.
{/&#112;re}
</pre>
</td>
<td>
No *bold rendering* in wiki syntax.
</td>
</tr>
<tr>
<td>
No Wiki rendering and no HTML rendering 
This allows to show Wiki and HTML content in a Wiki page.
</td>
<td>
{code:xml} 
No &lt;strong&gt;bold rendering&lt;/strong&gt; in HTML.
No *bold rendering in* wiki syntax. 
{code}
</td>
<td>
<div class="code"><pre>No &#60;strong&#62;bold rendering&#60;/strong&#62; in HTML.
No &#42;bold rendering in&#42; wiki syntax.</pre></div>
</td>
</tr>
<tr>
<td>
Document Includes

Using XWiki you can include documents inside other documents. This can be usefull to create complex documents using multiple document an then convert them in PDF. This also allows to create forms to present object data.
</td>
<td>
<pre>
#\includeTopic("Doc.TestInclude")
#\includeForm("Doc.TestInclude")
</pre>
</td>
<td>
Nom du document: TestInclude
Nom du document: XWikiSyntax
</td>
</tr>
<tr>
<td>
Images 
Allows to include images that are attached to the document.
</td>
<td>
<pre>
{image:chat2.jpg|50}
{image:chat2.jpg| |50}
{image:chat2.jpg|50|50}
</pre>
</td>
<td>
<img src="/xwiki/bin/download/Doc/XWikiSyntax/chat2.jpg" height="50" alt="chat2.jpg" />
<img src="/xwiki/bin/download/Doc/XWikiSyntax/chat2.jpg" height=" " width="50" alt="chat2.jpg" />
<img src="/xwiki/bin/download/Doc/XWikiSyntax/chat2.jpg" height="50" width="50" alt="chat2.jpg" />
</td>
</tr>
</table> 
 
{/pre}