XWiki Syntax Guide

Naposledy změněno superadmin 06.01.2023 13:12

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
activity	Aktivita	Notifications	Aktivity makro poskytuje informace o posledních činnostech provedených uživateli uvnitř XWiki. Zobrazuje: vytváření, úpravy a mazání stránek, komentářů, příloh a anotací.	Current Wiki
async	Async macro	Obsah	Execute asynchronously and/or cache the macro content.	Global
attachmentGalleryPicker	Attachment Picker	Vývoj	Grid based attachment picker.	Global
attachmentSelector	Attachment Selector	Vývoj	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
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
blogPostLayoutCards	Cards Blog Post Layout		This macro is used to display a blog post using the 'Cards' layout	Current Wiki
blogPostLayoutCompact	Blog Post Layout Compact		This macro is used to display a full blog post in a compact mode	Current Wiki
blogPostLayoutFull	Blog Post Layout Full		This macro is used to display a full blog post	Global
blogPostLayoutIDoc	Blog Post Layout iDoc		This macro is used to display a iDoc blog post	Global
blogPostLayoutImage	Blog Post Layout Image		This macro is used to display a full blog post with a thumbnail image	Global
blogPostLayoutLink	Blog Post Layout Link		This macro is used to display a blog post as a simple link	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
blogs	All Blogs Livetable		The blogs macro is used to list on a livetable all the blog available on the wiki.	Global
box	Editační pole	Formátování	Vyznačte okno kolem poskytnutého obsahu	Global
cache	Cache	Vývoj	Caches content.	Global
chart	Graf	Obsah	Zobrazí graf generovaný z různých datových zdrojů	Global
children	Children	Navigace	Displays a tree of children pages of the current page	Current Wiki
code	Kód	Formátování	Zvýraznit kód v různých programovacích jazycích	Global
comment	Comment	Vývoj	Allows putting comments in the source content. This macro doesn't output anything.	Global
container	Container	Layout	Makro k obalení více skupin a přidání dekorace, např. rozvržení.	Global
content	Content	Obsah	Allows writing content in any wiki markup	Global
context	Context	Vývoj	Executes content in the context of the passed page	Global
dashboard	Dashboard	Layout	Makro pro definici dashboard pro naplnění miniaplikacemi.	Global
display	Display	Obsah	Display other pages into the current page.	Global
displayIcon	Icon	Obsah	Display an icon.	Global
documents	Pages	Obsah	Displays a list of pages in a Livetable	Current Wiki
documentTree	Page Tree	Navigace	Displays the tree of XWiki pages.	Current Wiki
error	Chybová Zpráva	Formátování	Zobrazí chybovou zprávu.	Global
example	Example	Formátování	Shows an example and its source code.	Current Wiki
footnote	Poznámka pod čarou	Obsah	Generuje poznámku pod čarou zobrazenou na konci stránky.	Global
gallery	Fotogalerie	Layout	Zobrazí obrázky nalezené v uvedeném umístění pomocí náhledu slide-show.	Global
groovy	Groovy	Vývoj	Spustit groovy skript.	Global
html	HTML	Vývoj	Vloží HTML nebo XHTML kód do stránky	Global
iconPicker	Icon Picker	Vývoj	Select an icon within the XWiki icon set.	Current Wiki
id	ID	Navigace	Umožní vložit do stránky referenci/umístění. Např. v HTML je toto zváno Achchor. Umožňuje odkazy na takové umístění	Global
include	Vložit	Obsah	Vloží do stránky další stránky.	Global
info	Informační zpráva	Formátování	Zobrazí	Global
liveData	Live Data	Obsah	Display dynamic lists of data.	Global
mention	User Mention	Notifications	Insert a user mention.	Current Wiki
menu	Menu	Navigace	Displays a menu created using simple wiki syntax (nested lists and links).	Global
messageSender	Message Sender	Social	A control that allows users to enter messages that are handled by the MessageStream module.	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
office	Prohlížeč office dokumentů	Obsah	Zobrazí office přílohy (doc, ppt, xls, odt, odp, ods atd.) na stránkách wiki bez nutnosti jejich stahování nebo importu.	Global
pdftoc	PDF Table of Contents	Internal	Generates the table of contents for the PDF export.	Global
pdfviewer	PDF Viewer	Obsah	PDF Viewer based on Mozilla pdf.js	Current Wiki
putFootnotes	Vlož poznámku pod čarou	Obsah	Zobrazí existující poznámky pod čarou. Pokud není definováno, zobrazí na konci stránky všechny poznámky pod čarou.	Global
python	Python	Vývoj	Spustí skript v pythonu	Global
script	Skript	Vývoj	Spustí skript v příslušném skriptovacím jazyce.	Global
showhide	showhide	content	Show Hide Macro	Current Wiki
spaceindex	Seznam souborů prostoru	Deprecated	Zobrazí dokumenty v prostoru.	Current Wiki
success	Success Message	Formátování	Displays a success message note.	Global
tagcloud	Souhrn značek	Obsah	Zobrazuje souhrn značek v této wiki nebo v daném prostoru, pokud existuje	Current Wiki
template	Template	Vývoj	Insert a template.	Global
toc	Tabulka obsahu dokumentu	Navigace	Generuje tabulku obsahu dokumentu	Global
translation	Translation	Obsah	Display a translation message.	Global
tree	Tree	Navigace	Displays a tree hierarchy defined by the macro content or the source parameter.	Current Wiki
uiextension	UI Extension	Vývoj	Insert a UI extension.	Global
uiextensions	UI Extensions	Vývoj	Insert UI extensions.	Global
useravatar	Uživatelský avatar	Obsah	Povolí zobrazení avatara pro specifického uživatele.	Global
velocity	Velocity	Vývoj	Spustí Velocity skript	Global
video	Video	Obsah	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
warning	Varovné Hlášení	Formátování	Zobrazí varovné hlášení	Global
watchlist	Watch List	Obsah	Show the content of your current watchlist.	Current Wiki
wikimacrocontent	WikiMacro Content	Vývoj	Display editable content of a wikimacro.	Global
wikimacroparameter	WikiMacro Parameter	Vývoj	Display editable parameter of a wikimacro.	Global
wikis	Wikis	Navigace	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

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