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 MyWiki

Last modified by Ryan C on 2025/05/14 13:49

From 7.1 to 8.1 From 10.1 to 11.1

From version

edited by Ryan C
on 2025/04/28 06:25

Change comment: Rollback to version 3.1

To version

edited by Ryan C
on 2025/04/28 06:27

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,0 +1,329 @@
++= 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}}
++
++