0 Votes

Available Macros

Last modified by Jeff McDonald on 2023/07/11 09:59

IdNameCategoriesDescriptionVisibility
activityActivity (legacy)NotificationsProvide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream.Current Wiki
asyncAsync macroContentExecute asynchronously and/or cache the macro content.Global
attachmentGalleryPickerAttachment PickerDevelopmentGrid based attachment picker.Global
attachmentSelectorAttachment SelectorDevelopmentA 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
awmkanbanKanban board for AppWithinMinutesDisplay XWiki Documents from an AWM as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board).Global
blogpostcreateBlog Post CreateThe 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.Current Wiki
blogPostLayoutCardsCards Blog Post LayoutThis macro is used to display a blog post using the 'Cards' layoutCurrent Wiki
blogPostLayoutCompactBlog Post Layout CompactThis macro is used to display a full blog post in a compact modeCurrent Wiki
blogPostLayoutFullBlog Post Layout FullThis macro is used to display a full blog postCurrent Wiki
blogPostLayoutImageBlog Post Layout ImageThis macro is used to display a full blog post with a thumbnail imageCurrent Wiki
blogPostLayoutLinkBlog Post Layout LinkThis macro is used to display a blog post as a simple linkCurrent Wiki
blogpostlistBlog post listThe BlogPostMacro is used to search and display blog posts based on some parameters, the results can be displayed using customizable templates.Current Wiki
blogsAll Blogs LivetableThe blogs macro is used to list on a livetable all the blog available on the wiki.Current Wiki
boxBoxFormattingDraw a box around provided content.Global
cacheCacheDevelopmentCaches content.Global
calendarCalendarContentDisplays a CalendarCurrent Wiki
chartChartContentDisplays a graphical chart generated from miscellaneous data sourcesGlobal
childrenChildrenNavigationDisplays a tree of children pages of the current pageCurrent Wiki
codeCodeFormattingHighlights code snippets of various programming languagesGlobal
commentCommentDevelopmentAllows putting comments in the source content. This macro doesn't output anything.Global
containerContainerLayoutA macro to enclose multiple groups and add decoration, such as layout.Global
contentContentContentAllows writing content in any wiki markupGlobal
contextContextDevelopmentExecutes content in the context of the passed pageGlobal
dashboardDashboardLayoutA macro to define a dashboard to fill with gadgets.Global
displayDisplayContentDisplay other pages into the current page.Global
displayIconIconContentDisplay an icon.Global
documentsPagesContentDisplays a list of pages in a LivetableCurrent Wiki
documentTreePage TreeNavigationDisplays the tree of XWiki pages.Current Wiki
errorError MessageFormattingDisplays an error message note.Global
exampleExampleFormattingShows an example and its source code.Current Wiki
faqFAQLists FAQ entriesCurrent Wiki
fileManager.recentFilesRecent FilesContentLists the files that have been recently uploaded through the File Manager.Current Wiki
filemanagerdocFile Manager DocumentContentInserts a file manager document in a page, with or without previewCurrent Wiki
filetagcloudFileManager tag cloudContentDisplays the cloud of file tags in this wiki or in the specified space, if any.Current Wiki
footnoteFootnoteContentGenerates a footnote to display at the end of the page.Global
forum.recentForumDiscussionsRecent Forum DiscussionsContentLists 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
galleryGalleryLayoutDisplays the images found in the provided content using a slide-show view.Global
groovyGroovyDevelopmentExecute a groovy script.Global
htmlHTMLDevelopmentInserts HTML or XHTML code into the page.Global
iconPickerIcon PickerDevelopmentSelect an icon within the XWiki icon set.Current Wiki
idIdNavigationAllows 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
ideasrecentRecent IdeasDisplays the N most recent ideas.Current Wiki
includeIncludeContentInclude other pages into the current page.Global
infoInfo MessageFormattingDisplays an info message note.Global
jwplayerJW PlayerContentThe 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
kanbanKanbanKanban macro allowing to display and edit a kanbanCurrent Wiki
kanbanboardKanban boardDisplay the tasks as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board).Current Wiki
liveDataLive DataContentDisplay dynamic lists of data.Global
mapMapDisplay an interactive geographical mapCurrent Wiki
mentionUser MentionNotificationsInsert a user mention.Current Wiki
menuMenuNavigationDisplays a menu created using simple wiki syntax (nested lists and links).Global
messageSenderMessage SenderSocialA control that allows users to enter messages that are handled by the MessageStream module.Current Wiki
moccacalendarMocca CalendarContentDisplays a CalendarCurrent Wiki
nextmeetingsNext MeetingsDisplays a defined number of upcoming meetingsCurrent Wiki
notificationsNotificationsNotificationsDisplay notifications about events happened on the wiki.Current Wiki
notificationsApplicationsPreferencesNotifications Applications PreferencesNotificationsDisplay the preferences of the current user about notification applications.Current Wiki
notificationsAutoWatchPreferencesNotifications Auto Watch PreferencesNotificationsDisplay the preferences of the current user about auto watched pages.Current Wiki
notificationsCustomFiltersPreferencesNotifications Custom Filters PreferencesNotificationsDisplay the preferences of the given user about custom notification filters.Current Wiki
notificationsEmailPreferencesNotifications Email PreferencesNotificationsDisplay the preferences of the current user about notification emails.Current Wiki
notificationsFiltersPreferencesNotifications Filters Preferences (deprecated)NotificationsDisplay 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
notificationsSystemFiltersPreferencesNotifications System Filters PreferencesNotificationsDisplay the preferences of the given user about system notification filters.Current Wiki
officeOffice Document ViewerContentView office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them.Global
pdftocPDF Table of ContentsInternalGenerates the table of contents for the PDF export.Global
pdfviewerPDF ViewerContentPDF Viewer based on Mozilla pdf.jsCurrent Wiki
pollsrecentRecent PollsDisplays the N most recent polls.Current Wiki
putFootnotesPut FootnoteContentDisplays the footnotes defined so far. If missing, all footnotes are displayed by default at the end of the page.Global
pythonPythonDevelopmentExecutes a python script.Global
rssRSSContentOutput latest feed entries from a RSS feed.Global
scriptScriptDevelopmentExecute script in provided script language.Global
spaceindexSpace IndexDeprecatedLists the pages in a space.Current Wiki
spacesSpacesDeprecatedDisplays all the spaces in this wiki.Current Wiki
successSuccess MessageFormattingDisplays a success message note.Global
tagcloudTag CloudContentDisplays the cloud of tags in this wiki or in the specified space, if any.Current Wiki
taskcardTask cardDisplay a task and its information as a card.Current Wiki
templateTemplateDevelopmentInsert a template.Global
tocTable of contentsNavigationGenerates a table of contents.Global
translationTranslationContentDisplay a translation message.Global
treeTreeNavigationDisplays a tree hierarchy defined by the macro content or the source parameter.Current Wiki
uiextensionUI ExtensionDevelopmentInsert a UI extension.Global
uiextensionsUI ExtensionsDevelopmentInsert UI extensions.Global
useravatarUser AvatarContentAllows displaying the avatar for a specific user.Global
velocityVelocityDevelopmentExecutes a Velocity script.Global
videoVideoContentDisplay 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

warningWarning MessageFormattingDisplays a warning message note.Global
wikimacrocontentWikiMacro ContentDevelopmentDisplay editable content of a wikimacro.Global
wikimacroparameterWikiMacro ParameterDevelopmentDisplay editable parameter of a wikimacro.Global
wikisWikisNavigationList all wikisCurrent Wiki
workspacesWorkspaces (Legacy)DeprecatedDeprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead.Current Wiki