Skip to Content

XWiki Syntax Guide

Última modificação por Infraestrutura em 2025/12/04 12:21

XWiki Syntax 2.0

XWiki Syntax 2.0: All

General

Introduction

2.0 Introduction

Starting with XWiki 1.7 we've introduced a new wiki syntax. We've named the old syntax the XWiki Syntax 1.0 and the new syntax was logically called the XWiki Syntax 2.0. The main reasons for introducing the new syntax were:

  • Fix the limitations and ambiguities of the XWiki 1.0 syntax (which was inspired by both Radeox - the underlying rendering engine - and TWiki).
    • Not optimal symbols. For example the symbol for bold was single stars. This was causing trouble when users were entering text containing stars since that text was mistakenly considered to be bold when it wasn't. Hence we've rationalized the syntax by using at least double characters everywhere. 
    • Ambiguities. For example there was an ambiguity between a bold item starting a line and a bullet list. Resolving the ambiguities was required in order to rewrite the WYSIWYG editor so that it could be deterministic.
  • Be closer to the Creole 1.0 syntax which is becoming a standard for wiki syntax. In addition the Creole community has taken the time to analyze all the existing wiki syntaxes before deciding on symbols. The choices made are thus very good.

In addition to these XWiki-specific syntaxes we've also changed our underlying rendering engine (was Radeox previously) in favor of our own engine which is superset wrapper around Wikimodel and Doxia (and possibly others in the future). This has allowed us to provide other syntaxes in the wiki: MediaWiki, Confluence, JSPWiki, Creole, TWiki and more.

General Remarks

2.0 General Remarks

XWiki Syntax 2.0 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.0
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

Failed to execute the [include] macro. Cause: [Cannot find section [H2.0OtherSyntaxes] in document [xwiki:XWiki.XWikiSyntaxOtherSyntaxes]]. Click on this message for details.

Editing

Paragraphs

2.0 Paragraphs

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

FeatureXWiki Syntax 2.0Result
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.0Result
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

Formatação de texto

Failed to execute the [include] macro. Cause: [Cannot find section [H2.0TextFormatting] in document [xwiki:XWiki.XWikiSyntaxTextFormatting]]. Click on this message for details.

Horizontal Line

2.0 Horizontal Line

Information

There must be 4 or more dashes.

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

Lists

2.0 Lists

Information

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

FeatureXWiki Syntax 2.0Result
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

Definition Lists

2.0 Definition Lists

FeatureXWiki Syntax 2.0Result
Standard definition
; term
: definition
term
definition
Nested definitions
; term 1
: definition 1
:; term 2
:: definition 2
term 1
definition 1
term 2
definition 2
Parametrized definition
(% style="color:blue" %)
; term
: definition
term
definition

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.0Result
Line breakLine\\New lineLine
New line
New lineLine
New line		Line
New line
FeatureXWiki Syntax 2.0Result
Link to a page in the current Space[[WebHome]]XWiki
Link with a label

[[label>>WebHome]]
InformationXWiki Syntax is supported inside link labels.

label
Link with XWiki Syntax in the label[[**bold label**>>WebHome]]bold label
Link to a page with the space specified[[Main.WebHome]]Main
Link to a subwiki[[subwiki:Main.WebHome]]Main
Link that opens in a new window[[label>>WebHome||target="_blank"]]label
Link to a URL directly in the textThis is a URL: https://xwiki.orgThis is a URL: https://xwiki.org
Link to a URL[[https://xwiki.org]]https://xwiki.org
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
Image Link[[image:Space2.Page2@img.png>>Space1.Page1]]img.png
Image Link with image parameters[[[[image:Space2.Page2@img.png||width="26" height="26"]]>>Space1.Page1]]img.png
Link to an attachment on the current page[[text>>attach:img.png]]text
Link to an attachment in a different page[[text>>attach:Space.Page@img.png]]text
Link to an Anchor in a page[[label>>Space.Page#anchor]]label
Link to a Heading in a page[[label>>Space.Page#HMyheading]]label
Link to an Anchor in the current page[[label>>#anchor]]label
Information

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

XWiki Syntax 2.0 Link Specification

Information

The part in ( ) is required, while the parts in [ ] are optional.

The full format of a link is [label>>] (resource) [@interWikiAlias] [||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: The full link reference using the following syntax: (reference) [?queryString] [#anchor]
    • reference: The link reference in one of the following forms:
      • URL: Any URL in the form of protocol://path. Examples: http://xwiki.org, https://svn.xwiki.org/
      • Wiki page reference in the form [[wikiName:] spaceNameList.] (pageName). Examples: WebHome, Main.WebHome, mywiki:Main.WebHome
        • wikiName: An optional string containing the name of a wiki. The link will point to a page inside that wiki. 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: A required string containing the name of the linked wiki page. Example: WebHome
      • Attachment reference in the form attach: [wikiPageName@] (attachmentName). Examples: attach:img.png, attach:mywiki:Main.WebHome@img.png
        • attach: A required string identifying the resource as attachment.
        • wikiPageName: An optional string referencing the page that holds the attachment, see "Wiki page" above.
        • attachmentName: Name of the attachment as it is stored in the wiki.
      • Email address 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"
    • queryString: An optional query string for specifying parameters that will be used in the rendered URL. Example: 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: HTableOfContents
  • interWikiAlias: An optional Inter Wiki alias as defined in the InterWiki Map (see the Admin Guide). This is only valid for wiki page names. Example: wikipedia
  • parameters: An optional list of parameters passed to the link. Example: target="_blank" (open in new window)

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

FeatureXWiki Syntax 2.0Result
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
Information

For improved features see the LiveData Macro.

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

Images

2.0 Images

FeatureXWiki Syntax 2.0Result
Image from attachment on current pageimage:img.pngimg.png
Image from attachment on another pageimage:Space.Page@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

XWiki Syntax 2.0 Image Specification

Information

The part in ( ) is 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.0 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 http://path/imageName. Example: http://domain.org/path/img.png
    • Attachment reference in the form {{{wikiName:} space.} page@} (imageName)
      • 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. Example: mywiki
      • space: An optional wiki Space name. If no space is specified the current space is used. Example: Main
      • page: An optional string containing the name of the wiki page to which the referenced image is attached. Example: WebHome
      • imageName: A required string containing the name of the image attached to a page as it is stored in the wiki.
  • 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.

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.0Result
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.0Result
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.0Result
|=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

Escapes

2.0 Escapes

Allows to escape XWiki Syntax.

FeatureXWiki Syntax 2.0Result
Escape a character

This is not a ~[~[link~]~]
InformationTo 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.0 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.0Generated 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.0, 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.0Result
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
Information

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

Macros in this wiki

IdNameCategoriasDescriptionVisibilidade
activityFluxo de AtividadeNotificationsInforma sobre o fluxo de atividades recentes dos usuários da wiki atual. Lista os eventos criar, editar e remover de páginas, comentários, anexos e anotações.Current Wiki
asyncMacro assíncronaConteúdoExecute de forma assíncrona e/ou armazene em cache o conteúdo da macro.Global
attachmentGalleryPickerAttachment PickerDesenvolvimentoGrid based attachment picker.Global
attachmentSelectorSelecionador de AnexosDesenvolvimentoUm controle a ser usado por propriedades de objetos do documento atual que deveriam conter o nome de um anexo de um documento destino. Permite subir novos anexos ou removê-los do documento destino. Se nenhum documento destino for informado, o documento atual será usado. As propriedades dos objetos, no entanto, são salvas somente no documento atual.Current Wiki
boxCaixaFormataçãoDesenha uma caixa em volta de qualquer conteúdo.Global
cacheCacheDesenvolvimentoFaz cache de conteúdo.Global
chartGráficoConteúdoPermite exibir uma gráfico gerado de diversas fontes de dadosGlobal
childrenChildrenNavegaçãoDisplays a tree of children pages of the current pageCurrent Wiki
codeCódigoFormataçãoRealça pedaços de código de várias linguagens de programaçãoGlobal
commentComentárioDesenvolvimentoPermite inserir comentários no fonte do conteúdo. Essa macro não exibe nada.Global
containerContainerDisposiçãoUma macro para englobar múltiplos grupos e adicionar elementos decorativos.Global
contentContentConteúdoAllows writing content in any wiki markupGlobal
contextContextoDesenvolvimentoExecuta um documento no contexto de outro documento informadoGlobal
dashboardPainel de ControleDisposiçãoUma macro para definir um painel principal a ser preenchido como outros painéis.Global
displayExibir PáginaConteúdoExibir outras páginas na página atual.Global
displayIconIconConteúdoDisplay an icon.Global
documentsDocumentosConteúdoMostra uma lista de documentos em uma tabela dinâmicaCurrent Wiki
documentTreePage TreeNavegaçãoDisplays the tree of XWiki pages.Current Wiki
errorMensagem de ErroFormataçãoMostar uma mensagem de erro.Global
exampleExampleFormataçãoShows an example and its source code.Current Wiki
footnoteRodapéConteúdoGera nota de rodapé para exibir no final da página.Global
galleryGaleriaDisposiçãoMostra as imagens encontradas em determinado conteúdo usando visualização de slides.Global
groovyGroovyDesenvolvimentoExecutar um script Groovy.Global
htmlHTMLDesenvolvimentoInsere código HTML ou XHTML na página.Global
iconPickerIcon PickerDesenvolvimentoSelect an icon within the XWiki icon set.Current Wiki
idIdNavegaçãoPermite colocar uma referência/localização numa página. Em HTML por exemplo isso é chamado âncora. Permite apontar para aquela localização em links por exemplo.Global
includeIncluir PáginaConteúdoInsere outras páginas na página atual.Global
infoMensagem de InformaçãoFormataçãoExibe uma mensagem de informação.Global
liveDataLive DataConteúdoDisplay dynamic lists of data.Global
mentionUser MentionNotificationsInsert a user mention.Current Wiki
menuMenuNavegaçãoExibe um menu criado usando sintaxe wiki simples (listas e links aninhados).Global
missingLicenseMessageMissing License MessageInternoDisplay an error message when the extension does not have a valid license.Global
notificationsNotificationsNotificationsDisplay notifications about events happened on the wiki.Current Wiki
notificationsApplicationsPreferencesPreferências de Aplicações de NotificaçõesNotificationsExibe as preferências do usuário atual sobre as aplicações de notificações.Current Wiki
notificationsAutoWatchPreferencesPreferências de Monitoramento Automático de NotificaçõesNotificationsExibe as preferências do usuário atual sobre páginas monitoradas automaticamente.Current Wiki
notificationsCustomFiltersPreferencesNotifications Custom Filters PreferencesNotificationsDisplay the preferences of the given user about custom notification filters.Current Wiki
notificationsEmailPreferencesNotifications Email PreferencesNotificationsDisplay the preferences of the current user about notification emails.Current Wiki
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.		Current Wiki
notificationsSystemFiltersPreferencesNotifications System Filters PreferencesNotificationsDisplay the preferences of the given user about system notification filters.Current Wiki
officevisualizador de Documentos OfficeConteúdoVisualiza documentos office anexos (doc, ppt, xls, odt, odp, ods etc.) nas páginas da wiki sem precisar baixar ou importar os documentos.Global
pdftocPDF Table of ContentsInternoGenerates the table of contents for the PDF export.Global
putFootnotesColoque notas de rodapéConteúdoExibe todas as notas de rodapé da página. Se estiverem ausentes, todas as notas de rodapé serão exibidas por padrão no final da página.Global
pythonPythonDesenvolvimentoExecutar um script Python.Global
scriptScriptDesenvolvimentoExecuta um script na linguagem informada.Global
successMensagem de SucessoFormataçãoExibe uma mensagem de sucesso.Global
tagcloudNuvem de MarcadoresConteúdoMostrar nuvem de marcadores da wiki atual ou de um espaço informado, se os marcadores existirem.Current Wiki
templateTemplateDesenvolvimentoInsert a template.Global
tocÍndiceNavegaçãoGerar Índice no documento.Global
translationTranslationConteúdoDisplay a translation message.Global
treeTreeNavegaçãoDisplays a tree hierarchy defined by the macro content or the source parameter.Current Wiki
uiextensionUI ExtensionDesenvolvimentoInsert a UI extension.Global
uiextensionsUI ExtensionsDesenvolvimentoInsert UI extensions.Global
useravatarAvatar de UsuárioConteúdoPermite exibir o avatar de um determinado usuário.Global
velocityVelocityDesenvolvimentoExecuta um script Velocity.Global
warningMensagem de AvisoFormataçãoExibe uma mensagem de aviso.Global
wikimacrocontentWikiMacro ContentDesenvolvimentoDisplay editable content of a wikimacro.Global
wikimacroparameterWikiMacro ParameterDesenvolvimentoDisplay editable parameter of a wikimacro.Global
wikisWikisNavegaçãoListar todas as wikisCurrent Wiki
workspacesEspaços de trabalho (Legado)DescontinuadoMacro obsoleta que não deve ser usada aqui por motivos de compatibilidade. Em vez disso, use a macro "wikis".Current Wiki

HTML

2.0 HTML

Information

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

XWiki Syntax 2.0Result
{{html}}<abbr title="HyperText Markup Language">HTML</abbr>{{/html}} HTML

Roteiros

Failed to execute the [include] macro. Cause: [Cannot find section [H2.0Scripts] in document [xwiki:XWiki.XWikiSyntaxScripts]]. Click on this message for details.