XWiki Syntax Guide
XWiki Syntax » Advanced
XWiki Syntax : Advanced
Verbatim
Verbatim
1.0 Verbatim
Allow to enter content that will not be formatted (in other words the XWiki Syntax will not be taken into account).
| Feature | XWiki Syntax 1.0 | Result |
|---|---|---|
| Verbatim inline | Some verbatim {pre}*[not rendered]*{/pre} content | Some verbatim *[not rendered]* content |
| Verbatim block |
{pre}
multi line
*verbatim*
content
{/pre}
| multi line *verbatim* content |
2.0 Verbatim
Allow to enter content that will not be formatted (in other words the XWiki Syntax will not be taken into account).
| Feature | XWiki Syntax | Result |
|---|---|---|
| Verbatim inline | Some verbatim {{{**[[not rendered]]**}}} content | Some verbatim **[[not rendered]]** content |
| Verbatim block |
{{{
multi line
**verbatim**
content
}}}
| multi line **verbatim** content |
Quotations
Quotations
1.0 Quotations
Allows to quote some text.
| Feature | XWiki Syntax 1.0 | Result |
|---|---|---|
| Simple quote | <blockquote><p>john said this</p></blockquote> |
I said ok |
| Nested quotes | <blockquote><p>john said this</p> |
I said ok |
2.0 Quotations
Allows to quote some text.
| Feature | XWiki Syntax | Result |
|---|---|---|
| Simple quote | > john said this I said ok |
I said ok |
| Nested quotes | > john said this >> marie answered that I said ok |
I said ok |
Groups
Groups
2.0 Groups
Groups can be used to insert another document inline directly into the current document. This allows for example to insert complex elements or style inside a list item, inside a table cell or a paragraph. Groups are delimited by the following syntactic elements: (((...))). One Group can contain another Group and there is no limit of imbrication.
| XWiki Syntax | Result | ||||||
|---|---|---|---|---|---|---|---|
|=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 |
Next paragraph in the top-level document | ||||||
(% class="myClass" style="color:blue" %)(((blue paragraphs inside myClass))) | blue paragraphs inside my group |
Escapes
Escapes
1.0 Escapes
Allows to escape XWiki Syntax.
| Feature | XWiki Syntax 1.0 | Result |
|---|---|---|
| Escape a character | This is not a \[link\] | This is not a [link] |
2.0 Escapes
Allows to escape XWiki Syntax.
| Feature | XWiki Syntax | Result |
|---|---|---|
| Escape a character | This is not a ~[~[link~]~] | This is not a [[link]] |
| Escape longer text (also see "Verbatim") | {{{ some **longer** text //without// formatting}}} | some **longer** text //without// formatting |
Parameters
Parameters
1.0 Parameters
In XWiki Syntax 1.0 there is 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.
| XWiki Syntax 1.0 | Generated XHTML |
|---|---|
<h1 class="myClass" style="myStyle" id="myId">heading</h1> | <h1 class="myClass" style="myStyle" id="myId">heading</h1> |
2.0 Parameters
With XWiki Syntax 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.
| XWiki Syntax | Generated XHTML |
|---|---|
(% class="myClass" style="myStyle" id="myId" %) = heading = | <h1 class="myClass" style="myStyle" id="myId">heading</h1> |