XWiki - XWiki Syntax Guide 

Page / - Изменено Андрей Калиновский в 2022/04/28 13:59 

XWiki Syntax Guide 
Изменено Андрей Калиновский
в 2022/04/28 13:59

Оглавление
XWiki Syntax 2.1: Macros

XWiki Syntax 2.1  
XWiki Syntax 2.1 » Programming » Macros
XWiki Syntax 2.1: Macros
•	General
•	Introduction
•	General Remarks
•	Other Syntaxes
•	Editing
•	Paragraphs
•	Headings
•	Text Formatting
•	Horizontal Line
•	Lists
•	Списки определений
•	New Line/Line Breaks
•	Links
•	Tables
•	Images
•	Advanced
•	Verbatim
•	Quotations
•	Groups
•	Экранирование
•	Parameters
•	Programming
•	Macros
•	HTML
•	Scripts

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"/}}
Feature | XWiki Syntax 2.1 | Result

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 | Название | Категория | Описание | Видимость
toc | Table Of Contents | Navigation | Generates a Table Of Contents. | Global
iconPicker | Icon Picker | Development | Select an icon within the XWiki icon set. | Текущая Вики
formula | Formula | Content | Displays a mathematical formula. | Global
wikimacrocontent | WikiMacro Content | Development | Display editable content of a wikimacro. | Global
mention | User Mention | Notifications | Inserts a user mention. | Текущая Вики
example | Example | Formatting | Shows an example and its source code. | Текущая Вики
async | Async | Content | Asynchronous and cached execution of wiki content. | Global
spaceindex | Space Index | Deprecated | Lists documents in a space. | Текущая Вики
box | Box | Formatting | Draw a box around provided content. | Global
spaces | Spaces | Deprecated | Displays all the spaces in this wiki. | Текущая Вики
error | Error Message | Formatting | Displays an error message note. | Global
video | Video | Content | Display in your wiki page any video from Youtube, Dailymotion, Google Video or Vimeo. |
Also play a video attached to your wiki page using Video.js library. mp4, webm and ogv formats are supported.
The video macro can also plays a DASH video (Dynamic Adaptive Streaming over HTTP).|Текущая Вики
warning | Warning Message | Formatting | Displays a warning message note. | Global
block | block | | Blocks to display links | Глобально
messageSender | Message Sender | Social | A control that allows users to enter messages that are handled by the MessageStream module. | Текущая Вики
children | Children | Navigation | Displays a tree of children pages of the current page | Текущая Вики
workspaces | Workspaces | Deprecated | Deprecated macro that should not be used, here for compatibility reason. Please use the "wikis" macro instead. | Текущая Вики
display | Display | Content | Display other pages into the current page. | Global
translation | Translation | Content | Display a translation message. | Global
context | Context | Development | Executes content in the context of the passed document | Global
info | Info Message | Formatting | Displays an info message note. | Global
tree | Tree | Navigation | Displays a tree hierarchy defined by the macro content or the source parameter. | Текущая Вики
liveData | Live Data | Content | Display dynamic lists of data. | Global
rss | RSS | Content | Output latest feed entries from a RSS feed. | Global
success | Success Message | Formatting | Displays a success message note. | Global
documentTree | Document Tree | Navigation | Displays the tree of XWiki documents. | Текущая Вики
template | Template | Development | Insert a template. | Global
notificationsAutoWatchPreferences | Notifications Auto Watch Preferences | Notifications | | Текущая Вики
chart | Chart | Content | Displays a graphical chart generated from miscellaneous data sources | Global
container | Container | Layout | A macro to enclose multiple groups and add decoration, such as layout. | Global
notificationsEmailPreferences | Notifications Email Preferences | Notifications | Display the preferences of the current user about notification emails. | Текущая Вики
tagcloud | Tag Cloud | Content | Displays the cloud of tags in this wiki or in the specified space, if any. | Текущая Вики
activity | Activity (legacy) | Notifications | Provide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream. | Текущая Вики
python | Python | Development | Executes a python script. | Global
comment | Comment | Development | Allows putting comments in the source content. This macro doesn't output anything. | Global
html | HTML | Development | Inserts HTML or XHTML code into the page. | Global
content | Content | Content | Allows writing content in any wiki markup | Global
script | Script | Development | Execute script in provided script language. | Global
useravatar | User Avatar | Content | Allows displaying the avatar for a specific user. | Global
office | Office Document Viewer | Content | View office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them. | Global
gallery | Gallery | Layout | Displays the images found in the provided content using a slide-show view. | Global
notificationsSystemFiltersPreferences | Notifications System Filters Preferences | Notifications | Display the preferences of the given user about system notification filters. | Текущая Вики
dashboard | Dashboard | Layout | A macro to define a dashboard. | Global
putFootnotes | Put Footnote | Content | Displays the footnotes defined so far. If missing, all footnotes are displayed by default at the end of the page. | Global
wikis | Wikis | Navigation | List all wikis | Текущая Вики
attachmentSelector | Attachment Selector | Development | A 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. | Текущая Вики
notificationsApplicationsPreferences | Notifications Applications Preferences | Notifications | Display the preferences of the current user about notification applications. | Текущая Вики
cache | Cache | Development | Caches content. | Global
menu | Menu | Navigation | Displays a menu created using simple wiki syntax (nested lists and links). | Глобально
notificationsCustomFiltersPreferences | Notifications Custom Filters Preferences | Notifications | Display the preferences of the given user about custom notification filters. | Текущая Вики
documents | Documents | Content | Displays a list of documents in a Livetable | Текущая Вики

notificationsFiltersPreferences

Notifications Filters Preferences (deprecated)

Notifications

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

Текущая Вики

notifications | Notifications | Notifications | | Текущая Вики
velocity | Velocity | Development | Executes a Velocity script. | Global
wikimacroparameter | WikiMacro Parameter | Development | Display editable parameter of a wikimacro. | Global
groovy | Groovy | Development | Execute a groovy script. | Global
footnote | Footnote | Content | Generates a footnote to display at the end of the page. | Global
code | Code | Formatting | Highlights code snippets of various programming languages | Global
id | Id | Navigation | Allows 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
include | Include | Content | Include other pages into the current page. | Global