XWikiSyntax (XWiki.org)

Starting with XWiki Enterprise version 1.7 and above we've introduced a new wiki syntax. So we're now naming the current syntax the ~~XWiki Syntax v1.0~~ and the new syntax is logically called the ~~XWiki Syntax v2.0~~. The main reasons for introducing the new syntax were:

20

* Fix the limitations and ambiguities of the XWiki 1.0 syntax (which was inspired by both Radeox - the underlying rendering engine - and TWiki).

21

** Not optimal symbols. For example the symbol for bold was single stars. This was causing trouble when users were entering text containing stars since that text was mistakenly considered to be bold when it wasn't. Hence we've rationalized the syntax by using at least double characters everywhere.

22

** Ambiguities. For example there was an ambiguity between a bold item starting a line and a bulletted list. Resolving the ambiguities was required in order to rewrite the WYSIWYG editor so that it could be deterministic.

23

* Be closer to the [Creole 1.0 syntax>http://www.wikicreole.org/] which is becoming a standard for wiki syntax. In addition the Creole community has taken the time to analyze all the existing wiki syntaxes before deciding on symbols. The choices made are thus very good.

24

25

In addition to these 2 XWiki syntaxes we've also changed our underlying rendering engine (was Radeox previously) in favor of our own engine which is superset wrapper around [Wikimodel>http://code.google.com/p/wikimodel/] and [Doxia>http://maven.apache.org/doxia/] (and possibly others in the future). This has allowed us to provide other syntaxes in the wiki: [MediaWiki, Confluence, JSPWiki, Creole, TWiki and more>#HOthersyntaxes]

1.1 General Remarks

XWiki Syntax v2.0 corrects some errors entered by the user as shown in the examples in the table below.

<tr>

<th>Example of invalid syntax</th>

34

<th>Fixed XWiki Syntax 2.0</th>

</tr>

<tr>

{pre}

<td>

**bold

</td>

<td>

**bold**

</td>

{/pre}

</tr>

<tr>

{pre}

<td>

|| table cell<br/>

* list item

</td>

<td>

|| table cell<br/>

<br/>

* list item

</td>

{/pre}

</tr>

<tr>

{pre}

<td>

paragraph<br/>

----<br/>

paragraph

</td>

<td>

paragraph<br/>

<br/>

----<br/>

<br/>

paragraph

</td>

{/pre}

</tr>

<tr>

{pre}

<td>

paragraph

</td>

<td>

paragraph

</td>

{/pre}

</tr>

</table>

1.1 Paragraphs

Paragraphs are text elements separated by 2 or more new lines.

91

92

#info("In XWiki Syntax 2.0 new lines are honored which is not the case in XWiki Syntax 1.0 and in Creole syntax.")

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

98

<th>XWiki Syntax 2.0</th>

99

<th>Result XWiki Syntax 1.0</th>

100

<th>Result XWiki Syntax 1.2</th>

</tr>

<tr>

{pre}

<td>Simple paragraph</td>

105

<td>This is a paragraph</td>

106

<td>This is a paragraph</td>

107

{/pre}

108

<td>This is a paragraph</td>

109

<td>This is a paragraph</td>

</tr>

<tr>

{pre}

<td>Paragraph on multiple lines</td>

114

<td>Paragraph on<br/>multiple lines</td>

115

<td>Paragraph on<br/>multiple lines</td>

{/pre}

<td>

Paragraph on

multiple lines

</td>

<td>

Paragraph on<br/>

multiple lines

</td>

</tr>

<tr>

{pre}

<td>Two paragraphs</td>

129

<td>Paragraph one<br/><br/>Paragraph two</td>

130

<td>Paragraph one<br/><br/>Paragraph two</td>

{/pre}

<td>

Paragraph one

Paragraph two

</td>

<td>

Paragraph one

Paragraph two

</td>

</tr>

<tr>

{pre}

<td>Parametrized paragraph</td>

171

<td>

172

<p style="text-align:center;color:blue">Centered and blue paragraph</>

173

</td>

174

<td>

175

(% style="text-align:center;color:blue" %)<br/>

176

Centered and blue paragraph

177

{/pre}

178

<td>

179

<p style="text-align:center;color:blue">Centered and blue paragraph</p>

180

</td>

181

<td>

182

<p style="text-align:center;color:blue">Centered and blue paragraph</p>

</td>

</tr>

</table>

1.1 Headers

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

193

<th>XWiki Syntax 2.0</th>

<th>Result</th>

</tr>

<tr>

{pre}

<td>Standard headers</td>

<td>

#set ($h1 = "1")

#set ($h2 = "1.1")

#set ($h3 = "1.1.1")

#set ($h4 = "1.1.1.1")

204

#set ($h5 = "1.1.1.1.1")

205

#set ($h6 = "1.1.1.1.1.1")

$h1 level 1<br/>

$h2 level 2<br/>

$h3 level 3<br/>

$h4 level 4<br/>

$h5 level 5<br/>

$h6 level 6

</td>

<td>

= level 1<br/>

== level 2<br/>

=== level 3<br/>

==== level 4<br/>

===== level 5<br/>

====== level 6

#info("Closing equal signs are optional.")

</td>

{/pre}

<td>

$h1 level 1

$h2 level 2

$h3 level 3

$h4 level 4

$h5 level 5

$h6 level 6

</td>

</tr>

<tr>

{pre}

<td>Parametrized headers</td>

235

<td>

236

<h2 class="heading-1"><span style="color:blue">header</span></h2>

237

</td>

238

<td>

239

(% style="color:blue" %)<br/>

= header

</td>

{/pre}

<td>

<h2 class="heading-1" id="Hlevel1"><span style="color:blue">header</span></h2>

</td>

</tr>

<tr>

{pre}

<td>Headers with wiki syntax</td>

250

<td>$h3 Header with *bold*</td>

251

<td>=== Header with **bold**</td>

252

{/pre}

253

<td>

254

$h3 Header with *bold*

</td>

</tr>

</table>

1.1 Text Formatting

#info("New in XWiki Syntax 2.0 over XWiki Syntax 1.0:

262

* Spaces are allowed just after the syntax symbols (for example in XWiki Syntax 1.0, this was not * bold *).

263

* Use double symbols when there was only a single symbol in XWiki Syntax 1.0 so that it's less likely that the user will mistakenly use them in text.

264

* Ability to span several lines (wasn't the case in XWiki Syntax 1.0).")

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

270

<th>XWiki Syntax 2.0</th>

<th>Result</th>

</tr>

<tr>

{pre}

{/pre}

</tr>

<tr>

{pre}

<td>Underline</td>

<td>__underline___</td>

285

<td>__underline__</td>

286

{/pre}

287

<td>__underline__</td>

</tr>

<tr>

{pre}

<td>Italics</td>

<td>~~italic~~</td>

<td>//italic//</td>

{/pre}

<td>~~italic~~</td>

</tr>

<tr>

{pre}

<td>Striked out</td>

<td>--strike--</td>

<td>--strike--</td>

{/pre}

<td>--strike--</td>

</tr>

<tr>

{pre}

<td>Monospace</td>

<td><tt>monospace</tt></td>

309

#set($dash = "#")

310

<td>${dash}${dash}monospace${dash}${dash}</td>

311

{/pre}

312

<td><tt>monospace</tt></td>

</tr>

<tr>

{pre}

<td>Superscript</td>

<td>some <sup>superscript</sup></td>

318

<td>some ^^superscript^^</td>

319

{/pre}

320

<td>some <sup>superscript</sup></td>

</tr>

<tr>

{pre}

<td>Subscript</td>

<td>some <sub>subscript</sub></td>

326

<td>some ,,subscript,,</td>

327

{/pre}

328

<td>some <sub>subscript</sub></td>

</tr>

</table>

1.1 Horizontal Line

#info("There must be 4 or more dashes.")

335

#info("Note that this is different from Creole where exactly 4 dashes are required.")

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

341

<th>XWiki Syntax 2.0</th>

<th>Result</th>

</tr>

<tr>

{pre}

<td>Simple Horizontal Line</td>

{/pre}

</tr>

<tr>

{pre}

<td>Parametrized Horizontal Line</td>

<td>

</td>

<td>

(% style="color:blue" %)<br/>

----

</td>

{/pre}

</tr>

</table>

1.1 Lists

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

373

<th>XWiki Syntax 2.0</th>

<th>Result</th>

</tr>

<tr>

{pre}

<td>Bulleted list</td>

<td>

* item 1<br/>

** item 2<br/>

*** item 3<br/>

* item 4

</td>

<td>

* item 1<br/>

** item 2<br/>

*** item 3<br/>

* item 4

</td>

{/pre}

<td>

* item 1

** item 2

*** item 3

* item 4

</td>

</tr>

<tr>

{pre}

<td>Numbered list</td>

<td>

1. item 1<br/>

11. item 2<br/>

111. item 3<br/>

1. item 4

</td>

<td>

1. item 1<br/>

11. item 2<br/>

111. item 3<br/>

1. item 4

</td>

{/pre}

<td>

1. item 1

11. item 2

111. item 3

1. item 4

</td>

</tr>

<tr>

{pre}

<td>Mixed list</td>

<td>

1. item 1<br/>

1*. item 2<br/>

1*. item 3<br/>

1. item 4

</td>

<td>

1. item 1<br/>

1*. item 2<br/>

1*. item 3<br/>

1. item 4

</td>

{/pre}

<td>

1. item 1

1*. item 2

1*. item 3

1. item 4

</td>

</tr>

<tr>

{pre}

<td>Square list</td>

<td>

- item 1<br/>

- item 2<br/>

</td>

<td>

(% style="list-style-type: square" %)<br/>

* item 1<br/>

* item 2<br/>

</td>

{/pre}

<td>

- item 1

- item 2

</td>

</tr>

<tr>

{pre}

<td>

</ul>

</td>

<td>

(% style="list-style-type: disc" %)<br/>

* item 1<br/>

* item 2<br/>

</td>

{/pre}

<td>

</ul>

</td>

</tr>

<tr>

{pre}

<td>Lowercase Alphabetical list</td>

<td>

a. item 1<br/>

a. item 2<br/>

</td>

<td>

(% style="list-style-type: lower-alpha" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

a. item 1

a. item 2

</td>

</tr>

<tr>

{pre}

<td>Uppercase Alphabetical list</td>

<td>

A. item 1<br/>

A. item 2<br/>

</td>

<td>

(% style="list-style-type: upper-alpha" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

A. item 1

A. item 2

</td>

</tr>

<tr>

{pre}

<td>Lowercase Roman list</td>

<td>

i. item 1<br/>

i. item 2<br/>

</td>

<td>

(% style="list-style-type: lower-roman" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

i. item 1

i. item 2

</td>

</tr>

<tr>

{pre}

<td>Uppercase Roman list</td>

<td>

I. item 1<br/>

I. item 2<br/>

</td>

<td>

(% style="list-style-type: upper-roman" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

I. item 1

I. item 2

</td>

</tr>

<tr>

{pre}

<td>Lowercase Greek list</td>

<td>

g. item 1<br/>

g. item 2<br/>

</td>

<td>

(% style="list-style-type: lower-greek" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

g. item 1

g. item 2

</td>

</tr>

<tr>

{pre}

<td>Uppercase Greek list</td>

<td>

G. item 1<br/>

G. item 2<br/>

</td>

<td>

(% style="list-style-type: upper-greek" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

</ul>

</td>

</tr>

<tr>

{pre}

<td>Hiragana list</td>

<td>

h. item 1<br/>

h. item 2<br/>

</td>

<td>

(% style="list-style-type: hiragana" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

h. item 1

h. item 2

</td>

</tr>

<tr>

{pre}

<td>Hiragana Iroah list</td>

<td>

H. item 1<br/>

H. item 2<br/>

</td>

<td>

(% style="list-style-type: hiragana-iroha" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

H. item 1

H. item 2

</td>

</tr>

<tr>

{pre}

<td>Katakana list</td>

<td>

k. item 1<br/>

k. item 2<br/>

</td>

<td>

(% style="list-style-type: katakana" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

k. item 1

k. item 2

</td>

</tr>

<tr>

{pre}

<td>Katakana Iroha list</td>

<td>

K. item 1<br/>

K. item 2<br/>

</td>

<td>

(% style="list-style-type: katakana-iroha" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

K. item 1

K. item 2

</td>

</tr>

<tr>

{pre}

<td>Armenian list</td>

<td>

</ul>

</td>

<td>

(% style="list-style-type: armenian" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

</ul>

</td>

</tr>

<tr>

{pre}

<td>Hebrew list</td>

<td>

j. item1<br/>

j. item2<br/>

</td>

<td>

(% style="list-style-type: hebrew" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

</ul>

</td>

</tr>

<tr>

{pre}

<td>Georgian list</td>

<td>

</ul>

</td>

<td>

(% style="list-style-type: georgian" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

</ul>

</td>

</tr>

<tr>

{pre}

<td>CJK ideographic list</td>

<td>

</ul>

</td>

<td>

(% style="list-style-type: cjk-ideographic" %)<br/>

* item1<br/>

* item2<br/>

</td>

{/pre}

<td>

</ul>

</td>

</tr>

</table>

1.1 Definition Lists

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

765

<th>XWiki Syntax 2.0</th>

<th>Result</th>

</tr>

<tr>

{pre}

<td>Standard definition</td>

<td>

  <dd>definition</dd><br/>

</dl>

</td>

<td>

; term<br/>

: definition

</td>

{/pre}

<td>

<dl>

<dd>definition</dd>

</dl>

</td>

</tr>

<tr>

{pre}

<td>Nested definitions</td>

<td>

  <dd>definition1<br/>

796

797

798

      <dd>definition2</dd><br/>

    </dl><br/>

  </dd><br/>

</dl>

</td>

<td>

; term1<br/>

: definition1<br/>

:; term2<br/>

:: definition2

</td>

{/pre}

<td>

<dl>

<dd>definition1

<dl>

<dd>definition2</dd>

</dl>

</dd>

</dl>

</td>

</tr>

<tr>

{pre}

<td>Parametrized definition</td>

<td>

  <dd>definition</dd><br/>

</dl>

</td>

</td>

<td>

(% style="color:blue" %)<br/>

; term<br/>

: definition

</td>

{/pre}

<td>

<dd>definition</dd>

</dl>

</td>

</tr>

</table>

1.1 New Line/Line breaks

848

849

A new line is a carriage return. A line break is a forced new line that can appear anywhere in the text.

850

851

#info("In XWiki Syntax 2.0 new lines are honored which is not the case in XWiki Syntax 1.0 and in Creole syntax.")

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

857

<th>XWiki Syntax 2.0</th>

858

<th>Result XWiki Syntax 1.0</th>

859

860

861

<th>Result XWiki Syntax 2.0</th>

</tr>

<tr>

{pre}

<td>Line break</td>

{/pre}

</tr>

<tr>

{pre}

{/pre}

</tr>

</table>

1.1 Links

#*

TODO: In XWiki Syntax 2.0 it's possible to configure how links are displayed when they don't have an explicit label specified.

888

Give a link to how to configure this feature

*#

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

895

<th>XWiki Syntax 2.0</th>

896

<th>Result XWiki Syntax 1.0</th>

897

<th>Result XWiki Syntax 2.0</th>

</tr>

<tr>

{pre}

<td>Link to a page in the current Space</td>

<td>[WebHome]</td>

<td>[[WebHome]]</td>

{/pre}

<td>

</td>

<td>

<span class="wikilink"><a href="/xwiki/bin/view/Main/">WebHome</a></span>

</td>

</tr>

<tr>

{pre}

<td>Link with a label</td>

915

<td>[label>WebHome]</td>

916

<td>[[label>>WebHome]]</td>

917

{/pre}

918

<td>

919

<span class="wikilink"><a href="/xwiki/bin/view/Main/">label</a></span>

920

</td>

921

<td>

922

<span class="wikilink"><a href="/xwiki/bin/view/Main/">label</a></span>

</td>

</tr>

<tr>

{pre}

<td>Link to a page with the space specified</td>

928

<td>[Main.WebHome]</td>

929

<td>[[Main.WebHome]]</td>

{/pre}

<td>

</td>

<td>

<span class="wikilink"><a href="/xwiki/bin/view/Main/">WebHome</a></span>

</td>

</tr>

<tr>

{pre}

<td>Link to a subwiki</td>

941

<td>[subwiki:Main.WebHome]</td>

942

<td>[[subwiki:Main.WebHome]]</td>

{/pre}

<td>

</td>

<td>

<span class="wikilink"><a href="/xwiki/bin/view/Main/">WebHome</a></span>

</td>

</tr>

<tr>

{pre}

<td>Link that opens in a new page</td>

954

<td>[label>WebHome>_blank]</td>

955

<td>[[label>>WebHome||target="_blank"]]</td>

956

{/pre}

957

<td>

958

<span class="wikilink"><a href="/xwiki/bin/view/Main/" rel="__blank">label</a></span>

959

</td>

960

<td>

961

<span class="wikilink"><a href="/xwiki/bin/view/Main/" rel="__blank">label</a></span>

</td>

</tr>

<tr>

{pre}

<td>Link to a URL directly in the text</td>

967

<td>This is a URL: http://xwiki.org</td>

968

<td>This is a URL: http://xwiki.org</td>

969

{/pre}

970

<td>

971

This is a URL: <span class="wikiexternallink"><a href="http://www.xwiki.org">http://www.xwiki.org</a></span>

972

</td>

973

<td>

974

This is a URL: <span class="wikiexternallink"><a href="http://www.xwiki.org">http://www.xwiki.org</a></span>

</td>

</tr>

<tr>

{pre}

<td>[http://xwiki.org]</td>

981

<td>[[http://xwiki.org]]</td>

982

{/pre}

983

<td>

984

<span class="wikiexternallink"><a href="http://www.xwiki.org">http://www.xwiki.org</a></span>

985

</td>

986

<td>

987

<span class="wikiexternallink"><a href="http://www.xwiki.org">http://www.xwiki.org</a></span>

</td>

</tr>

<tr>

{pre}

<td>Link to a URL with a label</td>

993

<td>[XWiki>http://xwiki.org]</td>

994

<td>[[XWiki>>http://xwiki.org]]</td>

995

{/pre}

996

<td>

997

<span class="wikiexternallink"><a href="http://www.xwiki.org">XWiki</a></span>

998

</td>

999

<td>

1000

<span class="wikiexternallink"><a href="http://www.xwiki.org">XWiki</a></span>

</td>

</tr>

<tr>

{pre}

<td>Link to an email</td>

1006

<td>[email>mailto:john@smith.net]</td>

1007

<td>[[email>>mailto:john@smith.net]]</td>

1008

{/pre}

1009

<td>

1010

<span class="wikiexternallink"><a href="mailto:john&@smith.com">email</a></span>

1011

</td>

1012

<td>

1013

<span class="wikiexternallink"><a href="mailto:john&@smith.com">email</a></span>

</td>

</tr>

<tr>

{pre}

<td>Image Link</td>

<td><a href="\$xwiki.getURL("Space1.Page1")">{image:img.png|document=Space2.Page2}</a></td>

1021

<td>[[image:Space2.Page2@img.png>>Space1.Page1]] #info("Wiki syntax is supported inside link labels")</td>

1022

{/pre}

1023

<td>

1024

<a href="/xwiki/bin/view/Main/">{image:img.png}</a>

1025

</td>

1026

<td>

1027

<a href="/xwiki/bin/view/Main/">{image:img.png}</a>

</td>

</tr>

<tr>

<td>Link to attachment</td>

1032

<td>#info("See [Attach Macro>code:Macros.AttachMacro] for details")

1033

{pre}

1034

{attach:text|file=img.png}</td>

1035

<td>[[text>>attach:img.png]]</td>

1036

{/pre}

1037

<td>

1038

{attach:text|file=img.png}</td>

1039

</td>

1040

<td>

1041

{attach:text|file=img.png}</td>

</td>

</tr>

</table>

1.1.1 XWiki Syntax 1.0 Link Specification

1047

1048

The full format of a link is {code}(alias[|>])+(link)(@interWikiAlias)+([|>]target)+{code}

1049

* <tt>alias</tt>: An optional string which will be displayed to the user as the link name when rendered. Example: "My Page".

1050

* <tt>link</tt>: The full link reference using the following syntax: {code}(virtualWikiAlias:)+(space.)+(reference)(?queryString)+(#anchor)+{code}

1051

* Note that either the <tt>link</tt> or the <tt>alias</tt> must be specified.

1052

** <tt>virtualWikiAlias</tt>: An optional string containing the name of a virtual wiki. The link will point to a page inside that virtual wiki. Example: "mywiki".

1053

** <tt>space</tt>: An optional Wiki Space name. If not space is specified the current space is used. Example: "Main".

1054

** <tt>reference</tt>: The link reference. This can be either a URI in the form <tt>protocol:path</tt> (example: "http://xwiki.org", "mailto:john@smith.com") or a wiki page name (example: "WebHome").

1055

** <tt>queryString</tt>: An optional query string for specifying parameters that will be used in the rendered URL. Example: "mydata1=5&mydata2=Hello".

1056

** <tt>anchor</tt>: An optional anchor name pointing to an anchor defined in the referenced link. Note that in XWiki anchors are automatically created for titles. Example: "TableOfContentAnchor".

1057

* <tt>interWikiAlias</tt>: An optional [Inter Wiki>http://en.wikipedia.org/wiki/InterWiki] alias as defined in the InterWiki Map (see the [Admin Guide>http://platform.xwiki.org/xwiki/bin/view/AdminGuide/]). Example: "wikipedia"

1058

* <tt>target</tt>: An optional string corresponding to the HTML <tt>target</tt> attribute for a HTML <tt>a</tt> link element. This element is used when rendering the link. It defaults to opening the link in the current page. Examples: "_self", "_blank"

1059

1060

1.1.1 XWiki Syntax 2.0 Link Specification

1061

1062

The full format of a link is {code}(label>>)?(link)(||parameters)*{code}

1063

* <tt>label</tt>: the link label, can contain wiki syntax

1064

* <tt>link</tt>: the link target, i.e. where to go when the link is clicked. It has a similar format than in the XWiki 1.0 syntax and it can also contain 2 types of URIs: <tt>mailto:</tt> and <tt>attach:</tt> for linking to an email and linking to an attachment respectively.

1065

* <tt>parameters</tt>: An optional list of parameters passed to the link. For example the <tt>target</tt> element from XWiki Syntax 1.0 can be passed as a parameter.

1.1 Tables

Allows to easily create content in table format. It also support parameters for table, row or cell in XWiki Syntax 2.0.

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

1075

<th>XWiki Syntax 2.0</th>

1076

<th>Result XWiki Syntax 1.0</th>

1077

<th>Result XWiki Syntax 2.0</th>

</tr>

<tr>

{pre}

<td>Standard table</td>

1082

<td>

1083

{table}<br/>

1084

Title 1 | Title 2<br/>

Word 1 | Word 2<br/>

{table}

</td>

<td>

|=Title 1|=Title 2<br/>

|Word 1|Word 2<br/>

</td>

{/pre}

<td>

<table class="wiki-table" border="0" cellpadding="0" cellspacing="0"><tbody><tr><th>Title 1</th><th>Title 2</th></tr><tr class="table-odd"><td>Word 1</td><td>Word 2</td></tr></tbody></table>

1095

</td>

1096

<td>

1097

<table><tbody><tr><th>Title 1</th><th>Title 2</th></tr><tr><td>Word 1</td><td>Word 2</td></tr></tbody></table>

</td>

</tr>

<tr>

{pre}

<td>Parametrized table</td>

1103

<td>

1104

<table style="background-color:red;align:center"><br/>

1105

1106

1107

      <th>Title 1</th><br/>

1108

      <th style="background-color:yellow">Title 2</th><br/>

    </tr><br/>

    </tr><br/>

  </tbody><br/>

</table>

</td>

<td>

(% style="background-color:red;align=center" %)<br/>

1120

|=Title 1|=(% style="background-color:yellow" %)Title 2<br/>

|Word 1|Word 2<br/>

</td>

{/pre}

<td>

<table style="background-color:red;align:center"><tbody><tr><th>Title 1</th><th style="background-color:yellow">Title 2</th></tr><tr><td>Word 1</td><td>Word 2</td></tr></tbody></table>

1126

</td>

1127

<td>

1128

<table style="background-color:red;align:center"><tbody><tr><th>Title 1</th><th style="background-color:yellow">Title 2</th></tr><tr><td>Word 1</td><td>Word 2</td></tr></tbody></table>

</td>

</tr>

<tr>

{pre}

<td>Filterable Sortable table</td>

<td>

    <th>Title1</th><br/>

1138

    <th>Title2</th><br/>

  </tr><br/>

  </tr><br/>

  </tr><br/>

</table><br/>

</td>

<td>

#warning("Not implemented yet")

</td>

<td>

<th>Title1</th>

<th>Title2</th>

</tr>

<tr>

</tr>

<tr>

</tr>

</table>

</td>

<td>

#warning("Not implemented yet")

</td>

{/pre}

</tr>

</table>

1.1 Images

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

1182

<th>XWiki Syntax 2.0</th>

<th>Result</th>

</tr>

<tr>

<td>Image from attachment in current page</td>

1187

<td>

1188

#info("See [Image Macro>code:Macros.ImageMacro] for details")

{pre}

{image:img.png}

</td>

<td>image:img.png</td>

{/pre}

<td>

{image:img.png}

</td>

</tr>

<tr>

<td>Image from attachment in another document</td>

1200

<td>

1201

{pre}

1202

{image:img.png|document=Space.Page}

1203

</td>

1204

<td>image:Space.Page@img.png</td>

{/pre}

<td>

{image:img.png}

</td>

</tr>

<tr>

<td>Image with parameters</td>

1212

<td>

1213

{pre}

1214

{image:img.png|width=25|height=25}

1215

</td>

1216

<td>[[image:img.png||width="25" height="25"]]</td>

1217

{/pre}

1218

<td>

1219

{image:img.png|width=25|height=25}

</td>

</tr>

<tr>

<td>Images located at URL</td>

1224

<td>

1225

{pre}

1226

http://some/url/img.png

1227

</td>

1228

<td>image:http://some/url/img.png</td>

{/pre}

<td>

{image:img.png}

</td>

</tr>

</table>

1.1 Verbatim

Allow to enter content that will not be formatted (in other words the wiki syntax will not be taken into account).

1239

1240

#info("In XWiki Syntax 1.0 the [Pre macro>code:Macros.PreMacro] only preserves wiki syntax and Radeox macros. However HTML snippets and Groovy/Velocity scripts are still executed.")

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

1246

<th>XWiki Syntax 2.0</th>

1247

<th>Result XWiki Syntax 1.0</th>

1248

<th>Result XWiki Syntax 2.0</th>

1249

</tr>

1250

<tr>

1251

<td>Verbatim inline</td>

1252

<td>

1253

Some verbatim \{pre\}\*\[not rendered\]\*\{/pre\} content

</td>

{pre}

<td>

Some verbatim {{{**[[not rendered]]**}}} content

</td>

{/pre}

<td>

Some verbatim \*\[not rendered\]\* content

1262

</td>

1263

<td>

1264

Some verbatim \*\*\[\[not rendered\]\]\*\* content

</td>

</tr>

<tr>

<td>Verbatim block</td>

<td>

\{pre\}

multi line<br/>

\*verbatim\*<br/>

content<br/>

\{/pre\}

#info("It's also possible to use the [Code macro>code:Macros.CodeMacro] but it displays its content in a box by default.")

</td>

<td>

{{{<br/>

multi line<br/>

\*\*verbatim\*\*<br/>

content<br/>

}}}

</td>

<td>

multi line<br/>

\*verbatim\*<br/>

content

</td>

<td>

multi line<br/>

\*\*verbatim\*\*<br/>

content

</td>

</tr>

</table>

1.1 Quotations

Allows to quote some text.

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

1305

<th>XWiki Syntax 2.0</th>

<th>Result</th>

</tr>

<tr>

{pre}

<td>Simple quote</td>

<td>

I said ok

</td>

<td>

> john said this<br/>

I said ok

</td>

{/pre}

<td>

I said ok

</td>

</tr>

<tr>

{pre}

<td>Nested quotes</td>

1328

<td>

1329

1330

  <blockquote>marie answered that</blockquote><br/>

</blockquote><br/>

I said ok

</td>

<td>

> john said this<br/>

1336

>> marie answered that<br/>

I said ok

</td>

{/pre}

<td>

<blockquote>john said this<blockquote>marie answered that</blockquote></blockquote>

I said ok

</td>

</tr>

</table>

1.1 Embedded documents

1348

1349

This feature allows inserting another document inline directly into the current document. This allows for example to insert complex elements inside a list item or inside a table cell. Embedded documents are delimited by the following syntactic elements: <tt>(((...)))</tt>. One embedded document can contain its own embedded documents and there is no limit of imbrication.

<tr>

<th>XWiki Syntax 1.0</th>

1354

<th>XWiki Syntax 2.0</th>

<th>Result</th>

</tr>

<tr>

<td>This feature doesn't exist in XWiki syntax 1.0. You'd have to use pure HTML to achieve the result.</td>

1359

<td>

1360

{code:none}

1361

|=Header 1|=Header 2|=Header 3

|Cell One|(((

= Embedded document

Some embedded paragraph.

* list item one

* list item two

** sub-item 1

** sub-item 2

))) | Cell Three

Next paragraph in the top-level document

{code}

</td>

<td>

<table>

<tr>

<th>Header 1</th>

<th>Header 2</th>

<th>Header 3</th>

</tr>

<tr>

<td>

<span>Embedded document</span>

1389

</h1>

1390

<p>Some embedded paragraph</p>

<ul>

<li>list item two

<ul>

</ul>

</li>

</ul>

</div>

</td>

<td> Cell Three</td>

</tr>

</table>

<p>Next paragraph in the top-level document</p></td>

</td>

</tr>

</table>

1.1 Escapes

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

1416

<th>XWiki Syntax 2.0</th>

1417

<th>Result XWiki Syntax 1.0</th>

1418

<th>Result XWiki Syntax 2.0</th>

</tr>

<tr>

{pre}

<td>Escape a character</td>

1423

1424

<td>

1425

This is not a ~[~[link~]~]

1426

#info("To enter a ~ character use a double escape: ~~")

</td>

{/pre}

</tr>

</table>

1.1 Macros

There are 2 kinds of macros in XWiki syntax 1.0:

1437

* Velocity macros (called using the <tt>\#macroname(param1 ... paramN)</tt> syntax)

1438

* Radeox macros (called using the <tt>\{macroname:param1=value1|...|paramN=valueN\}</tt> syntax)

1439

1440

There are also 2 kinds of macros in XWiki Syntax 2.0:

1441

* Velocity macros (called using the <tt>\#macroname(param1 ... paramN)</tt> syntax)

1442

* XWiki macros (called using the <tt>\{\{macroname param1="value1" ... paramN="valueN"\}\}</tt> syntax)

1443

1444

#info("The Radeox macros cannot be used in XWiki Syntax 2.0. Thus they have been rewritten as XWiki macros.")

1445

1446

#info("For the full list of available macros check the [Macro Reference page>code:Macros.WebHome].")

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

1452

<th>XWiki Syntax 2.0</th>

<th>Result</th>

</tr>

<tr>

<td>Velocity Macro</td>

1457

<td>

1458

\#info("Some info text")

1459

</td>

1460

<td>

1461

\{\{velocity\}\}\{\{html\}\}

1462

\#info("Some info text")

1463

\{\{/html\}\}\{\{/velocity\}\}

</td>

</tr>

<tr>

<td>Radeox Macro/XWiki Macros</td>

<td>

\{code:java\}

content

\{code\}

</td>

<td>

\{\{velocity context="new"\}\}

content

\{\{/velocity\}\}

</td>

<td>N/A (depends on the macro)</td>

</tr>

</table>

1.1 HTML

#info("In XWiki Syntax 2.0 HTML or XHTML must be entered by using the HTML macro whereas in XWiki Syntax 1.0 it's possible to enter HTML directly in the text")

<tr>

<th>XWiki Syntax 1.0</th>

1490

<th>XWiki Syntax 2.0</th>

<th>Result</th>

</tr>

<tr>

{pre}

<td>

{{html}}<br/>

</td>

{/pre}

</tr>

</table>

#info("In XWiki Syntax 2.0, by default the HTML macro understands wiki syntax. To prevent this, use {{html wiki=\"false\"}}")

1507

1508

1.1 Velocity/Groovy Scripts

1509

1510

#info("In XWiki Syntax 1.0 it was possible to enter Velocity scripts anywhere directly in the page. This lead to issues for example when the user was involuntarily entering Velocity content. It was also performance hungry for pages not requiring Velocity content. There were several other technical limitations. Thus in XWiki Syntax 2.0 Velocity scripts must be entered using the <tt>velocity</tt> macro. Same goes for entering Groovy scripts.")

<tr>

<th>Feature</th>

<th>XWiki Syntax 1.0</th>

1516

<th>XWiki Syntax 2.0</th>

1517

</tr>

1518

<tr>

1519

<td>Velocity script</td>

1520

<td>\#set (\$var = "whatever")</td>

1521

<td>

1522

\{\{velocity\}\}<br/>

1523

\#set (\$var = "whatever")<br/>

\{\{/velocity\}\}

</td>

</tr>

<tr>

<td>Groovy script</td>

1529

<td>

1530

\<\%<br/>

1531

def var = "whatever"<br/>

\%\>

</td>

<td>

\{\{groovy\}\}<br/>

def var = "whatever"<br/>

\{\{/groovy\}\}

</td>

</tr>

</table>

1.1 Parameters

With XWiki Syntax 2.0 it's possible to pass parameters to the different syntax elements and also to blocks of text. This is used for example to style them. You can set any parameter key/value pair you want. The XHTML renderer will pass these parameters as XHTML attributes to the underlying XHTML representation of the different syntax elements. In XWiki Syntax 1.0 there was no syntax for passing parameters and the only way to do it was to write XHTML directly in the content as shown in the table below.

<tr>

<th>XWiki Syntax 1.0</th>

1549

<th>XWiki Syntax 2.0</th>

1550

<th>Generated XHTML</th>

</tr>

<tr>

<td>

<h1 class="myClass" style="myStyle" id="myId">header</h1&gt

1555

</td>

1556

<td>

1557

(% class="myClass" style="myStyle" id="myId" %)<br/>

1558

= header =

1559

<td>

1560

<h1 class="myClass" style="myStyle" id="myId">header</h1&gt

</td>

</tr>

</table>

1.1 Other syntaxes

The following other syntaxes are implemented in XWiki Enterprise 1.6 and above:

1568

* [JSPWiki>http://www.jspwiki.org/wiki/TextFormattingRules]

1569

* [MediaWiki>http://en.wikipedia.org/wiki/Help:Editing]

1570

* [Confluence>http://confluence.atlassian.com/display/CONF20/Confluence+Notation+Guide+Overview]

1571

* [TWiki>http://twiki.org/cgi-bin/view/TWiki/WikiSyntax]

1572

* [Creole 1.0>http://www.wikicreole.org/wiki/Creole1.0]

1573

* [XHTML 1.0>http://www.w3.org/TR/xhtml1/]

1574

1575

#warning("The implementation for these syntaxes is not fully finished yet. For example support for links is not working yet. We also need to define if we want to extend the original syntaxes to support XWiki-specific features like ability to link to another sub-wiki. This is planned for XWiki Enterprise 1.8 and beyond.")

Wiki source code of XWikiSyntax

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected