XWiki Syntax Guide

Редактировал(а) superadmin 2023/07/27 06:32

XWiki Syntax 2.1

XWiki Syntax 2.1: All

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

Заголовки

2.0 Headings

ФункциональностьСинтаксис XWiki 2.1Результат
Стандартные заголовки
= уровень 1 =
== уровень 2 ==
=== уровень 3 ===
==== уровень 4 ====
===== уровень 5 =====
====== уровень 6 ======

уровень 1

уровень 2

уровень 3

уровень 4

уровень 5
уровень 6
Параметризованные заголовки(% style="color:blue" %)= заголовок=

заголовок

Заголовки с синтаксисом XWiki=== Заголовок с **полужирным** ===

Заголовок с полужирным

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

XWiki supports captions.

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. The captioned image may also be wrapped in a link. In this case, the link will contain the image but not the caption.
  • 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
    • 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

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

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

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НазваниеКатегорииОписаниеВидимость
activityАктивностьNotificationsМакрос Активность предоставляет информацию о последней активности пользователей XWiki. Перечисляет события создания, редактирования и удаления страниц, а также добавления комментариев, вложений и аннотаций.Текущая Вики
asyncАсинхронный макросСодержимоеВыполнить асинхронно и / или кэшировать содержимое макроса.Глобально
attachmentGalleryPickerСредство выбора вложенийРазработкаСредство выбора вложений на основе сетки.Глобально
attachmentSelectorВыбор вложенных файловРазработкаЭлемент управления свойствами объекта текущей страницы, в которой содержатся имена вложенных файлов текущей (или целевой) страницы. Позволяет загружать новые вложения и удалять существующие с целевой страницы. Если целевая страница не указана, то используется текущая. Свойства объекта сохраняются только для текущей страницы.Текущая Вики
blockblockBlocks to display linksГлобально
blogpostcreateBlog Post CreateThe Blog Post Create macro is used to insert a post creation form. The macro takes a blog descriptor document as parameter. The new blog posts will belongs to the blog specified in the parameter.Текущая Вики
blogPostLayoutCardsCards Blog Post LayoutThis macro is used to display a blog post using the 'Cards' layoutТекущая Вики
blogPostLayoutCompactBlog Post Layout CompactThis macro is used to display a full blog post in a compact modeТекущая Вики
blogPostLayoutFullBlog Post Layout FullThis macro is used to display a full blog postТекущая Вики
blogPostLayoutImageBlog Post Layout ImageThis macro is used to display a full blog post with a thumbnail imageТекущая Вики
blogPostLayoutLinkBlog Post Layout LinkThis macro is used to display a blog post as a simple linkТекущая Вики
blogpostlistBlog post listThe BlogPostMacro is used to search and display blog posts based on some parameters, the results can be displayed using customizable templates.Текущая Вики
blogsСписок всех блоговМакрос блогов используется для того, чтобы перечислять в реальном времени все блоги, доступные в вики.Текущая Вики
boxокноФорматированиеПоказать блок вокруг.Глобально
cacheКэшРазработкаКэширует контент.Глобально
calccalcsalesCALC MacroГлобально
chartГрафикСодержимоеПоказывает график полученный из различных источников данныхГлобально
childrenChildrenНавигацияDisplays a tree of children pages of the current pageТекущая Вики
cl-plate-adviceТабличка "Полезный совет"таблички, ИнформационныеОтображает табличку с полезным советомГлобально
cl-plate-helpТабличка "Информация о поддержке"Отображает табличку с информацией о способах обращения в поддержку.
Такие плашки удобно ставить на страницах с инструкциями по использованию системы.
Глобально
cl-plate-infoТабличка "Информация о разделе"Отображает табличку с информацией о текущей странице или разделе.Глобально
cl-plate-moderatorТабличка "Редактируется модератором"Элементы содержанияОтображает табличку с предупреждением о том, что страница редактируется модератором.Глобально
cl-plate-objectТабличка "Внимание объекты"Элементы содержанияОтображает табличку с предупреждением о наличии на странице скрытых объектов.Глобально
cl-plate-todoТабличка "TODO"Элементы содержанияОтображает табличку с предупреждением о том, что страница требует доработки в дальнейшем.

