XWiki Syntax Guide

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	Name	Categories	Description	Visibility
2p	2P	Names	Displays acronym “2P”	Current Wiki
2pkt	2P-Kt	Names	Displays acronym “2P-Kt”	Current Wiki
aclt	ACLT	Names	Displays acronym “ACLT”	Current Wiki
activity	Activity (legacy)	Notifications	Provide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream.	Current Wiki
aea	A&A	Names	Displays acronym “A&A”	Current Wiki
aequitas	Aequitas	Names	Displays project acronym “AEQUITAS”	Current Wiki
agentlink3	AgentLink III	Names	Displays project acronym “AgentLink III”	Current Wiki
ai4eu	AI4EU	Names	Displays project acronym “AI4EU”	Current Wiki
ai4europe	AI4EUROPE	Names	Displays project acronym “AI4EUROPE”	Current Wiki
alchemist	Alchemist	Names	Displays name “Alchemist”	Current Wiki
almatwo	AlmaTwo	Names	Displays project acronym “AlmaTwo”	Current Wiki
aloo	ALOO	Names	Displays acronym “ALOO”	Current Wiki
amscampus	AMS Campus	Courses	Links AMS Campus resources	Current Wiki
anchorEngIta	Anchor English / Italian	Presentation	Links a label in English / Italian to an HTML anchor in a XWiki page	Current Wiki
anchorField	Anchor Field	Presentation	Links a label in English / Italian to an anchor in a Field List page of an APICe object space	Current Wiki
aomip2010	AOMIP @ SAC 2010	Names	Displays event acronym “AOMIP @ SAC 2010”	Current Wiki
aomp2009	AOMP @ SAC 2009	Names	Displays event acronym “AOMP @ SAC 2009”	Current Wiki
apice	APICe	Names	Displays name “APICe”	Current Wiki
arg2p	Arg2P	Names	Displays acronym “Arg2P”	Current Wiki
argtuprolog	Arg-tuProlog	Names	Displays name “Arg-tuProlog”	Current Wiki
async	Async macro	Content	Execute asynchronously and/or cache the macro content.	Global
attachmentGalleryPicker	Attachment Picker	Development	Grid based attachment picker.	Global
attachmentSelector	Attachment Selector	Development	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.	Current Wiki
aware	AWARE	Names	Displays project acronym “AWARE”	Current Wiki
bibtexUserDisplay	BibTeX User Display	Publications	Displays a "Surname, Name" string in possibly-decorated "Name Surname" form	Current Wiki
bison	BISON	Names	Displays project acronym “BISON”	Current Wiki
box	Box	Formatting	Draw a box around provided content.	Global
cache	Cache	Development	Caches content.	Global
cartago	CArtAgO	Names	Displays acronym “CArtAgO”	Current Wiki
chart	Chart	Content	Displays a graphical chart generated from miscellaneous data sources	Global
children	Children	Navigation	Displays a tree of children pages of the current page	Current Wiki
cina	CINA	Names	Displays project acronym “CINA”	Current Wiki
classPropHeader	Class Property Header	Class	For List of fields pages	Current Wiki
classPropPrettyName	Class Property Pretty Name	Class	Display (translated) pretty name for a given class property	Current Wiki
classPropStaticList	Class Property Static List	Class	Displays values for a given class property of type Static List	Current Wiki
classPropType	Class Property Type	Class	Display type for a given class property	Current Wiki
code	Code	Formatting	Highlights code snippets of various programming languages	Global
comment	Comment	Development	Allows putting comments in the source content. This macro doesn't output anything.	Global
compulaw	CompuLaw	Names	Displays project acronym “CompuLaw”	Current Wiki
container	Container	Layout	A macro to enclose multiple groups and add decoration, such as layout.	Global
content	Content	Content	Allows writing content in any wiki markup	Global
context	Context	Development	Executes content in the context of the passed page	Global
course	Course	Courses	Displays descriptor for Course object	Current Wiki
courseAms	Course AMS Link	Courses	Displays link to AMS page for Course object	Current Wiki
courseAY	Course Academic Year	Courses	Displays academic year for Course object	Current Wiki
courseCycle	Course Cycle	Courses	Displays academic cycle for Course object	Current Wiki
courseName	Course Name	Courses	Displays course name for Course object	Current Wiki
courseOtherprofessors	Course Other Professors	Courses	Displays other professor(s) name(s) for Course object	Current Wiki
courseProfessor	Course Professor	Courses	Displays professor(s) name(s) for Course object	Current Wiki
courseTimetable	Course Timetable Link	Courses	Displays link to timetable for Course object	Current Wiki
courseTutors	Course Tutors	Courses	Displays tutor(s) name(s) for Course object	Current Wiki
criad	CRIAD	Names	Displays event acronym “CRIAD”	Current Wiki
dashboard	Dashboard	Layout	A macro to define a dashboard to fill with gadgets.	Global
display	Display	Content	Display other pages into the current page.	Global
displayIcon	Icon	Content	Display an icon.	Global
displayName	Display APICe Names	Names	Selects one of the APICe name macros to display	Current Wiki
DisplayObjectInfos	DisplayObjectInfos	code	Display a selected list of properties of an object	Current Wiki
documents	Pages	Content	Displays a list of pages in a Livetable	Current Wiki
documentTree	Page Tree	Navigation	Displays the tree of XWiki pages.	Current Wiki
eclipseit	Eclipse-IT	Names	Displays project acronym “Eclipse-IT”	Current Wiki
edemocracy	E-Democracy	Names	Displays project acronym “E-Democracy”	Current Wiki
editorString	Editor String	Publications	Displays editor string	Current Wiki
engines	ENGINES	Names	Displays acronym “ENGINES”	Current Wiki
english	English	Language	Displays content if context language is English	Current Wiki
eos	EOS	Names	Displays project acronym “EOS”	Current Wiki
eosdue	EOS DUE	Names	Displays project acronym “EOS DUE”	Current Wiki
error	Error Message	Formatting	Displays an error message note.	Global
event	Event	Events	Displays descriptor for Event object	Current Wiki
eventAcronym	Event Acronym	Events	Displays acronym for Event object	Current Wiki
eventAcronymAt	Event Acronym At Acronym	Events	Displays acronym for Event object with possibly the hosting event acronym	Current Wiki
eventList	Event List	Events	Displays event list	Current Wiki
eventName	Event Name	Events	Displays name for Event object	Current Wiki
eventRole	Event Role	Events	Displays event role	Current Wiki
eventSort	Event Sort	Events	Displays the sort of Events object	Current Wiki
eventWhen	Event dates	Events	Displays start/end dates for Event object	Current Wiki
eventWhere	Event Where	Events	Displays the location of Events object	Current Wiki
example	Example	Formatting	Shows an example and its source code.	Current Wiki
expectation	EXPECTATION	Names	Displays project acronym “EXPECTATION”	Current Wiki
fairpe01sp08	FAIR-PE01-SP08	Names	Displays project acronym “FAIR-PE01-SP08”	Current Wiki
figure	Figure	Development	Tag content as an illustration and with an optional caption.	Global
figureCaption	Figure Caption	Development	Provide a figure caption when used inside the Figure macro.	Global
figureTypeRecognizer	Figure Type Recognizer	Internal	Internal macro used to recognize the type of a figure.	Global
footnote	Footnote	Content	Generates a footnote to display at the end of the page.	Global
gaia	Gaia	Names	Displays name “Gaia”	Current Wiki
gallery	Gallery	Layout	Displays the images found in the provided content using a slide-show view.	Global
groovy	Groovy	Development	Execute a groovy script.	Global
hasEdit	Has Edit	Presentation	Text displayed only when the user has edit rights	Current Wiki
himat	HiMAT	Names	Displays acronym “HiMAT”	Current Wiki
homemanager	Home Manager	Names	Displays name “Home Manager”	Current Wiki
html	HTML	Development	Inserts HTML or XHTML code into the page.	Global
iconPicker	Icon Picker	Development	Select an icon within the XWiki icon set.	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
info	Info Message	Formatting	Displays an info message note.	Global
internship	Internship	Internships	Displays descriptor for Internship object	Current Wiki
internshipCotutor	Internship Cotutor	Internships	Displays cotutors for Internship object	Current Wiki
internshipIntern	Internship Intern	Internships	Display intern for Internship object	Current Wiki
internshipTitle	Internship Title	Internships	Displays title for Internship object	Current Wiki
internshipTutor	Internship Tutor	Internships	Displays tutor for Internship object	Current Wiki
internshipType	Internship Type	Internships	Display type for Internship object	Current Wiki
iol	IOL	Courses	Links IOL (Insegnamenti OnLine @ UniBo) resources	Current Wiki
italiano	Italiano	Language	Displays content if context language is Italian	Current Wiki
journal	Journal	Journals	Displays descriptor for Journal object	Current Wiki
journalAcronym	Journal Acronym	Journals	Displays acronym for Journal object	Current Wiki
journalList	Journal List	Journals	Displays event list	Current Wiki
journalName	Journal Name	Journals	Displays name for Journal object	Current Wiki
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
liveData	Live Data	Content	Display dynamic lists of data.	Global
lpaas	LPaaS	Names	Displays acronym “LPaaS”	Current Wiki
luce	LuCe	Names	Displays acronym “LuCe”	Current Wiki
macro	Macro	Meta	Displays a (linked) macro ID and its description	Current Wiki
maop4fi	MAOP4FI	Names	Displays project acronym “MAOP4FI”	Current Wiki
map	Map		Display an interactive geographical map	Current Wiki
mensa	MEnSA	Names	Displays project acronym "MEnSA"	Current Wiki
mention	User Mention	Notifications	Insert a user mention.	Current Wiki
menu	Menu	Navigation	Displays a menu created using simple wiki syntax (nested lists and links).	Global
menuPeopleList	Menu People List	Menus	Displays people names from a list in a menu	Current Wiki
menuSeparatorLink	Menu Separator Link	Menus	Displays a graphically-defined line with a string describing elements of a Menu possibly linked with an APICe page	Current Wiki
messageSender	Message Sender	Social	A control that allows users to enter messages that are handled by the MessageStream module.	Current Wiki
missingLicenseMessage	Missing License Message		Display an error message when the extension does not have a valid license.	Global
mok	MoK	Names	Displays acronym “MoK”	Current Wiki
monthEngIta	Month English / Italian	Presentation	Adjusts month to the context language	Current Wiki
msbionet	MS-BioNET	Names	Displays acronym “MS-BioNET”	Current Wiki
namesFromBibtex	NamesFromBibTeX	Presentation	Converts a list of names in BibTeX format into a proper name list	Current Wiki
namesFromUsers	NamesFromUsers	Publications	Displays a list of XWiki users as a name list	Current Wiki
netscale	NETSCALE	Names	Displays project acronym “NETSCALE”	Current Wiki
nokiacoord	Coordination Technologies for Mobile Agents and Wireless Devices	Names	Displays project acronym "NokiaMobileCoord" or name “Coordination Technologies for Mobile Agents and Wireless Devices”	Current Wiki
noMoreAdmin	No More Admin	Presentation	"Dotted" menu no show	Current Wiki
noObjectNew	No Object New	Presentation	Create Button instead of New Object	Current Wiki
noShortcuts	No Shortcuts	Presentation	Shorcuts no show	Current Wiki
noTagFooter	No Tag Footer	Presentation	Tag footer no show	Current Wiki
notifications	Notifications	Notifications	Display notifications about events happened on the wiki.	Current Wiki
notificationsApplicationsPreferences	Notifications Applications Preferences	Notifications	Display the preferences of the current user about notification applications.	Current Wiki
notificationsAutoWatchPreferences	Notifications Auto Watch Preferences	Notifications	Display the preferences of the current user about auto watched pages.	Current Wiki
notificationsCustomFiltersPreferences	Notifications Custom Filters Preferences	Notifications	Display the preferences of the given user about custom notification filters.	Current Wiki
notificationsEmailPreferences	Notifications Email Preferences	Notifications	Display the preferences of the current user about notification emails.	Current Wiki
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.	Current Wiki
notificationsSystemFiltersPreferences	Notifications System Filters Preferences	Notifications	Display the preferences of the given user about system notification filters.	Current Wiki
objectSpace	Object Space	Environment	Sets object variables in object space	Current Wiki
office	Office Document Viewer	Content	View office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them.	Global
oitos	OITOS	Names	Displays project acronym “OITOS”	Current Wiki
pageDisplay	Page Display	Presentation	Configures page display (menus, buttons, footers) according to the page sort	Current Wiki
panelQualifier	Panel Graphic Field Qualifier	Panel	Displays a graphically-defined line with a string describing a single field in a Panels menu	Current Wiki
panelSeparator	Panel Separator	Panels	Displays a graphically-defined line with a string describing elements of a panel	Current Wiki
patj	P@J	Names	Displays name “P@J”	Current Wiki
pdf	PDF Object Embed		This macro allows embedding a PDF file in a wiki page using the <object> tag.	Global
pdftoc	PDF Table of Contents	Internal	Generates the table of contents for the PDF export.	Global
prima2015	PRIMA 2015	Names	Displays event acronym “PRIMA 2015”	Current Wiki
project	Project	Projects	Displays descriptor for Project object	Current Wiki
projectBudget	Project Budget	Projects	Displays overall budget for Project object	Current Wiki
projectContext	Project Context	Projects	Displays the context of Project object	Current Wiki
projectDates	Project Dates	Projects	Displays overall dates for Project object	Current Wiki
projectFunding	Project Funding	Projects	Displays overall funding for Project object	Current Wiki
projectList	Project List	Projects	List projects according to selected properties	Current Wiki
projectLongname	Project Long Name	Projects	Displays long name for Project object	Current Wiki
projectName	Project Name	Projects	Displays name for Project object	Current Wiki
projectPubs	Project Publications	Projects	Lists publications of a project	Current Wiki
projectRole	Project Role	Projects	Displays project role	Current Wiki
projectShortname	Project Short Name	Projects	Displays short name for Project object	Current Wiki
projectSort	Project Sort	Projects	Displays the sort of Project object	Current Wiki
projectStatus	Project Status	Projects	Displays the status of Project object	Current Wiki
projectTalks	Project Talks	Projects	Lists talks of a project	Current Wiki
psyke	PSyKe	Names	Displays acronym “PSyKE”	Current Wiki
pub	Publication	Publications	Displays descriptor for Publication object	Current Wiki
pubAutheditors	Publication Authors or Editors	Publications	Displays authors (if any) or editors for Publication object	Current Wiki
pubAuthors	Publication Authors	Publications	Displays authors for Publication object	Current Wiki
pubBibtex	Publication BibTeX Record		Displays BibTeX record for Publications object	Current Wiki
pubEditors	Publication Editors	Publications	Displays editors for Publication object	Current Wiki
pubList	Publication List	Publications	Displays a list of publications from a list of publication pages	Current Wiki
pubSort	Publication Sort	Publications	Displays sort for Publication object	Current Wiki
pubStatus	Publication Status	Publications	Displays status for Publication object	Current Wiki
pubTag	Publication Tag	Presentation	Includes Publications.Clouds.OneTag with properly set $tag	Current Wiki
pubTitle	Publication Title	Publications	Displays title for Publications object	Current Wiki
pubVenue	Publication Venue	Publications	Displays venue for Publication object	Current Wiki
pubYear	Publication Year	Publications	Displays year for Publication object	Current Wiki
putFootnotes	Put Footnotes	Content	Displays all the footnotes from the page. If missing, all footnotes are displayed by default at the end of the page.	Global
python	Python	Development	Executes a python script.	Global
reset	RESET	Names	Displays project acronym “RESET”	Current Wiki
respect	ReSpecT	Names	Displays acronym “ReSpecT”	Current Wiki
sapere	SAPERE	Names	Displays project acronym “SAPERE”	Current Wiki
script	Script	Development	Execute script in provided script language.	Global
semhealthcoord	Semantic Health Coordination	Names	Displays project acronym “SemHealthCoord”	Current Wiki
setMainTag	Set $mainTag	Presentation	Sets the $mainTag variable for Main.Tags4Tag cloud pages	Current Wiki
setMoreAdmin	Set More Admin	Presentation	"Dotted" menu show / no show depending on viewer	Current Wiki
setShortcuts	Set Shortcuts	Presentation	Shorcuts show according to reader	Current Wiki
setTag	Set $tag	Presentation	Sets the $tag variable for {$objectSpace}.Clouds.OneTag pages	Current Wiki
setTagFooter	Set Tag Footer	Presentation	Tag footer show/ no show depending on viewer	Current Wiki
simpa	simpA	Names	Displays acronym “simpA”	Current Wiki
simpal	simpAL	Names	Displays acronym “simpAL”	Current Wiki
sipeaa	SIPEAA	Names	Displays project acronym “SIPEAA”	Current Wiki
soda	SODA	Names	Displays acronym “SODA”	Current Wiki
source	Source	Meta	Shows a macro use case – source code and display	Current Wiki
spaceindex	Space Index	Deprecated	Lists the pages in a space.	Current Wiki
spaces	Spaces	Deprecated	Displays all the spaces in this wiki.	Current Wiki
stairwai	StairwAI	Names	Displays project acronym “StairwAI”	Current Wiki
stil	STIL	Names	Displays project acronym “STIL”	Current Wiki
stringEng	English String	Language	Displays a string if context language is English	Current Wiki
stringEngIta	English / Italian Strings	Language	Displays a string depending on context language — either English or Italian	Current Wiki
stringIta	Italian String	Language	Displays a string if context language is Italian	Current Wiki
success	Success Message	Formatting	Displays a success message note.	Global
t4j	TuCSoN4Jade	Names	Displays name “TuCSoN4Jade”	Current Wiki
t4jn	TuCSoN4Jason	Names	Displays name “TuCSoN4Jade”	Current Wiki
tagcloud	Tag Cloud	Content	Displays the cloud of tags in this wiki or in the specified space, if any.	Current Wiki
tags4Tag	Tags4Tag	Presentation	Includes Classes.Shared.Tags4Tag cloud with properly set $mainTag	Current Wiki
tailor	TAILOR	Names	Displays project acronym “TAILOR”	Current Wiki
talk	Talk	Talks	Displays descriptor for Talk object	Current Wiki
talkAuthors	Talk Authors	Talks	Displays authors for Talk object	Current Wiki
talkSort	TalkSort	Talks	Displays sort for Talks object	Current Wiki
talkSpeakers	Talk Speakers	Talks	Displays speakers for Talk object	Current Wiki
talkTag	Talk Tag	Presentation	Includes Talks.Clouds.OneTag with properly set $tag	Current Wiki
talkTitle	Talk Title	Talks	Displays title for Talk object	Current Wiki
talkVenue	Talk Venue	Talks	Displays venue for Talk object	Current Wiki
template	Template	Development	Insert a template.	Global
themeBorder	ThemeBorder	Presentation	A string displayed in color $theme.themeBorderColor	Current Wiki
themeTextPrimary	ThemeTextPrimary	Presentation	A string displayed in color $theme.textPrimaryColor	Current Wiki
themeTextSecondary	ThemeTextSecondary	Presentation	A string displayed in color $theme.textSecondaryColor	Current Wiki
thesis	Thesis	Theses	Displays descriptor for Thesis object	Current Wiki
thesisContacts	Thesis Contacts	Theses	Displays contacts for Thesis object	Current Wiki
thesisCosupervisors	Thesis Co-supervisors	Theses	Displays cosupervisors for Thesis object	Current Wiki
thesisCycle	Thesis Cycle	Talks	Displays cycle for Thesis object	Current Wiki
thesisDate	Thesis Date	Theses	Displays date for Thesis object	Current Wiki
thesisList	Thesis List	Theses	List theses according to selected properties	Current Wiki
thesisRole	Thesis Role	Talks	Displays role for Thesis object	Current Wiki
thesisStatus	Thesis Status	Talks	Displays status for Thesis object	Current Wiki
thesisStudent	Thesis Student	Theses	Displays student for Thesis object	Current Wiki
thesisSupervisors	Thesis Supervisors	Theses	Displays supervisors for Thesis object	Current Wiki
thesisTag	Thesis Tag	Presentation	Includes Thesis.Clouds.OneTag with properly set $tag	Current Wiki
thesisTitle	Thesis Title	Theses	Displays title for Thesis object	Current Wiki
toc	Table of contents	Navigation	Generates a table of contents.	Global
translation	Translation	Content	Display a translation message.	Global
traumatracker	TraumaTracker	Names	Displays name “TraumaTracker”	Current Wiki
tree	Tree	Navigation	Displays a tree hierarchy defined by the macro content or the source parameter.	Current Wiki
trust03	TRUST 03	Names	Displays project acronym “TRUST 03”	Current Wiki
tucson	TuCSoN	Names	Displays acronym “TuCSoN”	Current Wiki
tuprolog	tuProlog	Names	Displays name “tuProlog”	Current Wiki
tusow	TuSoW	Names	Displays acronym “TuSoW”	Current Wiki
uiextension	UI Extension	Development	Insert a UI extension.	Global
uiextensions	UI Extensions	Development	Insert UI extensions.	Global
useravatar	User Avatar	Content	Allows displaying the avatar for a specific user.	Global
userSpace	User Space	Environment	Sets user variables in user space	Current Wiki
velocity	Velocity	Development	Executes a Velocity script.	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).|Current Wiki

virtuale	Virtuale	Courses	Links Virtuale (Virtual Learning Environment @ UniBo) resources	Current Wiki
warning	Warning Message	Formatting	Displays a warning message note.	Global
wikimacrocontent	WikiMacro Content	Development	Display editable content of a wikimacro.	Global
wikimacroparameter	WikiMacro Parameter	Development	Display editable parameter of a wikimacro.	Global
wikis	Wikis	Navigation	List all wikis	Current Wiki
workspaces	Workspaces (Legacy)	Deprecated	Deprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead.	Current Wiki
yesMoreAdmin	Yes More Admin	Presentation	"Dotted" menu show	Current Wiki
yesObjectNew	Yes Object New	Presentation	New Object Button instead of Create	Current Wiki
yesShortcuts	Yes Shortcuts	Presentation	Shorcuts show	Current Wiki
yesTagFooter	Yes Tag Footer	Presentation	Tag footer show	Current Wiki

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