XWiki - XWiki Syntax Guide

Page of - last modified by superadmin on 2017/11/28 14:52

XWiki Syntax Guide

superadmin

2017/11/28 14:52

Table of Contents

XWiki Syntax 2.1: Advanced

XWiki Syntax 2.1 » Advanced

XWiki Syntax 2.1: Advanced

General

Introduction

General Remarks

Other Syntaxes

Editing

Paragraphs

Headings

Text Formatting

Horizontal Line

Lists

Definition Lists

New Line/Line Breaks

Links

Tables

Images

Advanced

Verbatim

Quotations

Groups

Escapes

Parameters

Programming

Macros

HTML

Scripts

Verbatim

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 2.1	Result
Verbatim inline	Some verbatim {{{**[[not rendered]]**}}} content	Some verbatim **[[not rendered]]** content
Verbatim block	{{{ multi line **verbatim** content }}}	multi line **verbatim** content

Quotations

2.0 Quotations

Allows to quote some text.

Feature	XWiki Syntax 2.1	Result
Simple quote	> john said this I said ok	john said this I said ok
Nested quotes	> john said this >> marie answered that I said ok	john said this marie answered that I said ok

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 2.1	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	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
(% class="myClass" style="color:blue" %)(((blue paragraphs inside myClass)))	blue paragraphs inside my group

Escapes

2.0 Escapes

Allows to escape XWiki Syntax.

Feature	XWiki Syntax 2.1	Result
Escape a character	This is not a ~[~[link~]~] To enter a ~ character use a double escape: ~~	This is not a [[link]]
Escape longer text (also see "Verbatim")	{{{ some **longer** text //without// formatting}}}	some **longer** text //without// formatting

Parameters

2.0 Parameters

With XWiki Syntax 2.1 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 2.1	Generated XHTML
(% class="myClass" style="myStyle" id="myId" %) = heading =	<h1 class="myClass" style="myStyle" id="myId">heading</h1>