Такие плашки удобно ставить на странице который находятся в стадии активной проработки как сигнал другим пользователям о том, что контент на странице может в скором времени измениться.
Глобально
codeКодФорматированиеПодсвеченные части кода различных языков программированияГлобально
colunsMacroHideExtraСкрыть раздел информации о страницеColuns, Форматирование, АдминистрированиеДанный макрос скрывает нижнюю часть документа с вкладками Комментарии, Вложения, История, Информация о странице если текущий пользователь не Администратор.
Также скрываются ярлыки из меню страницы, которые позволяют увидеть данную информацию.
Текущая Вики
commentКомментарийРазработкаПозволяет вставлять комментарии в контент. Этот макрос ничего не выводит в текст страницы.Глобально
containerКонтейнерМакетМакрос для объединения нескольких групп и добавления декораций, как на выходе.Глобально
contentСодержимоеСодержимоеПозволяет создавать контент в любой вики-разметкеГлобально
contextКонтекстРазработкаИсполняет содержимое в контексте переданных документовГлобально
dashboardПанель управленияМакетМакрос для заполнения главной панели гаджетами.Глобально
diagramDiagramСодержимоеDisplays a diagram.Текущая Вики
displayПоказать страницуСодержимоеПоказать другие страницы в текущей.Глобально
displayIconIconСодержимоеDisplay an icon.Глобально
documentsСтраницыСодержимоеПоказывает список страниц в таблице LivetableТекущая Вики
documentTreeДерево страницНавигацияОтображает дерево страниц XWiki.Текущая Вики
errorСообщение об ошибкеФорматированиеПоказать сообщение об ошибке.Глобально
exampleExampleФорматированиеShows an example and its source code.Текущая Вики
footnoteСноскаСодержимоеГенерирует сноску внизу страницы.Глобально
galleryГалереяМакетПоказать изображения, найденные в указанном контенте в режиме слайд-шоу.Глобально
glossaryEntriesglossaryEntriesНавигацияLists all glossary entries from a glossary, as a listГлобально
glossaryReferenceGlossaryReferenceНавигацияReferences a glossary entryГлобально
groovyGroovyРазработкаВыполнить groovy-скрипт.Глобально
htmlHTMLРазработкаВставить HTML или XHTML-код на страницу.Глобально
iconFont Awesome iconIconsInserts a Font Awesome iconТекущая Вики
iconPickerIcon PickerРазработкаВыберите значок в наборе значков XWiki.Текущая Вики
idIDНавигацияПозволяет положить ссылку/расположение на страницу. Например, в HTML это называется якорями. Это позволяет указать расположение, например, в ссылках.Глобально
includeВключитьСодержимоеВключить другие страницы в текущую.Глобально
infoИнформационное сообщениеФорматированиеПоказать информационное сообщение.Глобально
jwplayerJW PlayerСодержимоеJW Player - это встраиваемый медиаплеер с открытым исходным кодом для веб-сайтов, поддерживающий многие распространенные аудио и видео форматы.Текущая Вики
liveDataЖивые данныеСодержимоеОтображает динамические списки данных.Глобально
mentionУпоминание ПользователяNotificationsВставьте упоминание пользователя.Текущая Вики
menuМенюНавигацияОтображает меню, созданное с использованием простого синтаксиса вики (вложенные списки и ссылки).Глобально
messageSenderОтправитель сообщенияSocialЭлемент управления, который позволяет пользователям вводить сообщения, которые обрабатываются модулем Лента активности(MessageStream).Текущая Вики
notificationsУведомленияNotificationsОтображать уведомления о событиях, произошедших в вики.Текущая Вики
notificationsApplicationsPreferencesНастройки Приложений УведомленийNotificationsОтображение предпочтений текущего пользователя в отношении приложений уведомлений.Текущая Вики
notificationsAutoWatchPreferencesНастройки уведомлений АвтонаблюденияNotificationsОтображение предпочтений текущего пользователя в отношении Автонаблюдения за страницами.Текущая Вики
notificationsCustomFiltersPreferencesNotifications Custom Filters PreferencesNotificationsDisplay the preferences of the given user about custom notification filters.Текущая Вики
notificationsEmailPreferencesNotifications Email PreferencesNotificationsDisplay the preferences of the current user about notification emails.Текущая Вики
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.
Текущая Вики
notificationsSystemFiltersPreferencesNotifications System Filters PreferencesNotificationsDisplay the preferences of the given user about system notification filters.Текущая Вики
officeПросмотрщик документов OfficeСодержимоеПросмотреть вложения Office(doc, ppt, xls, odt, odp, ods и т.д.) внутри wiki-страниц, без скачивания и импортирования.Глобально
pdfPDF Object EmbedThis macro allows embedding a PDF file in a wiki page using the <object> tag.Глобально
pdftocPDF Table of ContentsВнутреннийGenerates the table of contents for the PDF export.Глобально
pdfviewerpdfviewercontentPDF Viewer based on Mozilla pdf.jsТекущая Вики
putFootnotesВставить сноскиСодержимоеОтображать все сноски на странице. Если они отсутствуют, по умолчанию все сноски отображаются в конце страницы.Глобально
pythonPythonРазработкаВыполнить python-скрипт.Глобально
redmineRedmine TicketListet Tickets vom Redmine Ticketsystem in einer Tabelle auf.Глобально
rssRSSСодержимоеВывести последние записи из RSS-потока.Глобально
scriptСкриптРазработкаИсполнить скрипт в соответствующем интерпретаторе языка.Глобально
sortable_tablesSorteable TablesMakes all tables in the content of the current page sortable.Текущая Вики
spaceindexСтраницы разделаУстаревшиеСписок страниц в разделе.Текущая Вики
successСообщение об успешном событииФорматированиеВыводит сообщение об успешном завершении.Глобально
sumsumsalesSUM MacroГлобально
summarysummarysalesSummary MacroГлобально
tabsTabbed view rendererCreates tabbed view for content areas wrapped into <div /> with unique id (see macro home for details)Текущая Вики
tagcloudОблако теговСодержимоеОтображать облако тегов для этой вики или указанного раздела, если имеется.Текущая Вики
templateШаблонРазработкаВставить шаблон.Глобально
tocСодержаниеНавигацияГенерирует "Содержание".Глобально
tooltipTooltipТекущая Вики
translationПереводСодержимоеОтобразить перевод сообщения.Глобально
treeДеревоНавигацияОтображает древовидную иерархию, определенную содержимым макроса или параметром источника.Текущая Вики
uiextensionРасширение UIРазработкаВставить расширение UI.Глобально
uiextensionsРасширения UIРазработкаВставить UI расширения.Глобально
useravatarАватар пользователяСодержимоеРазрешить показывать аватар для определенного пользователя.Глобально
velocityVelocityРазработкаИсполняет Velocity-скрипт.Глобально
warningПредупреждениеФорматированиеПоказывает предупреждение.Глобально
wikimacrocontentWikiMacro ContentРазработкаDisplay editable content of a wikimacro.Глобально
wikimacroparameterWikiMacro ParameterРазработкаDisplay editable parameter of a wikimacro.Глобально

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

Scripts

2.0 Scripts

FeatureXWiki Syntax 2.1
Velocity script
{{velocity}}
#set ($var = "whatever")
{{/velocity}}
Groovy script
{{groovy}}
def var = "whatever"
{{/groovy}}