XWiki Syntax Guide

Редактировал(а) Alexandr Fokin 2021/12/25 16:15
Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.

XWiki Syntax 2.1

XWiki Syntax 2.1: All

  • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
  • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
  • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
  • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    • Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.

General

Introduction

2.1 Introduction

The XWiki Syntax 2.0 has proven to be quite useful and robust in general; however since its introduction a few shortcomings have been found. The corresponding improvements have been consolidated in XWiki Syntax 2.1. Some new features of this syntax are:

  • Homogenize the link and image syntax for better clarity, consistency and extensibility.
  • Added ability to display icons, to embed images via the Data URI scheme, to link to files using the UNC notation and to link to relative URLs.

Since XWiki Syntax 2.1 is based on XWiki Syntax 2.0 all syntax from XWiki Syntax 2.0 is valid unless the 2.1 specifications suggest differently.

General Remarks

2.0 General Remarks

XWiki Syntax 2.1 corrects some errors or ambiguous syntax entered by the user as shown in the examples in the table below.

DescriptionExample of invalid or ambiguous syntaxFixed XWiki Syntax 2.1
Unclosed text styles**bold**bold**
Two standalone elements not separated by 2 new lines| table cell
* list item		| table cell

* list item
Two standalone elements not separated by 2 new linesparagraph
----
paragraph		paragraph

----

paragraph
Ignored new line at beginning of document<new line at beginning of document>
paragraph		paragraph
Not closed heading syntax=== heading=== heading ===

Other Syntaxes

1.0 Other Syntaxes

Other syntaxes are also available.

Editing

Paragraphs

2.0 Paragraphs

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

FeatureXWiki Syntax 2.1Result
Simple paragraphThis is a paragraphThis is a paragraph
Paragraph on multiple linesParagraph on
multiple lines		Paragraph on
multiple lines
Two paragraphsParagraph one

Paragraph two		Paragraph one

Paragraph two
Parametrized paragraph(% style="text-align:center;color:blue" %)
Centered and blue paragraph
Centered and blue paragraph
Different style on some portion of the paragraph contentparagraph with (% style="color:red" %)red(%%) different style insideparagraph with red texte inside

Headings

2.0 Headings

FeatureXWiki Syntax 2.1Result
Standard headings
= level 1 = 
== level 2 ==
=== level 3 ===
==== level 4 ====
===== level 5 =====
====== level 6 ======

level 1

 

level 2

level 3

level 4

level 5
level 6
Parameterized headings(% style="color:blue" %)
= heading =

heading

Headings with XWiki Syntax=== Heading with **bold** ===

Heading with bold

Text Formatting

2.0 Text Formatting

FeatureXWiki Syntax 2.1Result
Bold**bold**bold
Underline__underline__underline
Italics//italic//italic
Striked out--strike--strike
Monospace##monospace##monospace
Superscriptsome ^^superscript^^some superscript
Subscriptsome ,,subscript,,some subscript

Horizontal Line

2.0 Horizontal Line

There must be 4 or more dashes.

FeatureXWiki Syntax 2.1Result
Simple horizontal line----
Parametrized horizontal line
(% style="border-color:blue" %)
----

Lists

2.0 Lists

Some of the mentioned styles do not work on all browsers. For a comprehensive list follow this link.

FeatureXWiki Syntax 2.1Result
Bulleted list
* item 1
** item 2
*** item 3
* item 4
  • item 1
    • item 2
      • item 3
  • item 4
Numbered list
1. item 1
11. item 2
111. item 3
1. item 4
  1. item 1
    1. item 2
      1. item 3
  2. item 4
Mixed list
1. item 1
1*. item 2
1*. item 3
1. item 4
  1. item 1
    • item 2
    • item 3
  2. item 4
Square list
(% style="list-style-type: square" %)
* item 1
* item 2
  • item 1
  • item 2
Disc list
(% style="list-style-type: disc" %)
* item 1
* item 2
  • item 1
  • item 2
Lowercase Alphabetical list
(% style="list-style-type: lower-alpha" %)
* item 1
* item 2
  • item 1
  • item 2
Uppercase Alphabetical list
(% style="list-style-type: upper-alpha" %)
* item 1
* item 2
  • item 1
  • item 2
