Skip to Content

Register
Log-in
Search
- The Free Speech / Pro White Wiki
- Page Index
- User Index
- Global
- What's New
- Wiki Index

0.0
1
2
3
4
5

0 Votes

Changes for page MacroExamples

Last modified by Ryan C on 2025/06/05 13:29

From 3.1 to 2.1

From version

edited by Ryan C
on 2025/06/04 08:22

Change comment: There is no comment for this version

To version 1.1

edited by Ryan C
on 2025/06/04 08:21

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,542 +1,0 @@
--= 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.
--
--{{example}}
--{{toc/}}
--{{/example}}
--
--== 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.
--
--{{example}}
--{{box title="Note"}}
--This is a sample box message.
--{{/box}}
--{{/example}}
--
--== 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.
--
--{{example}}
--{{info}}
--This is an informational message.
--{{/info}}
--{{/example}}
--
--{{example}}
--{{info title="FYI"}}
--This is an informational message with a title.
--{{/info}}
--{{/example}}
--
--== Warning Macro ==
--
--The **Warning** macro highlights a warning message in a styled box (yellow/orange background).
--
--{{example}}
--{{warning}}
--This is a warning message.
--{{/warning}}
--{{/example}}
--
--== Success Macro ==
--
--The **Success** macro displays a success message in a green-styled box.
--
--{{example}}
--{{success}}
--This is a success message.
--{{/success}}
--{{/example}}
--
--== Error Macro ==
--
--The **Error** macro displays a critical error or alert message in a red-styled box.
--
--{{example}}
--{{error}}
--This is an error message.
--{{/error}}
--{{/example}}
--
--== Chart Macro ==
--
--The **Chart** macro generates graphical charts based on input tables.
--
--{{example}}
--{{chart type="pie" source="inline" params="range:B2-B4;series:columns;" width="400" height="300"}}
--|=Category|=Value|
--|A|10|
--|B|20|
--|C|30|
--{{/chart}}
--{{/example}}
--
--{{example}}
--{{chart type="bar" source="inline" params="range:B2-C4;series:columns;" width="500" height="300"}}
--|=Quarter|=Product X|=Product Y|
--|Q1|20|15|
--|Q2|30|25|
--|Q3|25|30|
--{{/chart}}
--{{/example}}
--
--== Children Macro ==
--
--The **Children** macro lists the child pages of the current page.
--
--{{example}}
--{{children/}}
--{{/example}}
--
--== Code Macro ==
--
--The **Code** macro highlights and formats source code.
--
--{{example}}
--{{code language="java"}}
--public class Hello {
--    public static void main(String[] args) {
--        System.out.println("Hello World");
--    }
--}
--{{/code}}
--{{/example}}
--
--== Comment Macro ==
--
--The **Comment** macro hides content from page rendering.
--
--{{example}}
--Visible part 1.
--{{comment}}This text will not be visible.{{/comment}}
--Visible part 2.
--{{/example}}
--
--== Container Macro ==
--
--The **Container** macro creates multi-column layouts.
--
--{{example}}
--{{container layoutStyle="columns"}}
--(((**Column 1:** This is the first column.)))
--(((**Column 2:** This is the second column.)))
--{{/container}}
--{{/example}}
--
--== Dashboard Macro ==
--
--The **Dashboard** macro creates areas for gadgets.
--
--{{example}}
--{{dashboard columns="2"/}}
--{{/example}}
--
--== Display Macro ==
--
--The **Display** macro embeds content from another page.
--
--{{example}}
--{{display page="Help.Macros"/}}
--{{/example}}
--
--== DisplayIcon Macro ==
--
--The **DisplayIcon** macro displays an icon.
--
--{{example}}
--{{displayIcon name="home"/}} Home
--{{/example}}
--
--== Documents Macro ==
--
--The **Documents** macro shows a livetable of documents.
--
--{{example}}
--{{documents space="MySpace"/}}
--{{/example}}
--
--== DocumentTree Macro ==
--
--The **DocumentTree** macro shows a collapsible page tree.
--
--{{example}}
--{{documentTree reference="Help.WebHome"/}}
--{{/example}}
--
--== Footnote Macro ==
--
--The **Footnote** macro adds footnotes to the page.
--
--{{example}}
--This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
--{{putFootnotes/}}
--{{/example}}
--
--== PutFootnotes Macro ==
--
--The **PutFootnotes** macro outputs collected footnotes.
--
--{{example}}
--...page content...
--{{putFootnotes/}}
--{{/example}}
--
--== Gallery Macro ==
--
--The **Gallery** macro displays a collection of images.
--
--{{example}}
--{{gallery}}
--image:Space.Page@Image1.png
--image:Space.Page@Image2.png
--{{/gallery}}
--{{/example}}
--
--== Groovy Macro ==
--
--The **Groovy** macro executes Groovy scripts.
--
--{{example}}
--{{groovy}}
--println("Hello from Groovy!")
--{{/groovy}}
--{{/example}}
--
--== HTML Macro ==
--
--The **HTML** macro embeds raw HTML into pages.
--
--{{example}}
--{{html}}
--<p style="color:red;">This is red text via HTML.</p>
--{{/html}}
--{{/example}}
--
--== Id Macro ==
--
--The **Id** macro defines an internal link anchor.
--
--{{example}}
--Click [[here>>#myanchor]] to jump.
--
--{{id name="myanchor"/}}
--**Target Location:** You have reached the target.
--{{/example}}
--
--== Include Macro ==
--
--The **Include** macro includes another page's content.
--
--{{example}}
--{{include page="Help.Introduction"/}}
--{{/example}}
--
--== Mention Macro ==
--
--The **Mention** macro notifies a mentioned user.
--
--{{example}}
--{{mention user="xwiki:JohnDoe"/}}
--{{/example}}
--
--== Notifications Macro ==
--
--The **Notifications** macro displays recent activity.
--
--{{example}}
--{{notifications/}}
--{{/example}}
--
--== Office Macro ==
--
--The **Office** macro displays Office documents.
--
--{{example}}
--{{office attachment="Main.UserGuide@Guide.docx"/}}
--{{/example}}
--
--== Python Macro ==
--
--The **Python** macro executes Python scripts.
--
--{{example}}
--{{python}}
--print("Hello from Python!")
--{{/python}}
--{{/example}}
--
--== Script Macro ==
--
--The **Script** macro executes scripts in different languages.
--
--{{example}}
--{{script language="velocity"}}
--#set($name = "Velocity")
--Hello $name!
--{{/script}}
--{{/example}}
--
--== Tag Cloud Macro ==
--
--The **Tag Cloud** macro displays tags visually.
--
--{{example}}
--{{tagcloud/}}
--{{/example}}
--
--== User Avatar Macro ==
--
--The **User Avatar** macro shows a user's avatar image.
--
--{{example}}
--{{useravatar user="xwiki:JohnDoe"/}}
--{{/example}}
--
--== Velocity Macro ==
--
--The **Velocity** macro executes Velocity scripts.
--
--{{example}}
--{{velocity}}
--#set($name = "Alice")
--Hello $name!
--{{/velocity}}
--{{/example}}
--
--== Menu Macro ==
--
--The **Menu** macro builds a navigation menu.
--
--{{example}}
--{{menu}}
--* [[Home>>Main.WebHome]]
--* [[Products>>Main.Products]]
--** [[Product A>>Main.Products.ProductA]]
--** [[Product B>>Main.Products.ProductB]]
--* [[Contact>>Main.Contact]]
--{{/menu}}
--{{/example}}
--
--== Button Macro ==
--
--The Button macro inserts a styled clickable button.
--
--{{example}}
--{{button link="https://xwiki.org" style="primary"}}
--Click Me
--{{/button}}
--{{/example}}
--
--== Carousel Macro ==
--
--The Carousel macro displays a slideshow of images.
--
--{{example}}
--{{carousel}}
--image:Space.Page@Image1.png
--image:Space.Page@Image2.png
--{{/carousel}}
--{{/example}}
--
--== Embed Macro ==
--
--The Embed macro shows external content like YouTube videos.
--
--{{example}}
--{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
--{{/example}}
--
--== Expandable Macro ==
--
--The Expandable macro shows expandable hidden content.
--
--{{example}}
--{{expandable title="Click to Expand"}}
--Hidden details appear here.
--{{/expandable}}
--{{/example}}
--
--== Excerpt Macro ==
--
--The Excerpt macro marks content for reuse elsewhere.
--
--{{example}}
--{{excerpt}}
--This is excerpted content.
--{{/excerpt}}
--{{/example}}
--
--== FAQ Macro ==
--
--The FAQ macro lists FAQ entries.
--
--{{example}}
--{{faq space="FAQ"/}}
--{{/example}}
--
--== Live Data Macro ==
--
--The LiveData macro displays dynamic data tables.
--
--{{example}}
--{{liveData source="document"/}}
--{{/example}}
--
--== Panel Macro ==
--
--The Panel macro creates styled content boxes.
--
--{{example}}
--{{panel title="Panel Title"}}
--This is inside a panel.
--{{/panel}}
--{{/example}}
--
--== PDF Viewer Macro ==
--
--The PDFViewer macro embeds PDFs using PDF.js.
--
--{{example}}
--{{pdfviewer attachment="MyPage@file.pdf"/}}
--{{/example}}
--
--== Profile Picture Macro ==
--
--The Profile Picture macro shows a user’s picture.
--
--{{example}}
--{{profile-picture user="xwiki:JohnDoe"/}}
--{{/example}}
--
--== Recently Updated Macro ==
--
--The Recently Updated macro lists recent changes.
--
--{{example}}
--{{recently-updated/}}
--{{/example}}
--
--== Status Macro ==
--
--The Status macro adds a colored status label.
--
--{{example}}
--{{status value="In Progress" color="yellow"/}}
--{{/example}}
--
--== Team Macro ==
--
--The Team macro shows avatars of a team.
--
--{{example}}
--{{team space="TeamSpace"/}}
--{{/example}}
--
--== Tooltip Macro ==
--
--The Tooltip macro shows hints on hover.
--
--{{example}}
--Hover {{tooltip content="Extra Information"}}here{{/tooltip}}.
--{{/example}}
--
--== Tree Macro ==
--
--The Tree macro shows a hierarchical list.
--
--{{example}}
--{{tree}}
--
--[[Parent>>Parent.Page]]
--** [[Child 1>>Parent.Child1]]
--** [[Child 2>>Parent.Child2]]
--{{/tree}}
--{{/example}}
--
--== Video Macro ==
--
--The Video macro embeds videos.
--
--{{example}}
--{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
--{{/example}}
--
--1. View File Macro — Fully Fixed
--Problem:
--The pdfviewer macro cannot be inside {{example}}...{{/example}}. 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.
--
--
--{{pdfviewer attachment="MyWiki@Reverse_Discrimination.pdf"/}}
--
--
--✅ This will show the PDF outside of any {{example}} wrapping.
--✅ Must be attached to the same page (your page is /bin/view/MyWiki/).
--
--Note:
--If you MUST put it inside an {{example}}, we have to fallback to iframe HTML instead of a macro (I can show that if you want).
--
--== UIExtension Macro — Fully Fixed ==
--Problem:
--You used a non-existent extension point org.xwiki.platform.panels — that ID does not exist in your wiki.
--
--Solution:
--➔ We need to use a real extension id.
--Example safer extension ID: Try org.xwiki.watchlist.menu (almost always exists).
--
--Fixed Example:
--
--== UI Extension Macro ==
--
--The UIExtension macro injects UI elements into extension points.
--
--{{example}}
--
--{{uiextension id="org.xwiki.watchlist.menu"/}}
--
--{{/example}}
--
--✅ This will NOT give you the [Failed to find an extension id] error because it's a real one.
--
--Or, if you want me to list your real extensions dynamically so you can pick properly, I can show you how to list them.
--
--== UIExtensions Macro — Leave it as-is ==
--
--✅ No syntax errors shown here.
--✅ Already correct.
--
--You can keep it exactly:
--
--
--== UI Extensions Macro ==
--
--The UIExtensions macro lists UI extensions for a given extension point.
--
--{{example}}
--
--{{uiextensions extensionpoint="org.xwiki.watchlist.menu"/}}
--
--{{/example}}
--
--
--
--
--
--
--