MyWiki
XWiki Macros Reference Guide
Macros in XWiki are reusable pieces of functionality that can be integrated inside pages. They allow you to insert dynamic content or apply special formatting using a simple syntax. Below is a list of available macros (excluding deprecated or internal macros) along with their descriptions and usage examples.
TOC Macro
The TOC macro generates a Table of Contents.
Unknown macro: example. Click on this message for details.
Box Macro
The Box macro draws a box around the content inside it. This is useful for highlighting important information or grouping related content in a styled panel.
Unknown macro: example. Click on this message for details.
Info Macro
The Info macro displays an informational message in a styled box. It is typically rendered with a blue color to denote general information.
Unknown macro: example. Click on this message for details.
Unknown macro: example. Click on this message for details.
Warning Macro
The Warning macro highlights a warning message in a styled box (yellow/orange background).
Unknown macro: example. Click on this message for details.
Success Macro
The Success macro displays a success message in a green-styled box.
Unknown macro: example. Click on this message for details.
Error Macro
The Error macro displays a critical error or alert message in a red-styled box.
Unknown macro: example. Click on this message for details.
Chart Macro
The Chart macro generates graphical charts based on input tables.
Unknown macro: example. Click on this message for details.
Unknown macro: example. Click on this message for details.
Children Macro
The Children macro lists the child pages of the current page.
Unknown macro: example. Click on this message for details.
Code Macro
The Code macro highlights and formats source code.
Unknown macro: example. Click on this message for details.
Comment Macro
The Comment macro hides content from page rendering.
Unknown macro: example. Click on this message for details.
Container Macro
The Container macro creates multi-column layouts.
Unknown macro: example. Click on this message for details.
Dashboard Macro
The Dashboard macro creates areas for gadgets.
Unknown macro: example. Click on this message for details.
Display Macro
The Display macro embeds content from another page.
Unknown macro: example. Click on this message for details.
DisplayIcon Macro
The DisplayIcon macro displays an icon.
Unknown macro: example. Click on this message for details.
Documents Macro
The Documents macro shows a livetable of documents.
Unknown macro: example. Click on this message for details.
DocumentTree Macro
The DocumentTree macro shows a collapsible page tree.
Unknown macro: example. Click on this message for details.
Footnote Macro
The Footnote macro adds footnotes to the page.
Unknown macro: example. Click on this message for details.
PutFootnotes Macro
The PutFootnotes macro outputs collected footnotes.
Unknown macro: example. Click on this message for details.
Gallery Macro
The Gallery macro displays a collection of images.
Unknown macro: example. Click on this message for details.
Groovy Macro
The Groovy macro executes Groovy scripts.
Unknown macro: example. Click on this message for details.
HTML Macro
The HTML macro embeds raw HTML into pages.
Unknown macro: example. Click on this message for details.
Id Macro
The Id macro defines an internal link anchor.
Unknown macro: example. Click on this message for details.
Include Macro
The Include macro includes another page's content.
Unknown macro: example. Click on this message for details.
Mention Macro
The Mention macro notifies a mentioned user.
Unknown macro: example. Click on this message for details.
Notifications Macro
The Notifications macro displays recent activity.
Unknown macro: example. Click on this message for details.
Office Macro
The Office macro displays Office documents.
Unknown macro: example. Click on this message for details.
Python Macro
The Python macro executes Python scripts.
Unknown macro: example. Click on this message for details.
Script Macro
The Script macro executes scripts in different languages.
Unknown macro: example. Click on this message for details.
Tag Cloud Macro
The Tag Cloud macro displays tags visually.
Unknown macro: example. Click on this message for details.
User Avatar Macro
The User Avatar macro shows a user's avatar image.
Unknown macro: example. Click on this message for details.
Velocity Macro
The Velocity macro executes Velocity scripts.
Unknown macro: example. Click on this message for details.
Menu Macro
The Menu macro builds a navigation menu.
Unknown macro: example. Click on this message for details.
Button Macro
The Button macro inserts a styled clickable button.
Unknown macro: example. Click on this message for details.
Carousel Macro
The Carousel macro displays a slideshow of images.
Unknown macro: example. Click on this message for details.
Embed Macro
The Embed macro shows external content like YouTube videos.
Unknown macro: example. Click on this message for details.
Expandable Macro
The Expandable macro shows expandable hidden content.
Unknown macro: example. Click on this message for details.
Excerpt Macro
The Excerpt macro marks content for reuse elsewhere.
Unknown macro: example. Click on this message for details.
FAQ Macro
The FAQ macro lists FAQ entries.
Unknown macro: example. Click on this message for details.
Live Data Macro
The LiveData macro displays dynamic data tables.
Unknown macro: example. Click on this message for details.
Panel Macro
The Panel macro creates styled content boxes.
Unknown macro: example. Click on this message for details.
PDF Viewer Macro
The PDFViewer macro embeds PDFs using PDF.js.
Unknown macro: example. Click on this message for details.
Profile Picture Macro
The Profile Picture macro shows a user’s picture.
Unknown macro: example. Click on this message for details.
Recently Updated Macro
The Recently Updated macro lists recent changes.
Unknown macro: example. Click on this message for details.
Status Macro
The Status macro adds a colored status label.
Unknown macro: example. Click on this message for details.
Team Macro
The Team macro shows avatars of a team.
Unknown macro: example. Click on this message for details.
Tooltip Macro
The Tooltip macro shows hints on hover.
Unknown macro: example. Click on this message for details.
Tree Macro
The Tree macro shows a hierarchical list.
Unknown macro: example. Click on this message for details.
Video Macro
The Video macro embeds videos.
Unknown macro: example. Click on this message for details.
- View File Macro — Fully Fixed
Problem:
The pdfviewer macro cannot be inside Unknown macro: example. Click on this message for details.
. It has to be standalone.
Solution 1: (Most Correct) Directly embed your PDF viewer like this:
View File Macro
The View File macro shows a file viewer for an attached file.
Unknown macro: pdfviewer. Click on this message for details.
✅ This will show the PDF outside of any Unknown macro: example. Click on this message for details.