XWiki Syntax Guide

由 etou amane 于 2024/10/06 08:36 最后修改

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

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	名称	Categories	描述	可见性
activity	Activity (legacy)	Notifications	Provide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream.	在当前维基可见
async	异步宏	内容	异步执行和/或缓存宏内容。	对本服务器上的所有维基可见
attachmentGalleryPicker	Attachment Picker	开发	Grid based attachment picker.	对本服务器上的所有维基可见
attachmentSelector	Attachment Selector	开发	A control to be used for object properties of the current page that are supposed to contain the name of an attachment from the current (or target) page. Allows uploading new attachments, and deleting attachments from the target page. If no target page is specified, the current page will be used. Object properties are only saved to the current page.	在当前维基可见
box	盒子	格式化	在内容周围绘制一个盒子。	对本服务器上的所有维基可见
cache	Cache	开发	Caches content.	对本服务器上的所有维基可见
chart	数据图表	内容	从各种数据源生成图表	对本服务器上的所有维基可见
children	Children	导航	Displays a tree of children pages of the current page	在当前维基可见
code	代码	格式化	为多种程序语言代码片段提供语法高亮	对本服务器上的所有维基可见
comment	Comment	开发	Allows putting comments in the source content. This macro doesn't output anything.	对本服务器上的所有维基可见
container	容器	布局	用于包围多个分组并添加装饰，例如布局。	对本服务器上的所有维基可见
content	内容	内容	允许在已标记的wiki编辑内容	对本服务器上的所有维基可见
context	上下文	开发	在指定的页面上下文中执行内容	对本服务器上的所有维基可见
dashboard	Dashboard	布局	A macro to define a dashboard to fill with gadgets.	对本服务器上的所有维基可见
display	显示	内容	显示其他页面到当前页面。	对本服务器上的所有维基可见
displayIcon	Icon	内容	Display an icon.	对本服务器上的所有维基可见
documents	Pages	内容	Displays a list of pages in a Livetable	在当前维基可见
documentTree	页面树	导航	显示XWiki页面树。	在当前维基可见
drive	Google Drive Macro	content	Google Drive Macro	对本服务器上的所有维基可见
error	错误消息	格式化	显示一个错误消息。	对本服务器上的所有维基可见
example	Example	格式化	Shows an example and its source code.	在当前维基可见
footnote	脚注	内容	生成在页面结尾显示的脚注。	对本服务器上的所有维基可见
gallery	Gallery	布局	Displays the images found in the provided content using a slide-show view.	对本服务器上的所有维基可见
groovy	Groovy	开发	执行groovy脚本。	对本服务器上的所有维基可见
html	HTML	开发	在页面中输入HTML或者XHTML代码。	对本服务器上的所有维基可见
iconPicker	图标选择器	开发	在XWiki图标集中选择一个图标。	在当前维基可见
id	标识	导航	允许在页面中放置一个引用/地址标识。在HTML中称之为锚点（Anchor），这允许在例如链接等地方直接指向那个位置。	对本服务器上的所有维基可见
include	Include	内容	将其他页面嵌入在当前页中。	对本服务器上的所有维基可见
info	提示消息	格式化	显示一个提示消息。	对本服务器上的所有维基可见
liveData	Live Data	内容	Display dynamic lists of data.	对本服务器上的所有维基可见
mention	User Mention	Notifications	Insert a user mention.	在当前维基可见
menu	菜单	导航	显示使用简单Wiki语法（嵌套列表和链接）创建的菜单。	对本服务器上的所有维基可见
missingLicenseMessage	Missing License Message		Display an error message when the extension does not have a valid license.	对本服务器上的所有维基可见
notifications	通知	Notifications	显示wiki中发生的事件的通知。	在当前维基可见
notificationsApplicationsPreferences	通知应用程序偏好	Notifications	显示当前用户关于通知应用程序的偏好。	在当前维基可见
notificationsAutoWatchPreferences	通知自动监视偏好	Notifications	显示当前用户关于自动监视页面的偏好。	在当前维基可见
notificationsCustomFiltersPreferences	Notifications Custom Filters Preferences	Notifications	Display the preferences of the given user about custom notification filters.	在当前维基可见
notificationsEmailPreferences	Notifications Email Preferences	Notifications	Display the preferences of the current user about notification emails.	在当前维基可见
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.	在当前维基可见
notificationsSystemFiltersPreferences	Notifications System Filters Preferences	Notifications	Display the preferences of the given user about system notification filters.	在当前维基可见
office	Office Document Viewer	内容	View office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them.	对本服务器上的所有维基可见
pdftoc	PDF Table of Contents	内部	Generates the table of contents for the PDF export.	对本服务器上的所有维基可见
putFootnotes	放置脚注	内容	显示到目前为止已定义的脚注。如果没有这个，则默认所有脚注都显示在页面结尾。	对本服务器上的所有维基可见
python	Python	开发	执行python脚本。	对本服务器上的所有维基可见
script	脚本	开发	使用脚本语言执行脚本。	对本服务器上的所有维基可见
success	成功消息	格式化	显示一个成功消息。	对本服务器上的所有维基可见
tagcloud	Tag Cloud	内容	Displays the cloud of tags in this wiki or in the specified space, if any.	在当前维基可见
template	模板	开发	插入模板。	对本服务器上的所有维基可见
toc	目录	导航	生成目录。	对本服务器上的所有维基可见
translation	翻译	内容	显示一条翻译消息。	对本服务器上的所有维基可见
tree	Tree	导航	Displays a tree hierarchy defined by the macro content or the source parameter.	在当前维基可见
uiextension	UI Extension	开发	Insert a UI extension.	对本服务器上的所有维基可见
uiextensions	UI Extensions	开发	Insert UI extensions.	对本服务器上的所有维基可见
useravatar	使用头像	内容	允许显示某个用户的头像。	对本服务器上的所有维基可见
velocity	Velocity	开发	执行一个Velocity脚本。	对本服务器上的所有维基可见
warning	警告消息	格式化	显示一个错误消息。	对本服务器上的所有维基可见
wikimacrocontent	WikiMacro Content	开发	Display editable content of a wikimacro.	对本服务器上的所有维基可见
wikimacroparameter	WikiMacro Parameter	开发	Display editable parameter of a wikimacro.	对本服务器上的所有维基可见
wikis	Wikis	导航	List all wikis	在当前维基可见
workspaces	Workspaces (Legacy)	已过时	Deprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead.	在当前维基可见

HTML

2.0 HTML

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

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

Scripts

2.0 Scripts

XWiki supports several scripting languages.

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