XWiki Syntax Guide
由 Behemoth Cognitive 于 2025/10/04 00:01 最后修改
XWiki Syntax 2.1 » Programming
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 |
Macros in this wiki
| Id | 名称 | 类别 | 描述 | 可见性 |
|---|---|---|---|---|
| activity | 活动 | Notifications | 活动宏（Activity Macro）提供了用户在 XWiki 实例中进行的近期活动信息。它列出了页面的创建、编辑和删除事件，以及评论、附件和注释。 | 在当前维基可见 |
| async | 异步宏 | 内容 | 异步执行和/或缓存宏内容。 | 对本服务器上的所有维基可见 |
| attachmentGalleryPicker | 附件选择工具 | 开发 | 基于网格的附件选择工具。 | 对本服务器上的所有维基可见 |
| attachmentSelector | 附件选择器 | 开发 | 用于当前页的对象属性的控件，这些属性应该包含来自当前（或目标）页的附件的名称。允许上传新附件和从目标页面删除附件。如果没有指定目标页，则将使用当前页。对象属性仅保存到当前页。 | 在当前维基可见 |
| box | 盒子 | 格式化 | 在内容周围绘制一个盒子。 | 对本服务器上的所有维基可见 |
| cache | 缓存 | 开发 | 缓存的内容。 | 对本服务器上的所有维基可见 |
| chart | 数据图表 | 内容 | 从各种数据源生成图表 | 对本服务器上的所有维基可见 |
| children | Children | 导航 | Displays a tree of children pages of the current page | 在当前维基可见 |
| code | 代码 | 格式化 | 为多种程序语言代码片段提供语法高亮 | 对本服务器上的所有维基可见 |
| comment | 评论 | 开发 | 允许在源内容中添加注释。这个宏不输出任何东西。 | 对本服务器上的所有维基可见 |
| container | 容器 | 布局 | 用于包围多个分组并添加装饰，例如布局。 | 对本服务器上的所有维基可见 |
| content | 内容 | 内容 | 允许在已标记的wiki编辑内容 | 对本服务器上的所有维基可见 |
| context | 上下文 | 开发 | 在指定的页面上下文中执行内容 | 对本服务器上的所有维基可见 |
| dashboard | 仪表盘 | 布局 | 定义一个仪表板的宏，用来填充小工具。 | 对本服务器上的所有维基可见 |
| discussion | Discussion | Displays a discussion | 在当前维基可见 | |
| display | 显示 | 内容 | 显示其他页面到当前页面。 | 对本服务器上的所有维基可见 |
| displayIcon | Icon | 内容 | Display an icon. | 对本服务器上的所有维基可见 |
| documents | 页 | 内容 | 在 Livetable 中显示页面列表 | 在当前维基可见 |
| documentTree | 页面树 | 导航 | 显示XWiki页面树。 | 在当前维基可见 |
| error | 错误消息 | 格式化 | 显示一个错误消息。 | 对本服务器上的所有维基可见 |
| example | Example | 格式化 | Shows an example and its source code. | 在当前维基可见 |
| footnote | 脚注 | 内容 | 生成在页面结尾显示的脚注。 | 对本服务器上的所有维基可见 |
| gallery | 图库 | 布局 | 使用幻灯片放映在提供的内容中找到的图片。 | 对本服务器上的所有维基可见 |
| groovy | Groovy语言 | 开发 | 执行groovy脚本。 | 对本服务器上的所有维基可见 |
| html | HTML | 开发 | 在页面中输入HTML或者XHTML代码。 | 对本服务器上的所有维基可见 |
| iconPicker | 图标选择器 | 开发 | 在XWiki图标集中选择一个图标。 | 在当前维基可见 |
| id | 标识 | 导航 | 允许在页面中放置一个引用/地址标识。在HTML中称之为锚点（Anchor），这允许在例如链接等地方直接指向那个位置。 | 对本服务器上的所有维基可见 |
| include | Include | 内容 | 将其他页面嵌入在当前页中。 | 对本服务器上的所有维基可见 |
| info | 提示消息 | 格式化 | 显示一个提示消息。 | 对本服务器上的所有维基可见 |
| listDiscussions | List Discussions | Provides a table to display filtered list of discussions. | 在当前维基可见 | |
| liveData | Live Data | 内容 | Display dynamic lists of data. | 对本服务器上的所有维基可见 |
| mention | User Mention | Notifications | Insert a user mention. | 在当前维基可见 |
| menu | 菜单 | 导航 | 显示使用简单Wiki语法（嵌套列表和链接）创建的菜单。 | 对本服务器上的所有维基可见 |
| 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 文档查看器 | 内容 | 可以在wiki页面中，查看office 类型附件((doc, ppt, xls, odt, odp, ods etc.)，无需下载。 | 对本服务器上的所有维基可见 |
| pdftoc | PDF Table of Contents | 内部 | Generates the table of contents for the PDF export. | 对本服务器上的所有维基可见 |
| putFootnotes | 放置脚注 | 内容 | 显示该页中的所有脚注。如果没有，则默认情况下在页面末尾显示所有脚注。 | 对本服务器上的所有维基可见 |
| python | Python | 开发 | 执行python脚本。 | 对本服务器上的所有维基可见 |
| script | 脚本 | 开发 | 使用脚本语言执行脚本。 | 对本服务器上的所有维基可见 |
| success | 成功消息 | 格式化 | 显示一个成功消息。 | 对本服务器上的所有维基可见 |
| tagcloud | 标签云 | 内容 | 显示此wiki维基页面或特定区域中对应的标签云。 | 在当前维基可见 |
| template | 模板 | 开发 | 插入模板。 | 对本服务器上的所有维基可见 |
| toc | 目录 | 导航 | 生成目录。 | 对本服务器上的所有维基可见 |
| translation | 翻译 | 内容 | 显示一条翻译消息。 | 对本服务器上的所有维基可见 |
| tree | Tree | 导航 | Displays a tree hierarchy defined by the macro content or the source parameter. | 在当前维基可见 |
| uiextension | UI 扩展 | 开发 | 插入 UI 扩展。 | 对本服务器上的所有维基可见 |
| uiextensions | UI 扩展 | 开发 | 插入 UI 扩展。 | 对本服务器上的所有维基可见 |
| useravatar | 使用头像 | 内容 | 允许显示某个用户的头像。 | 对本服务器上的所有维基可见 |
| velocity | 速度 | 开发 | 执行一个Velocity脚本。 | 对本服务器上的所有维基可见 |
| warning | 警告消息 | 格式化 | 显示一个错误消息。 | 对本服务器上的所有维基可见 |
| wikimacrocontent | WikiMacro Content | 开发 | Display editable content of a wikimacro. | 对本服务器上的所有维基可见 |
| wikimacroparameter | WikiMacro Parameter | 开发 | Display editable parameter of a wikimacro. | 对本服务器上的所有维基可见 |
| wikis | Wiki | 导航 | List all Wikis | 在当前维基可见 |
| workspaces | 工作区（旧版） | 已过时 | 已弃用的宏，由于兼容性问题不应在此使用。请使用 "Wikis" 宏代替。 | 在当前维基可见 |
HTML
2.0 HTML
| XWiki 语法 2.1 | Result |
|---|---|
| {{html}}<abbr title="HyperText Markup Language">HTML</abbr>{{/html}} | HTML |
Scripts
2.0 Scripts
| Feature | XWiki Syntax 2.1 |
|---|---|
| Velocity script |
{{velocity}}
#set ($var = "whatever")
{{/velocity}}
|
| Groovy script |
{{groovy}}
def var = "whatever"
{{/groovy}}
|