XWiki Syntax Guide

在2019/08/28 18:37上被shi chuck修改

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

Radeox macros cannot be used in XWiki Syntax 2.1. Thus they have been rewritten as Rendering macros.

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

Macros in this wiki

Id	Name	Category	Description	Visibility
toc	Table Of Contents	Navigation	Generates a Table Of Contents.	Global
iconPicker	Icon Picker	Development	Select an icon within the XWiki icon set.	Current Wiki
formula	Formula	Content	Displays a mathematical formula.	Global
blogPostLayoutFull	Blog Post Layout Full		This macro is used to display a full blog post	Global
forum.recentForumDiscussions	Recent Forum Discussions	Content	Lists the top N most recent discussions from all the forums A discussion is considered recent if:

new topic is created on a forum
new topic is edited of a forum
new answer is created on a topic
new answer is edited (this will include comment added and comment edited)|Current Wiki

example	Example		Shows an example and its source code.	Current Wiki
watchlist	Watchlist	Content	Show the content of your current watchlist.	Current Wiki
blogPostLayoutImage	Blog Post Layout Image		This macro is used to display a full blog post with a thumbnail image	Global
spaceindex	Space Index	Deprecated	Lists documents in a space.	Current Wiki
filetagcloud	FileManager tag cloud	Content	Displays the cloud of file tags in this wiki or in the specified space, if any.	Current Wiki
box	Box	Formatting	Draw a box around provided content.	Global
spaces	Spaces	Deprecated	Displays all the spaces in this wiki.	Current 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.	Current Wiki
children	Children	Navigation	Displays a tree of children pages of the current page	Current Wiki
workspaces	Workspaces	Deprecated	Deprecated macro that should not be used, here for compatibility reason. Please use the "wikis" macro instead.	Current Wiki
display	Display	Content	Display other pages into the current page.	Global
translation	Translation	Content	Display a translation message.	Global
pollsrecent	Recent Polls		Displays the N most recent polls.	Current Wiki
context	Context	Development	Executes content in the context of the passed document	Global
info	Info Message	Formatting	Displays an info message note.	Global
moccacalendar	Mocca Calendar	Content	Displays a Calendar	Current Wiki
tree	Tree	Navigation	Displays a tree hierarchy defined by the macro content or the source parameter.	Current Wiki
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	Global
success	Success Message	Formatting	Displays a success message note.	Global
documentTree	Document Tree	Navigation	Displays the tree of XWiki documents.	Current Wiki
nextmeetings	Next Meetings		Displays a defined number of upcoming meetings	Current Wiki
template	Template	Development	Insert a template.	Global
notificationsAutoWatchPreferences	Notifications Auto Watch Preferences	Notifications		Current Wiki
chart	Chart	Content	Displays a graphical chart generated from miscellaneous data sources	Global
fileManager.recentFiles	Recent Files	Content	Lists the files that have been recently uploaded through the File Manager.	Current Wiki
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.	Current Wiki
tagcloud	Tag Cloud	Content	Displays the cloud of tags in this wiki or in the specified space, if any.	Current Wiki
activity	Activity (legacy)	Notifications	Provide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream.	Current Wiki
blogPostLayoutLink	Blog Post Layout Link		This macro is used to display a blog post as a simple link	Global
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
map	Map		Display an interactive geographical map	Current Wiki
gallery	Gallery	Layout	Displays the images found in the provided content using a slide-show view.	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	Current Wiki
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.	Current Wiki
notificationsApplicationsPreferences	Notifications Applications Preferences	Notifications	Display the preferences of the current user about notification applications.	Current Wiki
taskcard	Task card		Display a task and its information as a card.	Global
cache	Cache	Development	Caches content.	Global
menu	Menu	Navigation	Displays a menu created using simple wiki syntax (nested lists and links).	Global
ideasrecent	Recent Ideas		Displays the N most recent ideas.	Current Wiki
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.	Global
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.	Global
filemanagerdoc	File Manager Document	Content	Inserts a file manager document in a page, with or without preview	Current Wiki
documents	Documents	Content	Displays a list of documents in a Livetable	Current Wiki
notificationsFiltersPreferences	Notifications Filters Preferences	Notifications	Display the preferences of the current user about notification filters.	Current Wiki
notifications	Notifications	Notifications		Current Wiki
velocity	Velocity	Development	Executes a Velocity script.	Global
pdfviewer	pdfviewer	Content	PDF Viewer based on Mozilla pdf.js	Current Wiki
faq	FAQ		Lists FAQ entries	Current Wiki
groovy	Groovy	Development	Execute a groovy script.	Global
footnote	Footnote	Content	Generates a footnote to display at the end of the page.	Global
kanbanboard	Kanban board		Display the tasks as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board).	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.	Current Wiki
code	Code	Formatting	Highlights code snippets of various programming languages	Global
calendar	Calendar	Content	Displays a Calendar	Current Wiki
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

标签：

在2019/08/28 18:37上被shi chuck创建