XWikiSyntax (XWiki.org)

In addition to these special wiki syntaxes XWiki allows any HTML to be inserted in a page so if there no wiki syntax for what you wish to achieve, consider using HTML.

24

25

1.1 Titles

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

1 Title 1

1.1 Title 2

1.1.1 Title 3

1.1.1.1 Title 4

1.1.1.1.1 Title 5

1.1.1.1.1.1 Title 6

</pre>

</td>

<td>

<h2 class="heading-1"><span id="HTitle1">Title 1</span></h2><p class="paragraph"/>

46

<h3 class="heading-1-1"><span id="HTitle2">Title 2</span></h3><p class="paragraph"/>

47

<h4 class="heading-1-1-1"><span id="HTitle3">Title 3</span></h4><p class="paragraph"/>

48

<h5 class="heading-1-1-1-1"><span id="HTitle4">Title 4</span></h5><p class="paragraph"/>

49

<h6 class="heading-1-1-1-1-1"><span id="HTitle5">Title 5</span></h6><p class="paragraph"/>

50

<h6 class="heading-1-1-1-1-1-1"><span id="HTitle6">Title 6</span></h6><p class="paragraph"/>

</td>

</tr>

</table>

{/pre}

1.1 Paragraphs

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

Here is a paragraph.

This text continues the same paragraph.

69

70

This paragraph is a new one.

71

72

This paragraph is another new one.

73

74

This paragraph is displayed\\

on two lines.

</pre>

</td>

<td>

Here is a paragraph.

This text continues the same paragraph.<p class="paragraph"/>This paragraph is a new one.<p class="paragraph"/>This paragraph is another new one.<p class="paragraph"/>

81

This paragraph is displayed<br/>on two lines.

</td>

</tr>

</table>

{/pre}

1.1 Lists

1.1.1 Bulleted Lists

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

* Item 1

** Item 2

*** Item 3

* Item 4

</pre>

</td>

<td>

<li>Item 1

<li>Item 2

</ul>

</li>

</ul>

</li>

</ul>

</td>

</tr>

</table>

{/pre}

1.1.1 Numbered Lists

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

1. Item 1

11. Item 2

111. Item 3

1. Item 4

1. Item 1

1*. Item 2

1*. Item 3

1. Item 4

a. Alphabetical enumerated list

146

a. Alphabetical enumerated list

147

148

A. Uppercase alphabetical enumerated list

149

A. Uppercase alphabetical enumerated list

150

151

i. Roman enumerated list

152

i. Roman enumerated list

153

154

I. Uppercase roman enumerated list

155

I. Uppercase roman enumerated list

156

157

g. Greek enumerated list

158

g. Greek enumerated list

159

160

h. Hirigana (jap.) enumerated list

161

h. Hirigana (jap.) enumerated list

162

163

k. Katakana (jap.) enumerated list

164

k. Katakana (jap.) enumerated list

</pre>

</td>

<td>

<ol>

<li>Item 1

<ol>

<li>Item 2

<ol>

</ol>

</li>

</ol>

</li>

</ol>

<ol>

<li>Item 1

</ul>

</li>

</ol>

<li>Alphabetical enumerated list</li>

193

<li>Alphabetical enumerated list</li>

</ol>

<li>Uppercase alphabetical enumerated list</li>

198

<li>Uppercase alphabetical enumerated list</li>

</ol>

<li>Roman enumerated list</li>

203

<li>Roman enumerated list</li>

</ol>

<li>Uppercase roman enumerated list</li>

208

<li>Uppercase roman enumerated list</li>

</ol>

<li>Greek enumerated list</li>

213

<li>Greek enumerated list</li>

</ol>

<li>Hirigana (jap.) enumerated list</li>

218

<li>Hirigana (jap.) enumerated list</li>

</ol>

<li>Katakana (jap.) enumerated list</li>

223

<li>Katakana (jap.) enumerated list</li>

</ol>

</td>

</tr>

</table>

{/pre}

1.1.1 Definition Lists

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

<dl>

<dd>Definition</dd>

</dl>

</pre>

</td>

<td>

<dl>

<dd>Definition</dd>

</dl>

</td>

</tr>

</table>

{/pre}

1.1 Text Styles

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

a *bold* word

an __underlined__ word

~~text in italics~~

--striked text--

<tt>text in monospace font</tt>

278

279

Text in a <sup>superscript</sup> format

280

281

Text in a <sub>subscript</sub> format

282

283

