XWiki Enterprise 8.4.4 Documentation » Programming Overview » XWiki Velocity Macros Overview

XWiki Velocity Macros Overview

XWiki Velocity macros are using the Velocity Template Language.

Macro Definition

#macro(macroID $parameter1 $parameter2 ...)
//macro code
#end

Invocation

#macroID($parameter1 $parameter2 ...)

Velocity Macros Bundled with XWiki Enterprise

The bundled Velocity macros are defined in the "xwiki/templates/macros.vm" file. 

  • AIM Macro - Displays an online status indicator for an AIM account id. This macro is now marked as deprecated.
  • Display Panel Layout Macro - Displays a list of panels in the provided number of columns. We are currently using the newer Container macro.
  • Error Macro - Displays an error message in a styled box format, with an error icon. This macro is now marked as deprecated and replaced with the newer Error Macro.
  • Flickr Macro - Displays a list of images taken from a Flickr RSS feed. This macro is now marked as deprecated.
  • Flick User Macro - Displays the latest photos from a Flickr user. This macro is now marked as deprecated.
  • Flickr User And Tag Macro - Displays latest public photos from a given user tagged with the given tag. This macro is now marked as deprecated.
  • Flickr Tag Macro - Displays public photos from Flickr with the given tag. This macro is now marked as deprecated.
  • Footnote Macro - Adds a note of text placed (by default) at the bottom of the page. Currently, we are using the "xwiki/2.0" syntax Footnote Macro.
  • IM Macro - Displays a XWiki User online status indicator depending on the "imaccount" and "imtype" properties in the user profile. This macro is now marked as deprecated.
  • Include Form Macro - Includes a document which will be rendered in the context of the current document. This macro is now marked as deprecated and replaced with the newer Include macro.
  • Include In Context Macro - Include a document which will be rendered in the context of the current document. This macro is now marked as deprecated and replaced with the newer Include macro.
     
  • Include Macros Macro - Represents an alias for the "Include Form" macro. This macro is now marked as deprecated and replaced with the newer Include macro.
  • Include Topic Macro - Includes text from another document. This macro is now marked as deprecated and replaced with the newer Include macro.
  • Info Macro - Displays an informational message in a styled box format, using an information icon. This macro is now marked as deprecated and replaced with the newer Info macro.
  • Jabber Macro - Displays an online status indicator for a given Jabber account id. This macro is now marked as deprecated.
  • Livetable Macro - Displays a dynamic, filterable and sortable table of data. 
  • MSN Macro - Displays an online status indicator for the given MSN messenger account id. This macro is now marked as deprecated.
  • Put Footnotes Macro - Displays the footnotes mentioned so far in the wiki code and resets the footnote counter. Currently, we are using the "xwiki/2.0" syntax Put Footnotes Macro.
  • Skype Macro - Displays an online status indicator for a given Skype user name. This macro is now marked as deprecated.
  • Template Macro - Allows you to copy the script passed as argument into your own script.
  • Table Of Contents Macro - Generates a Table Of Content for headings in a document. Currently, we are using the "xwiki/2.0" syntax TOC Macro.
  • User Avatar Macro - Displays the avatar of a user or the standard image "noavatar.png" if the user has no avatar. 
  • Warning Macro - Displays a warning message in a styled box format, using a warning icon. This macro is now marked as deprecated and replaced with the newer Warning Macro.
  • Yahoo Macro - Displays an online status indicator for the given Yahoo Messenger account id. This macro is now marked as deprecated.

Search this space