Lowercase Roman list
(% style="list-style-type: lower-roman" %)
* item 1
* item 2
  • item 1
  • item 2
Uppercase Roman list
(% style="list-style-type: upper-roman" %)
* item 1
* item 2
  • item 1
  • item 2
Lowercase Greek list
(% style="list-style-type: lower-greek" %)
* item 1
* item 2
  • item 1
  • item 2
Uppercase Greek list
(% style="list-style-type: upper-greek" %)
* item 1
* item 2
  • item 1
  • item 2
Hiragana list
(% style="list-style-type: hiragana" %)
* item 1
* item 2
  • item 1
  • item 2
Hiragana Iroah list
(% style="list-style-type: hiragana-iroha" %)
* item 1
* item 2
  • item 1
  • item 2
Katakana list
(% style="list-style-type: katakana" %)
* item 1
* item 2
  • item 1
  • item 2
Katakana Iroha list
(% style="list-style-type: katakana-iroha" %)
* item 1
* item 2
  • item 1
  • item 2
Armenian list
(% style="list-style-type: armenian" %)
* item 1
* item 2
  • item 1
  • item 2
Hebrew list
(% style="list-style-type: hebrew" %)
* item 1
* item 2
  • item 1
  • item 2
Georgian list
(% style="list-style-type: georgian" %)
* item 1
* item 2
  • item 1
  • item 2
CJK ideographic list
(% style="list-style-type: cjk-ideographic" %)
* item 1
* item 2
  • item 1
  • item 2

Списки определений

2.0 Definition Lists

ФункциональностьСинтаксис XWiki 2.1Результат
Стандартное определение
; термин
: определение
термин
определение
Вложенные определения
; термин 1
: определение 1
:; термин 2
:: определение 2
термин 1
определение 1
термин 2
определение 2
Параметризированное определение
(% style="color:blue" %)
; термин
: определение
термин
определение

New Line/Line Breaks

2.0 New Line Line Breaks

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

FeatureXWiki Syntax 2.1Result
Line breakLine\\New lineLine
New line
New lineLine
New line		Line
New line
FeatureXWiki Syntax 2.1Result
Absolute link to page PageB located in PageA[[PageA.PageB]]PageB
Relative link to page PageA from the current page[[PageA]] or [[.PageA]]PageA
Relative link to page PageB in PageA from the current page[[.PageA.PageB]]PageB
Link with a label
[[label>>PageA]]

XWiki Syntax is supported inside link labels.