{quote:http://www.xwiki.org}

284

Here is some text with a quote

{quote}

</pre>

</td>

<td>

a <strong class="strong">bold</strong> word<p class="paragraph"/>

290

an <span class="underline">underlined</span> word<p class="paragraph"/>

291

<em class="italic">text in italics</em><p class="paragraph"/>

292

<del class="strike">striked text</del><p class="paragraph"/>

293

<tt>text in monospace font</tt><p class="paragraph"/>

294

Text in a <sup>superscript</sup> format<p class="paragraph"/>

295

Text in a <sub>subscript</sub> format<p class="paragraph"/>

296

297

Here is some text with a quote

298

<a href="http://www.xwiki.org">Source</a>

299

</blockquote><p class="paragraph"/>

</td>

</tr>

</table>

{/pre}

1.1 Horizontal Line

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

----

</pre>

</td>

<td>

</td>

</tr>

</table>

{/pre}

1.1 Links

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

329

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

330

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

331

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

332

** <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".

333

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

334

** <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").

335

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

336

** <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".

337

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

338

* <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"

1.1.1 Internal Links

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

[WebHome] (uses current space)

352

[home>WebHome] (uses current space)

353

[Main.WebHome]

354

[home|Main.WebHome]

355

[home>Main.WebHome>_blank]

</pre>

</td>

<td>

<span class="wikilink"><a href="/xwiki/bin/view/UserGuide/">Web Home</a></span> (uses current space)<br/>

360

<span class="wikilink"><a href="/xwiki/bin/view/UserGuide/">home</a></span> (uses current space)<br/>

</td>

</tr>

</table>

{/pre}

1.1.1 External Links

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

http://www.xwiki.org

[http://www.xwiki.org]

382

[XWiki>http://www.xwiki.org]

</pre>

</td>

<td>

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

387

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

388

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

</td>

</tr>

</table>

{/pre}

1.1 Tables

The syntax for tables allows to easily create content in table format. It even allows to make some simple calculations on the content!

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<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>

<tr>

<th>Title 1</th>

<th>Title 2</th>

</tr>

</tr>

</table>

<tr>

<th>Category</th>

<th>Sales (K?)</th>

</tr>

<td>Category 1</td>

</tr>

<td>Category 2</td>

</tr>

<td>Category 3</td>

</tr>

<td>Total</td>

</tr>

</table>

</td>

</tr>

</table>

{/pre}

1.1 Images

The <tt>\{image\}</tt> macro is used to display attachments as images. Check the [Image macro reference guide>Code.ImageMacro] for all options.

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

{image:img.png}

{image:img.png|30}

{image:img.png| |20}

{image:img.png|30|20}

</pre>

</td>

<td>

</td>

</tr>

</table>

{/pre}

1.1 Escaping Text

1.1.1 Escaping a single character

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

This is not a \[link\]

505

\#set (\$var = "something")

</pre>

</td>

<td>

This is not a [link]<br />

510

\#set (\$var = "something")

</td>

</tr>

</table>

{/pre}

1.1.1 Escaping wiki syntax rendering

517

518

The <tt>{pre}{/pre}</tt> macro prevents wiki syntax rendering but preserves HTML rendering.

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

{pre}

No *bold rendering* in wiki syntax.

{/pre}

</pre>

</td>

<td>

No *bold rendering* in wiki syntax.

</td>

</tr>

</table>

{/pre}

1.1.1 Escaping everything

542

543

The <tt>\{code\}\{code\}</tt> macro prevents wiki syntax rendering, HTML rendering and Groovy/Velocity rendering. Check the [Code macro reference guide>Code.CodeMacro] for all options.

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

{code}

No <strong>bold rendering</strong> in HTML.

556

No *bold rendering in* wiki syntax.

{code}

</pre>

</td>

<td>

<pre>No <strong>bold rendering</strong> in HTML.

563

No *bold rendering in* wiki syntax.</pre>

</div>

</td>

</tr>

</table>

{/pre}

1.1 Boxes

Boxes are a nice way to improve on the visual presentation and highlight important elements. The reference documentation for the macros shown below can be found here:

573

* [Info Macro>Code.InfoMacro]

574

* [Warning Macro>Code.WarningMacro]

575

* [Error Macro>Code.ErrorMacro]

576

* [Floating Box Macro>Code.FloatingBoxMacro]

577

* [Style Macro>Code.StyleMacro]

{pre}

<tr>

<th>Example</th>

<th>Result</th>

</tr>

<tr>

<td>

<pre>

\#info("This is an information panel")

589

590

\#warning("This is a warning panel")

591

592

\#error("This is an error panel")

593

594

\#startfloatingbox()

595

Some content in a floating box

596

\#endfloatingbox()

597

This is a floating box displayed on the right.

598

599

\#floatingbox("Some content in a floating box")

600

This is also a floating box displayed on the right.

601

602

{style:type=div|border=1px solid red|background-color=grey|width=300px|height=300px|color=red}

603

This is some content...

{style}

</pre>

</td>

<td>

<div class="infomessage">This is an information panel</div>

609

<div class="warningmessage"><span class="messagetype">Warning: </span>This is a warning panel</div>

610

<div class="errormessage"><span class="messagetype">Error: </span>This is an error panel</div>

611

612

613

Some content in a floating box

614

</fieldset>

615

This is a floating box displayed on the right.<p class="paragraph"/>

616

<fieldset class="floatinginfobox">Some content in a floating box</fieldset>

617

This is also a floating box displayed on the right.<p class="paragraph"/>

618

619

This is some content…

</div>

</td>

</tr>

</table>

{/pre}

1.1 Other Macros

*XWiki boasts a [lot of other very useful macros>Code.Macros]*.

629

630

#info("Make sure to check also our [Code Zone>Code.WebHome] as we also have [Plugins>Code.Plugins], [Code Snippets>Code.Snippets], [Applications>Code.Applications] and [Extensions>Code.Extensions].")

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