XWiki - XWiki Syntax Guide

Page / - 最后修改者 CMO 打开 2022-05-03

XWiki Syntax Guide

最后修改者 CMO

打开 2022-05-03

内容列表

XWiki Syntax 2.1: Programming

XWiki Syntax 2.1 » Programming

XWiki Syntax 2.1: Programming

General

Introduction

General Remarks

Other Syntaxes

Editing

Paragraphs

Headings

Text Formatting

Horizontal Line

Lists

Definition Lists

New Line/Line Breaks

Links

Tables

Images

Advanced

Verbatim

Quotations

Groups

Escapes

Parameters

Programming

Macros

HTML

Scripts

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	名称	分类	描述	可见性
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
blogPostLayoutFull	Blog Post Layout Full	This macro is used to display a full blog post	在当前维基可见
example	Example	Formatting	Shows an example and its source code.	Global
mention	User Mention	Notifications	Inserts a user mention.	在当前维基可见
plantuml	PlantUML	Content	Convert various text input formats into diagram images using PlantUML.	Global
blogPostLayoutImage	Blog Post Layout Image	This macro is used to display a full blog post with a thumbnail image	在当前维基可见
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
warning	Warning Message	Formatting	Displays a warning message note.	Global
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.	Global
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
blogs	Blogs Livetable	The blogs macro is used to list on a livetable all the blog available on the wiki	在当前维基可见
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.	在当前维基可见
blogPostLayoutLink	Blog Post Layout Link	This macro is used to display a blog post as a simple link	在当前维基可见
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
blogPostLayoutCards	Cards Blog Post Layout	This macro is used to display a blog post using the 'Cards' layout	在当前维基可见
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
uiextension	UI Extensions	Development	Insert a UI extension.	Global
notificationsSystemFiltersPreferences	Notifications System Filters Preferences	Notifications	Display the preferences of the given user about system notification filters.	在当前维基可见
uiextensions	UI Extensions	Development	Insert UI extensions.	Global
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	Global
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).	对本服务器上的所有维基可见
blogPostLayoutCompact	Blog Post Layout Compact	This macro is used to display a full blog post in a compact mode	在当前维基可见
notificationsCustomFiltersPreferences	Notifications Custom Filters Preferences	Notifications	Display the preferences of the given user about custom notification filters.	在当前维基可见
blogpostcreate	Blog Post Create	The 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.	在当前维基可见
blogpostlist	Blog post list	The BlogPostMacro is used to search and display blog posts based on some parameters, the results can be displayed using customizable templates.	在当前维基可见
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
pdfviewer	pdfviewer	Content	PDF Viewer based on Mozilla pdf.js	在当前维基可见
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
jwplayer	JW Player	Content	The JW Player is an open-source embeddable media player for web sites, supporting many commonly-used audio and video formats. The player is easy to configure, customize and extend.	在当前维基可见
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

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