Category | Macro |
Active Installs | 0 |
Rating | |
License | GNU Lesser General Public License 2.1 |
Minimal XWiki version supported | XWiki 13.10 |
Sources | Issues |
Macros are how you take XWiki's functionality to the next level. They can be used to:
- Display content in a more visually appealing manner or highlight important information
- Embed documents, such as PDF or Office files or display diagrams
- Show the relations between XWiki pages and improve navigation
- Display media, such as videos and audio
All Pro Macros are dedicated for formatting content on any XWiki instance, no matter the usecase. For Confluence Migration specific macros please visit our Confluence Migration Toolkit.
List of Macros
- Button
- Contributors
- Content Report Table
- Excerpt
- Excerpt Include
- Expand
- MsStream
- Panel
- Profile Picture
- Status
- Team
- Recently Updated
- User List
- User Profile
- View Files
Inserting a macro
To insert a macro you should edit the page:
- Type "/" in your editor and type the name of the macro
- For XWiki versions 14.x and older, click on the "+" icon from the editor
- Select the macro from the list
- Fill in the needed parameters
- Click "Submit"
Editing a macro
Macros can be edited by double clicking on the macro in the visual editor. Alternatively, you can edit the syntax of the macro by going to the page's source. The supported parameters, as well as the syntax, are detailed in the Documentation tab for each macro.
- Button
- Contributors
- Content Report Table
- Excerpt
- Excerpt Include
- Expand
- Microsoft Stream
- Panel
- Profile Picture
- Status
- Team
- Recently Updated
- User List
- User Profile
- View File
Button
Insert a noticeable, clickable button on your XWiki page to highlight links and create call to actions.
Parameters
Name | Description | Default |
---|---|---|
label | The label of the button. | - |
url | A link or a page reference. | - |
color | The color of the button. | White |
width | The width of the button specified in pixels, percentage or other valid CSS value (ex. 30px, 30%, 30em). If no value is specified, the width will be determined by the length of the label. | - |
newTab | Denotes whether the page will be opened in a new page or not. | false |
icon | Icon associated with the button, placed before the label. |
Examples
{{button label="Store" url="http://store.xwiki.com" color="#889cb8"/}}
{{button label="Store" url="http://store.xwiki.com" color="#889cb8" newTab="true" icon="page"/}}
{{button label="Store" url="http://store.xwiki.com" color="#889cb8" newTab="true" icon="page" width="100%"/}}
Results in
Contributors
Contributors macro shows the contributors of a given page based on defined parameters.
Parameters
Parameter | Name | Default | Description |
---|---|---|---|
include | Include | authors |
Several values can be given, separated by commas. Values "labels" and "watches" are not supported in this bridge macro. |
order | Order | count | Possibles values:
|
reverse | Reverse | false | reverse the order specified in the order parameter. |
limit | Limit | no limit | Show at most the given number of contributors. |
mode | Mode | inline | Possible values are:
|
showCount | Show count | false | Show the contribution count for each user. |
showLastTime | Show last time | false | Show the last contribution time for each user. |
page | Page | current | The page for which to list the contributions. If both page and space are empty, the current page is used. |
spaces | Spaces | current | Space(s) containing the page specified in the page parameter, or the space(s) to search. Several spaces can be specified using commas. @global and @ALL will search in the whole wiki. |
scope | Scope | specified page only | Possible values:
|
showPages | Show Pages | false | Show the list of pages used to build the list of contributors |
noneFoundMessage | None Found Message | default message | The message to show when no contributors are found. |
Examples
Results in
Content Report Table
This macro provides a content report in a table format based on tags .
Parameters
Parameter | Description | Required | Default |
---|---|---|---|
labels | The tags to report on, separated by comma. | Yes | |
spaces | The space (parent page) names to report on, separated by a comma and a blank space (e.g: "Test, XWiki") | No | |
maxResults | Maximum Number of results (pages). | No | 20 |
Examples
Results in:
Excerpt
The Excerpt macro allows the user to mark part of the page's content for use by other macros. The macro can also be used to hide part of the content of a page.
Parameters
Parameter | Description | Default |
---|---|---|
hidden | If true, the content of the macro will be hidden. | false |
name | The name of the excerpt, for named includes. | false |
allowUnprivilegedInclude | Allow this excerpt to be seen even for people who don't have view rights on this page when included | false |
Example
|=Title1|=Title2|=Title3
|Text1|Text2|Text3
{{/excerpt}}
Results in:
Example of hidden excerpt:
My hidden content.
{{/excerpt}}
Excerpt Include
The Excerpt Include macro allows the user to include contents from other pages marked by other macros with the Excerpt Macro.
Parameters
Parameter | Description | Mandatory |
---|---|---|
0 | The page to include | Yes |
Example
Expand
This macro allows you to insert an expandable section, with a title and content.
Parameters
Parameter | Name | Description | Default |
---|---|---|---|
title | Title | Title of the section, displayed when the section is collapsed | |
content | Content | Content visible when the section is expanded |
Example
In pharetra fermentum est, non dapibus orci congue eget. Curabitur scelerisque dui vitae sagittis aliquam. Etiam tincidunt mattis ultrices. Integer felis magna, sodales sit amet finibus id, efficitur nec nulla. Ut volutpat tellus id bibendum scelerisque. Fusce ut massa nulla. Donec ullamcorper elit vitae metus condimentum, sed varius eros luctus. Etiam elit mi, finibus sed nibh a, facilisis eleifend orci.
{{/expand}}
Results in:
Microsoft Stream
This macro provides a way for embedding a Microsoft Stream video in a page.
Parameters
Parameter | Name | Description | Required | Default |
---|---|---|---|---|
url | URL | The URL to the Microsoft Stream video. | Yes | |
width | Width | The viewer width. Can be specified either in pixels (for example, 400px) or as a percentage of the available page width (for example, 50%). | No | 500px |
height | Height | The viewer height. Can be specified either in pixels (for example, 400px) or as a percentage of the available page height (for example, 50%). | No | 300px |
alignment | Alignment | Position of the video relatively to its container. Accepted values are left, center and right. | No | |
start | Start At | Start video at a specific time (use HH:MM:SS as time format). | No | 00:00:00 |
showinfo | Show Info | Show the video info on thumbnail. | No | true |
autoplay | Auto Play | Whether the video should start automatically or if the user must play it. | No | false |
textWrap | Text Wrap | Wrap text around the video. This applies only to left and right alignment. | No | true |
Example
Results in:
Panel
The Panel macro allows you to display XWiki content inside a visually appealing panel. You can customize its size, colours and border.
Parameters
Parameter | Name | Default value | Description |
---|---|---|---|
title | Title | - | If specific a title section is added with the specific text |
bgColor | Background color | - | If specific sets the background color of the content of the panel |
width | Width | - | If specified sets the width of the panel (300px or 50%) |
height | Height | - | If specified sets the width of the panel (300px or 50%) |
classes | CSS classes | - | If specified adds css classes to the panel |
borderColor | Border color | white | If specified sets the panel border color |
borderStyle | Border style | solid | If specified sets the css border style |
borderWidth | Border width | 1px | If specified sets the border width in pixels |
borderRadius | Border radius | 8px 8px 0px 0px | If specified replaces the default border radius |
titleBGColor | Title background color | - | If specified sets the title section background color |
titleColor | Title text color | - | If specified sets the title text color |
Examples
Simple panel
Content of the panel
{{/panel}}
Results in:
Simple panel with border and size
Content of the panel
{{/panel}}
Results in:
Panel with title and colors
Content of the panel
{{/panel}}
Results in:
Panel with title and colors and border
Content of the panel
{{/panel}}
Results in:
Panel with bootstrap classes
Content of the panel
{{/panel}}
Results in:
Profile Picture
Display avatars of the members of a team.
Parameters
Parameter | Name | Description |
---|---|---|
User | User | The reference to the user. |
Examples
Status
The Status macro helps you highlight the status of an item using a colored box. You can customize both the text and the background color. The background can be either lightly colored, or dark, depending on your preference. The macro can be used inside other macros.
Parameters
Parameter | Name | Default value | Description |
---|---|---|---|
title | Title | The color name | The text of the status. If not specified, the color name will be displayed (e.g.:"Grey"). |
colour | Color | Grey | The color of the status (text color and background color). The following colors are available: "Blue", "Green", "Grey", "Purple", "Red" and "Yellow". |
subtle | Subtle | False | The aspect of the status: either white text on dark color background or dark color text on light color background. It should be filled with "true" or "false". |
Examples
{{status title="Improvement" colour="Green" subtle="true"/}}
Team
A macro that displays avatars of the members of a team, filterable by numerous parameters.
Parameters
Parameter | Name | Description | Default |
---|---|---|---|
tag | Tag | Tag that users need to have to be shown | |
users | Users | Restrict to this list of user names (don't prefix with the wiki identifier) | |
size | Size | The size (height and width) of an avatar | 60 |
showUsernames | Show Usernames | The name of users should be displayed under their avatars | false |
letterAvatarBgColor | Letter Avatars Background Color | The background color of the letter avatars | #0A6 |
letterAvatarFontColor | Letter Avatars Font Color | The font color of the letter avatars | white |
disableLetterAvatars | Disable Letter Avatars | Don't use letter avatars and display a default avatar instead | false |
requireExternalAuth | Require External Auth | The user should be searched in LDAP or OAuth | false |
limit | Limit | The maximum number of people to show (0 turns off the limit) | 100 |
scope | Scope | The scope of the query used to find users. "global": in the main wiki. "local": in the current wiki. "both": in both the main wiki and the local wiki. "auto": find out from the wiki settings. Has no effect in the main wiki. | auto |
Examples
All users
Results in:
All users, no LDAP or OpenIDC requirements, bigger
Results in:
All users, no LDAP or OpenIDC requirements, some colors
Results in:
All users, with LDAP or OpenIDC requirements
All users with names, disable tools
Results in:
All users with names, disable letter avatars, only in the main wiki
Results in:
Recently Updated
This macro allows you to display the most recently updated pages, blog posts, and attachments. You can filter by space, labels (tags), author (last editor) and you can further customise the display through the maximum number of results, theme, show user profile and hide title parameters.
Parameters
Parameter | Description | Required | Default |
---|---|---|---|
types | Comma-separated list of types ( page , blogpost , comment or attachment ), possibly prefixed with "-". | No | all types |
spaces | Comma-separated list of spaces, possibly prefixed with "+" or "-", or special value like @self , @global or @all . | No | @self |
author | Comma-separated list of authors. | No | |
labels | Comma-separated list of tags, possibly prefixed with "+" or "-". | No | |
max | Maximum number of results. | No | 15 |
theme | Appearance of the macro ( concise , social , sidebar ). | No | concise |
width | Width of the macro in percentage. | No | 100% |
hideHeading | Whether to hide the text "Recently Updated" as title | No | false |
showProfilePic | Whether to show the profile picture of users | No | false |
Example
Results in:
User List
The macro allows displaying a custom list of users in a table with a set of configurable properties.
Parameters
Parameter | Name | Description | Default |
---|---|---|---|
users | Users | List of users to be displayed | |
properties | Properties | List of user properties to be displayed | avatar,username |
Example
Results in:
User Profile
The macro allows to display a user with their attributes in a box.
Parameters
Parameter | Name | Description | Default |
---|---|---|---|
reference | Reference | Reference to a user page | |
properties | Properties | List of user properties to be displayed, separated by a comma | company,email,phone,address |
Example
Results in:
View File
The View Files macro allows you to embed an Office or a PDF document inside an XWiki page or display a thumbnail for office documents and other types of attachments such as images and videos. You will need to attach the document to the page.
Parameters
Parameter | Description | Required | Default |
---|---|---|---|
display | Kind of display. "button" for a button, "thumbnail" for a thumbnail, "full" to render the document in place | no | thumbnail (button in inline mode) |
name | The attachment reference to display | if att-filename is not given | |
width | The width of the view in % or px (e.g. 100%, 100px) | no | 100% for the full view or 100px for the thumbnail |
height | The height of the view in % or px (e.g. 100%, 100px) | no | 1000px for the full view or 100px for the thumbnail |
att-filename | Alias of name, here for compatibility reasons | If name is not given |
Example
{{view-file display="button" name="migration-gif-2.mp4"/}}
{{view-file display="full" name="XWikiSAS.pdf" height="600"/}}
Results in
Installation Steps
This paid extensions requires XWiki 13.10 or above. In order to install the extension, follow the next steps inside your XWiki instance (on cloud or on premise).
Navigate to the Extension Manager
In the Applications Panel click on "More Applications..." and then "Install new applications...". Alternatively navigate directly to the Administration and select the "Extensions" section.
Install the Extension
Search for the extension you wish to install and use the Install button to install it.
Get a License
Navigate to the "Licenses" section of the Administration, fill your details, look for the extension you just installed in the live table and click the buttons to get a trial license or to buy a license.
Install the License
If you have selected a trial license then you're good and there's nothing else to do. Your trial license is automatically installed.
However if you've selected to buy a license you'll be redirected to a page to perform the payment. At the end you need to come back to the "Licenses" administration section and click on the "Check for Updates" button. This will download and apply the license you bought.
Use the Extension
Start using the Extension! Refer to the extension's documentation to know how to use it.
Installing Paid Apps on Subwikis
If you want to install an application on the whole farm (main wiki + subwikis), you can do so directly from the main wiki’s Extension Manager, as seen below:
Extensions can also be installed only on a particular subwiki by global admins. Subwiki admins will not be able to install these extensions due to their limited rights.
Options
The price is per year and varies depending on the support level and the number of users.
Support / Users | 10 | 25 | 50 | 100 | 250 | 500 | 1000 | 2500 | 5000 | 10000 | 20000 |
---|---|---|---|---|---|---|---|---|---|---|---|
Silver |
Benefits
What do you get when you purchase an XWiki extension?
1 year license
By purchasing an XWiki extension license, you'll benefit from it during one year.
Free updates
You benefit from all the extension updates during one year. You are always up to date.
Support included
If you are facing an issue, you can reach the XWiki support. Our team is always available to help.
How to Buy
To buy, install this extension from inside your XWiki instance and follow the instructions.
Release notes
v1.22.0
- #331: The detailssummary macro ignores details macros having an id if it doesn't have one
- #330: Add a basic bridge for outgoing-links
- #257: Can't save a page with 2 Excerpt macros
- #318: Conversion from Confluence fails without visible error message
v1.21.0
- #326: Gliffy and drawio confluence bridges don't show converted diagrams if a tilde appears in the document name
- #324: Cannot invoke "String.isEmpty()" because "aqlStatement" is null when both "labels" and "cql" are empty for CQL macros
- #301: Use the first title or child panel's title as the default title of Expand
v1.20.0
#262: Added the tag list macro.
v1.19.3
More work around for licensing issues:
- https://github.com/xwikisas/xwiki-pro/issues/34
- https://github.com/xwikisas/application-licensing/issues/174
v1.19.2
- #288: Handle the situation when a bridge corresponding to a legacy unprefixed Confluence bridge is not found
v1.19.1
- #286: Pro Macros license not seen as valid after an upgrade to version 1.19.0
- #244: Team macro not working when selecting a Tag
- #246: Expand Macro Content is Not Displayed in a PDF Export
v1.19.0
- #195: Add support for the "nopanel" parameter in excerpt-include macro
- #105: Add what is needed to implement macros using CQL statements
- #83: Implement the "contentbylabel" Confluence bridge macro
- #60: Implement details (Page Properties) and detailsummary (Page Property Report) CQL macros
- #283: View Files: Use a fallback for thumbails on older XWiki versions
- #282: Make Excerpt Include show an error when the target document is not found
- #281: Excerpt Include doesn't show content for hidden excerpts
- #280: PageTree: no results when a space is passed as root without ".WebHome"
- #277: Separate Confluence bridges from XWiki SAS's own Pro macros
v1.18.3
- #276: View-file macro: define parameter types for display and name to ease value selection
v1.18.2
- #275: View-file macro: missing preview
v1.18.1
- #274: View-file Macro: add a download button in the preview modal
- #273: View-file macro: make the thumbnail display the default
- #272: View-file macro: don't render documents in edit mode
- #271: View-file macro: support inline mode
- #270: View-file macro: don't render documents ahead of time
- #268: View-file macro: make parameter values for display lower case
- #265: Named excerpt-include should fail when no excerpt with a matching name is found
v1.18.0
- #239: Improve display of view-file macro
- #258: Recently Updated macro does not provide result when the author parameter is not set
- #263: Obscure "The required content is missing" error when license is missing for a Pro macro implemented in Java
- #264: Support the MultiExcerpt family of macros
v1.17.3
- #258: Recently Updated macro does not provide result on example page
v1.17.2
- #255: The Recently Updated macro shows not results if the author parameter is set to a user other than superadmin
v1.17.1
- #245: Recently Updated macro cannot be inserted in the WYSIWYG editor
Updated Location Search dependency to version 1.3.
v1.17.0
- #250: Add Search Location Macro as an optional dependency to Pro Macros
v1.16.6
- #249: Better resolution for reference parameters in pagetree and recently-updated
v1.16.5
PDF Viewer dependency upgrade to version 2.5.4.
v1.16.4
- #238: Recently Updated doesn't handle space characters in the space name
- #237: Recently updated macro gives out XWikiDateTool error in the logs
- #213: The panel macro cuts off content that is too wide
- #208: Columns don't provide a WYSIWYG experience in edit mode
v1.16.3
- #232: Allow block macros in the Expand macro
v1.16.2
- #231: pagetree does not always point to the correct location
- #223: Weird characters preventing Expand from being installed on some setups
v1.16.1
- #222: Support .macro-section and .macro-layout-section.single
v1.16.0
Fixes:
- #211: The icon of inner Expand macro changes into collapse when collapsing the outer
New features:
- #220: Create a confluence_children macro
v1.15.1
Fixes:
- #191: Real content hidden due to hiding auto-cursor-target class
v1.15.0
Fixes:
New features:
- #216: Support background / highlight colors
- #217: Work around empty paragraphs artifacts of the Confluence WYSIWYG editor
v1.14.5
Bug fixes:
- #190 Excerpt-include macro does not display images from excerpt
- #192 The excerpt-include macro is named Excerpt
Upgrades:
- #212 Upgrade Licensor dependency to version 1.25
v1.14.4
Bug fixes:
- #197 User cannot open second Expand macro containing display macro call if first page reference contains a page that also uses the Expand macro
- #209 Recently Updated macro does not load when there is a comment on a child page that contains special characters [ or ] in its title
- #178 Recently Updated macro returns no results if a space was provided by name
v1.14.3
Bug fixes:
- #180 Some macros are not working on XWiki 15.5 and higher
- #193 The PageTree Confluence bridge macro's root parameter is incorrectly mandatory
v1.14.2
Bug fixes:
- #187 Mathinline uses MathJax's display mode instead of inline
v1.14.1
Fix:
- #185 Slowness due to the presence of mathjax-latex
- We excluded unneeded latex-related extensions from the dependencies so they don't get installed and cause issues.
v1.14.0
New features:
- #184 Implement the mathinline, mathblock and mathblock-ref Confluence bridge Macros
Fixes:
- #170 Installation logs of Extension Manager display warning related to unknown property
- #181 Float for user avatar is not cleared in the Userlist Macro's responsive mode
v1.13
New features:
- #107 Create the pagetree bridge macro
- #26 Implement the Excerpt Include confluence bridge macro
- #106 Create the contributors bridge macro
Improvements:
- #175 Replace deprecated method $mathtool.toNumber with $numbertool.toNumber in Content Report Table Macro
- #122 [userprofile] blurry user profile pictures
Bugs fixed:
- #171 The Tip macro is missing a description
- #177 The Layout macros are missing descriptions
- #46 Content Report Table Macro - Spaces aren't kept in the pages migrated from Confluence to XWiki
- #39 Improve the Multimedia Macro parameters
- #174 Unused att- -filename parameter in Layout cell macro
Upgrades:
- #179 Upgrade Licensor dependency to version 1.24.3
v1.12
Bugs fixed:
- #142 Errors appear in the wiki console when adding the Recently Updated macro
Improvements:
- #148 Recently Updated macro: improvements to layout
v1.11.0
Fixes and improvements:
- #108 Create the profile-picture macro
- #78 Depend on Diagram Pro
- #116 Make user list responsive
- #114 Deduplicate users in the userList macro
- #163 Add support for the time macro
- #65 Add the Parameters column and translate the names in the Status macro description
v1.10.1
Fix:
- #165 The Recently Updated macro is not filtering properly on spaces
Misc:
- Improve macro parameter escaping
v1.10
Bugs fixed:
- #135 The "<" symbol causes issues in the title
- #136 File isn't shown when it contains a comma in the title
- #138 File that has special chars in title can't be played
- #143 The "Show more" button of the Recently Updated macro does nothing after editing
- #147 Unable to add the Recently Updated macro from the WYSIWYG editor
- #149 The Recently Updated Macro shows hidden pages
Regressions fixed:
- #131 [Regression] The attachments list is not displayed on XWiki 14.4.3 (error loading data)
- #132 [Regression] It's not possible to upload new files with the attachments macro anymore
- #153 [Regression] Missing actions for the "Attachments" macro
Upgrades:
- PDF Viewer Macro dependency to version 2.5.2
v1.9.3
Bugs fixed:
- #118 "column" macro should work without content.
- #140 The avatars show with different size
- #160 UserList macro fires a NullPointerException due to conflict on WikiDescriptorManager field
v1.9.2
Bugs fixed:
- #151 Recently Updated Macro displays an error on pages with different locales
v1.9.1
Bugs fixed:
- #144 Link not converted well when used within note macro
- #146 UserList and UserProfile macros work without license
v1.9
Bugs fixed:
- #124 The example usage on the attachments macro page (Confluence.Macros.Attachments) is using the old name of the attachments macro
- #126 Inline rendering converted into block
- #129 Upgrade parent to 13.10-3
Tasks done:
- #133 Upgrade parent to 13.10-3
Upgraded licensing version to 1.24.1.
v1.8.1
Bugs fixed:
- #125 In UserList macro, the parameter for setting a fixed layout is not taken into account
v1.8
New features:
Bugs fixed:
- #112 Adapt the attachments macro to the new livetable attachments view
- #113 The content of the columns from stacked user lists is not aligned
v1.7.1
Improvements:
- #119 Add text wrapping option for MS Stream macro
Bugs fixed:
- #110 Add warning when adding macros without a license
v1.7
New Features:
v1.6.1
Bugs fixed:
- #99 Diagram is empty after conversion from drawio
v1.6
New Features:
v1.5
Improvements on the Team macro:
- Fix usernames not being shown
- Support subwikis through the scope parameter
- Fix links, which now point to the user profiles
v1.4
New Macro:
- Team, to show the avatars of a team
- User List, to display a custom list of users with their avatar and properties
- User Profile, to display a user card
Support for new Confluence Macros:
- Drawio
- Tip
v1.3
New Features:
#64 Create a button macro
#69 Develop a Microsoft Stream macro
<p>Update the PDF Viewer dependency version to 2.4
Update the Licensing dependency version to 1.22.1
v1.2.2
Update the PDF Viewer dependency version to 2.3.3
Update the Licensing dependency version to 1.22
v1.2.1
Update the licensor and PDF Viewer versions.
v1.2
Update parent version to 11.10.
Extension details
License
- GNU Lesser General Public License 2.1
Sources
Issues
Type
- xar
Developed by
Compatibility
- Requires XWiki 13.10 or above.
Dependencies
- com.xwiki.licensing:application-licensing-licensor-api 1.25
- com.xwiki.pdfviewer:macro-pdfviewer-ui 2.5.5
- org.xwiki.platform:xwiki-platform-rendering-wikimacro-store 13.10
- org.xwiki.contrib:location-search-macro 1.4.3
- com.xwiki.date:macro-date-ui 3.5.0
- com.xwiki.pro:xwiki-pro-macros-api 1.22.2