label
Link with wiki syntax in the label[[**bold label**>>PageA]]bold label
Link on an image[[image:PageA@img.png>>PageA]]img.png
Absolute link to page PageB located in PageA in wiki WikiA[[WikiA:PageA.PageB]]PageB
Link that opens in a new window[[PageA||target="_blank"]]PageA
Implicit link to a URLThis is a URL: https://xwiki.orgThis is a URL: https://xwiki.org
Explicit link to a URL[[https://xwiki.org]]https://xwiki.org
Explicit link to a URL with a label[[XWiki>>https://xwiki.org]]XWiki
Link to an email address[[john@smith.net>>mailto:john@smith.net]]john@smith.net
Link to an attachment on the current page[[attach:img.png]]img.png
Link to an attachment in a different page[[attach:PageA.PageB@img.png]]img.png
Link to an Anchor in a page[[PageA.PageB||anchor="anchor"]]PageB
Link to a Heading in a page
[[PageA.PageB||anchor="HMyheading"]]

When you add a Heading, an anchor named "H" followed by the heading title with only alpha characters is created. For example, for a Heading named "My heading", the generated anchor will be "HMyheading".

PageB
Link to an anchor in the current page[[label>>||anchor="anchor"]]label
Link to a page with a query string[[PageA.PageB||queryString="param1=value1&param2=value2"]]PageB
Link to the current page with a query string[[label>>||queryString="param1=value1&param2=value2"]]label

XWiki Syntax 2.1 Link Specification

Legend: The parts in () are required, while the parts in [] are optional.

The full format of a link is [label>>] (resource) [||parameters]

  • label: An optional string which will be displayed to the user as the link name when rendered. The label may contain XWiki Syntax. If no label is specified a default label will be generated. The generation pattern can be changed, see the Admin Guide. Example: My Page
  • resource: A required string with the link reference in one of the following forms
    • URL: Any URL in the form of [url:](protocol://path). Examples: http://xwiki.org, url:https://svn.xwiki.org/
      • url: An optional string identifying the resource as an URL.
      • protocol://path: The URL itself
    • Wiki page: A reference in the form page:[(wikiName):](pageNameList). Examples: page:Page, page:myxwiki:Page, page:ParentPage.ChildPage.SubChildPage, page:../SiblingPage, page:./ChildPage
      • page: A required string identifying the resource as an XWiki page. The same reference can be used for either a terminal or non-terminal page, if both exist it will lead to the non-terminal page.
      • wikiName: An optional string containing the name of a wiki. The link will point to a page inside that  wiki. If no wiki is specified, the current wiki is used. Example: mywiki
      • pageNameList: A required list of slash-separated wiki Pages names pointing to the final linked wiki Page syntax. It's also possible to use . and .. to indicate current or parent page/wiki. Examples: Main, A/B, A/B/C, ../Sibling, ./Child
    • Wiki document: A reference in the form [doc:][[(wikiName):](spaceNameList).](documentName). Examples: doc:Welcome, doc:Main.Welcome, doc:mywiki:Main.Welcome, Welcome
      • doc: An optional string identifying the resource as an XWiki terminal page. A non-terminal page can also be referenced this way, but it must append its .WebHome part (e.g. doc:Sandbox.WebHome).
      • wikiName: An optional string containing the name of a wiki. The link will point to a page inside that wiki. If no wiki is specified, the current wiki is used. Example: mywiki.
      • spaceNameList: An optional dot-separated list of wiki Space names. If no space is specified the current space is used. Examples: Main, A.B, A.B.C
      • documentName: A required string containing the name of the linked wiki page. Example: Welcome
    • Wiki space: A reference in the form space:[(wikiName):](spaceNameList). Examples: space:Main, space:mywiki:Main, space:A.B.C
      • space: A required string identifying the resource as an XWiki non-terminal page (i.e. a space).
      • wikiName: An optional string containing the name of a wiki. The link will point to a page inside that wiki. If no wiki is specified, the current wiki is used. Example: mywiki
      • spaceNameList: A required list of dot-separated wiki Space names pointing to the final linked wiki Space (or non-terminal page). Examples: Main, A.B, A.B.C
    • InterWiki page: A reference in the form interwiki:[(interWikiAlias):](pageName). Example: interwiki:wikipedia:XWiki
      • interwiki: A required string identifying the resource as an InterWiki link.
      • interWikiAlias: An optional Inter Wiki alias as defined in the InterWiki Map (see the Admin Guide). Example: wikipedia
      • pageName: A required string containing the name of the linked page. Example: XWiki
    • Attachment: A reference in the form attach:{{{(wikiName):}(spaceNameList).}(pageName)@}(imageName)
      • attach: A required string identifying the reference as an XWiki Document attachment.
      • wikiName: An optional string containing the name of a wiki. The image reference will point to an image attached to a page inside that wiki. If no wiki is specified, the current wiki is used. Example: mywiki.
      • spaceNameList: An optional dot-separated list of wiki Space names. If no space is specified the current space is used. Examples: Main, A.B, A.B.C
      • pageName: An optional string containing the name of the wiki page to which the referenced image is attached. Example: Welcome
      • attachmentName: Name of the attachment as it is stored in the wiki. Example: photo.png
    • Page Attachment: A reference in the form pageAttach:{{{(wikiName):}(pageNameList)/}(imageName)
      • pageAttach: An required string identifying the reference as an XWiki Page attachment.
      • wikiName: An optional string containing the name of a wiki. The image reference will point to an image attached to a page inside that wiki. If no wiki is specified, the current wiki is used. Example: mywiki.
      • pageNameList: An optional dot-separated list of wiki page names. If no page is specified the current page is used. Examples: Main, A/B, A/B/C
      • attachmentName: Name of the attachment as it is stored in the wiki. Example: photo.png
    • Email address: A reference in the form mailto:(emailAddress) (#anchor is not valid). Example: mailto:john@smith.com
      • mailto: A required string identifying the resource as email.
      • emailAddress: Targeted email address. Example: john@smith.com
    • Relative path: A reference on the server in the form path:(relPath). Example: path:$doc.getURL('reset') produces target address http://server.domain.com/xwiki/bin/reset/Space/Page where /xwiki/bin/reset/Space/Page is produced by $doc.getURL('reset').
      • path: A required string identifying the resource as a relative path.
      • relPath: A required string containing the relative path of the resource on the server that shall be linked.
    • UNC (Windows Explorer): A reference in the form unc:(path). The link is rendered as a file:// link. Examples: unc:C:\Windows\, unc:\\myserver\path\img.png, unc:home/user/somefile
      • unc: A required string identifying the resource as a UNC (Windows Explorer) path.
      • path: A required string containing the local path of resource accessible by the user. Examples: C:\Windows\, \\myserver\path\img.png, home/user/somefile
    • Untyped: If none of the above-mentioned resource types are specified (i.e. no type: resource prefix was specified in the link), then the link will be treated as a link to an XWiki terminal or non-terminal page using the following algorithm:
      • Terminal page in the current space, only if it exists. Example: [[A]] is resolved to the equivalent of [[doc:currentSpace.A]]
      • Non-terminal page  in the current space. Example: [[A]] is resolved to the equivalent of [[space:currentSpace.A]], which is the equivalent of [[doc:currentSpace.A.WebHome]]
      • If the current page is non-terminal and the previous 2 checks above did not find an existing page, 2 additional checks are made:
        • Terminal page as sibling in the parent space, only if it exists. Example: The [[B]] link inside the non-terminal page A.C is resolved to the equivalent of [[doc:A.B]]
        • Non-terminal page as sibling in the parent space, regardless if it exists or not. Example: The [[B]] link inside the non-terminal page A.C is resolved to the equivalent of [[space:A.B]], which is the equivalent of [[doc:A.B.WebHome]]
      • Note1 - Absolute links: If the untyped link has 2 or more dot-separated components specified (i.e. that look like a space name and a page name), the above algorithm will resolve the page relative to the current wiki, and not the current space. Example: [[A.B]] can be resolved to either [[doc:currentWiki:A.B]] (if it exists) or to [[space:currentWiki:A.B]] (equivalent of [[doc:currentWiki:A.B.WebHome]]) and not to [[doc:currentWiki:currentSpace.A.B]] or [[doc:currentWiki:currentSpace.A.B.WebHome]].
      • Note2 - Special handling of .WebHome: If the untyped link ends in .WebHome, it will always be handled as a terminal page. Example: [[A.WebHome]] will always be resolved to the equivalent of [[doc:A.WebHome]] and not to [[doc:A.WebHome.WebHome]].
  • parameters: An optional list of space-separated parameters passed to the link. Example: queryString="mydata1=5&mydata2=Hello" anchor="HTableOfContents" target="_blank"
    • queryString: An optional query string for specifying parameters that will be appended to the link target address and used in the rendered URL. Example: url:http://domain.com/path||queryString="mydata1=5&mydata2=Hello" produces target address http://domain.com/path?mydata1=5&mydata2=Hello
    • anchor: An optional anchor name pointing to an anchor defined in the referenced link. Note that in XWiki anchors are automatically created for headings and images. Example: url:http://domain.com/path||anchor="HTableOfContents" produces target address http://domain.com/path#HTableOfContents
    • target: An optional parameter that allows to open link target in new window. Example: target="_blank"

Tables

2.0 Tables

Allows to easily create content in table format. Parameters for table, row or cell are also supported in XWiki Syntax 2.1.

FeatureXWiki Syntax 2.1Result
Standard table
|=Title 1|=Title 2
|Word 1|Word 2
or
!=Title 1!=Title 2
!!Word 1!!Word 2
Title 1Title 2
Word 1Word 2
Parametrized table
(% style="background-color:red;text-align:center" %)
|=Title 1|=(% style="background-color:yellow" %)Title 2
|Word 1|Word 2
Title 1Title 2
Word 1Word 2
Filterable Sortable table
{{velocity}}
$xwiki.ssfx.use("js/xwiki/table/table.css")
$xwiki.jsfx.use("js/xwiki/table/tablefilterNsort.js", true)
{{/velocity}}

(% class="grid sortable filterable doOddEven" id="tableid" %)
(% class="sortHeader" %)|=Title 1|=Title 2
|Cell 11|Cell 12
|Cell 21|Cell 22

For improved features see the Livetable Macro.

Title 1Title 2
Cell 11Cell 12
Cell 21Cell 22

Images

2.1 Images

FeatureXWiki Syntax 2.1Result
Image from attachment on current pageimage:img.pngimg.png
Image from attachment on another pageimage:PageA.PageB@img.pngimg.png
Image with parameters[[image:img.png||width="25" height="25"]]img.png
Image with caption[[~[~[XWiki~>~>https://www.xwiki.org~]~] supports captions.>>image:img.png]]

img.png

Images located at URLimage:https://some/url/img.pngimg.png
Prepackaged Iconsimage:icon:acceptaccept

XWiki Syntax 2.1 Image Specification

Legend: The parts are () are required, while the parts in {} are optional.

The full format of an image is either image: (reference) or [[{caption>>}image: (reference) {||parameters}]]

  • caption: An optional caption. May contain arbitrary XWiki 2.1 syntax but nested link syntax must be escaped using ~. The caption is only supported when the image syntax is the only content of a paragraph.
  • image: A required string identifying the resource as image.
  • reference: The reference to the image that shall be displayed in one of the following forms:
    • URL: Any URL to an image in the form of [url:](protocol://path/imageName). Example: http://domain.org/path/img.png
      • url: An optional string identifying the image as an URL.
      • protocol://path/imageName: The URL to the image
    • Attachment: A reference in the form [attach:]{{{(wikiName):}(spaceNameList).}(pageName)@}(imageName)
      • attach: An optional string identifying the reference as an XWiki Document attachment.
      • wikiName: An optional string containing the name of a wiki. The image reference will point to an image attached to a page inside that wiki. If no wiki is specified, the current wiki is used. Example: mywiki.
      • spaceNameList: An optional dot-separated list of wiki Space names. If no space is specified the current space is used. Examples: Main, A.B, A.B.C
      • pageName: An optional string containing the name of the wiki page to which the referenced image is attached. Example: Welcome
      • imageName: A required string containing the name of the image attached to a page as it is stored in the wiki. Example: myImage.png
    • Page Attachment: A reference in the form pageAttach:{{{(wikiName):}(pageNameList)/}(imageName)
      • pageAttach: An required string identifying the reference as an XWiki Page attachment.
      • wikiName: An optional string containing the name of a wiki. The image reference will point to an image attached to a page inside that wiki. If no wiki is specified, the current wiki is used. Example: mywiki.
      • pageNameList: An optional dot-separated list of wiki page names. If no page is specified the current page is used. Examples: Main, A/B, A/B/C
      • imageName: A required string containing the name of the image attached to a page as it is stored in the wiki. Example: myImage.png
    • Icon: A reference in the form icon:(iconName). Example: icon:accept
      • icon: A required string identifying the image reference as an icon from the XWiki Icon Set.
      • iconName: A required string identifying the icon referenced. Example: accept
    • Icon: A reference in the form icon:(iconName). Example: icon:accept
      • icon: A required string identifying the image reference as an icon from the XWiki Icon Set.
      • iconName: A required string identifying the icon referenced. Example: accept
    • Data URI: A reference in the form (data:)(content). Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==
      • data: A required string identifying the image as being specified inline using the Data URI scheme.
      • content: The encoded image. Example: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==
  • parameters: An optional list of space-separated parameters passed to the image. Example: width="800" height="600" alt="img.png" title="My nice image"
    • HTML attributes: All attributes defined by the HTML standard will be added to the rendered HTML <img> tag.
      • style: CSS style information that should be applied to the image. Examples: style="float:right;height:50" (image on right side, height 50 px), style="display:block;margin-left:auto;margin-right:auto;width:80%" (image centered, width 80% of block width), style="vertical-align:bottom" (text starts at bottom of picture)
      • height: A parameter that defines the height of the displayed image. The value should be presented either in pixel (example: height="80") or in pixel related to the height of the block containing the image (example: height="40%").
      • width: A parameter that defines the width of the displayed image. The value should be presented either in pixel (example: width="80") or in pixel related to the width of the block containing the image (example: width="40%").
      • title: A parameter that defines the title the displayed image which will be visible when hovering the mouse trigger over the image, for instance. Example: title="My nice image"
      • alt: A parameter that defines which text should be displayed if the browser is not able to display the image. Since this is a required HTML attribute XWiki will use the file name instead if the alt parameter is not defined. Example: alt="img.png"
      • More: A more in depth explanation on the HTML <img> tag including more attributes can be reviewed in the HTML standard.
    • queryString: Allows queries to be passed to the server when creating the download link for the referenced image. Example: queryString="width=100&height=800&keepAspectRatio=true" (keepAspectRatio=true will fail if the width and height parameters are specified in addition to queryString!)

Advanced

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

FeatureXWiki Syntax 2.1Result
Verbatim inlineSome verbatim {{{**[[not rendered]]**}}} contentSome verbatim **[[not rendered]]** content
Verbatim block
{{{
multi line
**verbatim**
content
}}}

multi line
**verbatim**
content

Quotations

2.0 Quotations

Allows to quote some text.

FeatureXWiki Syntax 2.1Result
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.1Result
|=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 1Header 2Header 3
Cell One
Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.

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

Экранирование

2.0 Escapes

Позволяет экранировать XWiki-разметку.

ФункциональностьСинтаксис XWiki 2.1Результат
Экранирование символа

Это не ~[~[ссылка~]~]
Для ввода символа ~ используйте двойное экранирование: ~~

Это не [[ссылка]]
Экранирование длинного текста
(см. также "Verbatim")		{{{ какой-нибудь **длинный** текст //без// форматирования}}} какой-нибудь **длинный** текст //без// форматирования

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.1Generated XHTML
(% class="myClass" style="myStyle" id="myId" %)
= heading =

<h1 class="myClass" style="myStyle" id="myId">heading</h1>

Programming

Macros

2.0 Macros

There is only one kind of macro in XWiki Syntax 2.1, which is called by the syntax: {{macroname param1="value1" ... paramN="valueN"}}...{{/macroname}}. For macros without content there's a short notation: {{macroname param1="value1" ... paramN="valueN"/}}

FeatureXWiki Syntax 2.1Result
Rendering Macro with a content
{{code language="java"}}
System.out.println("Hello World!");
{{/code}}
System.out.println("Hello World!");
Rendering Macro without content

{{include reference="Space.Page"/}}

The referenced page is included in the current page

For the full list of available macros check the Extensions wiki.

Macros in this wiki

IDНазваниеКатегорияОписаниеВидимость
tocTable Of ContentsNavigationGenerates a Table Of Contents.Global
iconPickerIcon PickerDevelopmentSelect an icon within the XWiki icon set.Текущая Вики
formulaFormulaContentDisplays a mathematical formula.Global
wikimacrocontentWikiMacro ContentDevelopmentDisplay editable content of a wikimacro.Global
exampleExampleFormattingShows an example and its source code.Текущая Вики
mentionUser MentionNotificationsInserts a user mention.Текущая Вики
asyncAsyncContentAsynchronous and cached execution of wiki content.Global
spaceindexSpace IndexDeprecatedLists documents in a space.Текущая Вики
boxBoxFormattingDraw a box around provided content.Global
spacesSpacesDeprecatedDisplays all the spaces in this wiki.Текущая Вики
errorError MessageFormattingDisplays an error message note.Global
warningWarning MessageFormattingDisplays a warning message note.Global
messageSenderMessage SenderSocialA control that allows users to enter messages that are handled by the MessageStream module.Текущая Вики
childrenChildrenNavigationDisplays a tree of children pages of the current pageТекущая Вики
workspacesWorkspacesDeprecatedDeprecated macro that should not be used, here for compatibility reason. Please use the "wikis" macro instead.Текущая Вики
displayDisplayContentDisplay other pages into the current page.Global
translationTranslationContentDisplay a translation message.Global
contextContextDevelopmentExecutes content in the context of the passed documentGlobal
infoInfo MessageFormattingDisplays an info message note.Global
treeTreeNavigationDisplays a tree hierarchy defined by the macro content or the source parameter.Текущая Вики
liveDataLive DataContentDisplay dynamic lists of data.Global
rssRSSContentOutput latest feed entries from a RSS feed.Global
successSuccess MessageFormattingDisplays a success message note.Global
documentTreeDocument TreeNavigationDisplays the tree of XWiki documents.Текущая Вики
templateTemplateDevelopmentInsert a template.Global
notificationsAutoWatchPreferencesNotifications Auto Watch PreferencesNotificationsТекущая Вики
chartChartContentDisplays a graphical chart generated from miscellaneous data sourcesGlobal
containerContainerLayoutA macro to enclose multiple groups and add decoration, such as layout.Global
notificationsEmailPreferencesNotifications Email PreferencesNotificationsDisplay the preferences of the current user about notification emails.Текущая Вики
tagcloudTag CloudContentDisplays the cloud of tags in this wiki or in the specified space, if any.Текущая Вики
activityActivity (legacy)NotificationsProvide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream.Текущая Вики
pythonPythonDevelopmentExecutes a python script.Global
commentCommentDevelopmentAllows putting comments in the source content. This macro doesn't output anything.Global
htmlHTMLDevelopmentInserts HTML or XHTML code into the page.Global
contentContentContentAllows writing content in any wiki markupGlobal
scriptScriptDevelopmentExecute script in provided script language.Global
useravatarUser AvatarContentAllows displaying the avatar for a specific user.Global
officeOffice Document ViewerContentView office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them.Global
galleryGalleryLayoutDisplays the images found in the provided content using a slide-show view.Global
notificationsSystemFiltersPreferencesNotifications System Filters PreferencesNotificationsDisplay the preferences of the given user about system notification filters.Текущая Вики
dashboardDashboardLayoutA macro to define a dashboard.Global
putFootnotesPut FootnoteContentDisplays the footnotes defined so far. If missing, all footnotes are displayed by default at the end of the page.Global
wikisWikisNavigationList all wikisТекущая Вики
attachmentSelectorAttachment SelectorDevelopmentA control to be used for object properties of the current document that are supposed to contain the name of an attachment from the current (or target) document. Allows uploading new attachments, and deleting attachments from the target document.  If no target document is specified, the current document will be used. Object properties are only saved to the current document.Текущая Вики
notificationsApplicationsPreferencesNotifications Applications PreferencesNotificationsDisplay the preferences of the current user about notification applications.Текущая Вики
cacheCacheDevelopmentCaches content.Global
menuMenuNavigationDisplays a menu created using simple wiki syntax (nested lists and links).Глобально
notificationsCustomFiltersPreferencesNotifications Custom Filters PreferencesNotificationsDisplay the preferences of the given user about custom notification filters.Текущая Вики
documentsDocumentsContentDisplays a list of documents in a LivetableТекущая Вики
notificationsFiltersPreferencesNotifications Filters Preferences (deprecated)NotificationsDisplay the preferences of the current user about notification filters.
This macro is now deprecated in favor of Custom Notifications Filters Preferences or System Notifications Filters Preferences.		Текущая Вики
notificationsNotificationsNotificationsТекущая Вики
velocityVelocityDevelopmentExecutes a Velocity script.Global
wikimacroparameterWikiMacro ParameterDevelopmentDisplay editable parameter of a wikimacro.Global
groovyGroovyDevelopmentExecute a groovy script.Global
footnoteFootnoteContentGenerates a footnote to display at the end of the page.Global
codeCodeFormattingHighlights code snippets of various programming languagesGlobal
idIdNavigationAllows putting a reference/location in a page. In HTML for example this is called an Anchor. It allows pointing to that location, for example in links.Global
includeIncludeContentInclude other pages into the current page.Global

HTML

2.0 HTML

In XWiki Syntax 2.1 HTML or XHTML must be entered by using the HTML macro.

XWiki Syntax 2.1Result
{{html}}<abbr title="HyperText Markup Language">HTML</abbr>{{/html}} Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.

Scripts

2.0 Scripts

XWiki supports several scripting languages.

FeatureXWiki Syntax 2.1
Velocity script
{{velocity}}
#set ($var = "whatever")
{{/velocity}}
Groovy script
{{groovy}}
def var = "whatever"
{{/groovy}}
Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
    
Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.
Failed to execute the [html] macro. Cause: [/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/solr-solrj-8.8.0.jar]. Click on this message for details.