Category | Macro |
Active Installs | 50 |
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 compatible with Atlassian Confluence macros imported during migrations (generic macros), with some of them specifically developed only to cover this need (macros used only in the context of Confluence migrations):
Generic Macros
- Panel
- Status
- View Files
- Note
- Paste Code
- Content Report Table
- Column
- Section
- Layout
- Multimedia
- Anchor
- Team
- User List
- User Profile
- Expand
- Recently Updated
Macros used only in the context of Confluence migrations
- Gliffy
- Balsamiq
- Mockup
- Confluence Gallery
- Excerpt
- Tip
- Drawio
- Attachments
Inserting a macro
To insert a macro you should edit the page:
- 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.
Generic Macros
Panel
The Panel macro allows you to display XWiki content inside a visually appealing panel. You can customize its size, colours and border.
This macro supports all Atlassian Confluence parameters as of version 7.9.
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
Simple panel with border and size
Content of the panel
Panel with title and colors
Title of the panel
Content of the panel
Panel with title and colors and border
Title of the panel
Content of the panel
Panel with bootstrap classes
Title of the panel
Content of the panel
Title of the panel
Content of the panel
Title of the panel
Content of the panel
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
Results in:
Check the parameters.Task
Results in:
Add a new status macro.Improvement
Results in:
Add a new status macro.Improvement
View Files
The View Files macro allows you to embed an Office or a PDF document inside an XWiki page. You will need to attach the document to the page. The supported file types are doc, docx, xls, xlsx, ppt, pptx, and pdf.
Any macro added as such in Confluence should be, when migrating, converted into a view-file macro and have a preview.
To display specific file types you can also use the following macros:
- View Doc
- View Pdf
- View Ppt
- View Xls
Example
Results in:
Note
Similar to the warning macro, the note macro is used to highlight important notes in a coloured panel.
Parameters
Parameter | Description |
---|---|
title | The title of the note. |
Example
This is my note with title.
{{/note}}
Results in:
Paste Code
Similar to the Code macro, the aim of this macro is to allow users to paste code snippets inside XWiki pages.
Parameters
Parameter | Description |
---|---|
language | The code language to be used for the representation. |
title | The title of the box containing the code. |
Example
class Simple{
public static void main(String args[]){
System.out.println("Hello World !");
}
}
{{/paste-code-macro}}
Results in:
Hello World Example
public static void main(String args[]){
System.out.println("Hello Java");
}
}
Content Report Table
This macro provides a content report in a table format based on tags (labels).
Parameters
Parameter | Description | Required | Default |
---|---|---|---|
labels | The labels (tags) to report on, separated by comma. | Yes | |
spaces | The space keys to report on, separated by a comma and a blank space (e.g: "Confluence, XWiki") | No | |
maxResults | Maximum Number of results (pages). | No | 20 |
Examples
Results in:
Column
The column macro lets you organise content in columns. This macro is used in conjunction with the Section macro, and provides more flexibility to the page layout.
Parameters
Parameter | Name | Description | |
---|---|---|---|
width | Width | The width of the column. Can be specified either in pixels (for example, 400px) or as a percentage of the available page width (for example, 50%). |
Examples
Simple column
Add the Section macro to a page to organise your content in sections and columns. This macro is used in conjunction with the Column macro.
{{/column}}
Results in:
Add the Section macro to a page to organise your content in sections and columns. This macro is used in conjunction with the Column macro.
Columns usage in Section
{{column width="250px"}}
Add the Section macro to a page to organise your content in sections and columns. This macro is used in conjunction with the Column macro.
{{/column}}
{{column width="300px"}}
Content in the column 2
{{/column}}
{{column width="300px"}}
Content in the column 3
{{/column}}
{{column width="250px"}}
Content in the column 4
{{/column}}
{{/section}}
Results in:
Add the Section macro to a page to organise your content in sections and columns. This macro is used in conjunction with the Column macro.
Content in the column 2
Content in the column 3
Content in the column 4
Section
Add the Section macro to a page to organise your content in sections and columns. This macro is used in conjunction with the Column macro to personalise the XWiki page layout.
Parameters
Parameter | Name | Description | Default value |
---|---|---|---|
border | Show Border | Select this option to draw a border around the columns, when they exist. | false |
Examples
Simple section without border
Content of a simple section, without border.
{{/section}}
Results in:
Content of a simple section, without border.
Simple section with border, no column
No border is added, because the borders are applied on columns, when they exist.
Content of a simple section, with border.
{{/section}}
Results in:
Content of a simple section, with border.
Simple section with border and column
{{column}}
Content of a simple section, with border.
{{/column}}
{{/section}}
Results in:
Content of a simple section, with border.
Section with 4 columns
{{column width="250px"}}
Content in the column 1
{{/column}}
{{column width="300px"}}
Content in the column 2
{{/column}}
{{column width="300px"}}
Content in the column 3
{{/column}}
{{column width="250px"}}
Content in the column 4
{{/column}}
{{/section}}
Results in:
Content in the column 1
Content in the column 2
Content in the column 3
Content in the column 4
Layout
The layout macro allows you to organize the content of your page, usually with the help of Layout Section and Layout Cell macros.
Examples
Two equal columns
{{layout-section ac:type="two_equal"}}
{{layout-cell}}
Lorem Ipsum is simply dummy text of the printing and typesetting industry.
{{/layout-cell}}
{{layout-cell}}
There are many variations of passages of Lorem Ipsum available.
{{/layout-cell}}
{{/layout-section}}
{{/layout}}
Results in:
Lorem Ipsum is simply dummy text of the printing and typesetting industry.
There are many variations of passages of Lorem Ipsum available.
Three equal columns
{{layout-section ac:type="three_equal"}}
{{layout-cell}}
Nemo enim ipsam voluptatem quia voluptas sit aspernatur.
{{/layout-cell}}
{{layout-cell}}
Nor again is there anyone who loves or pursues or desires to obtain pain of itself.
{{/layout-cell}}
{{layout-cell}}
To take a trivial example, which of us ever undertakes laborious physical exercise.
{{/layout-cell}}
{{/layout-section}}
{{/layout}}
Results in:
Nemo enim ipsam voluptatem quia voluptas sit aspernatur.
Nor again is there anyone who loves or pursues or desires to obtain pain of itself.
To take a trivial example, which of us ever undertakes laborious physical exercise.
Two columns, one behaving as sidebar on the right
{{layout-section ac:type="two_right_sidebar"}}
{{layout-cell}}
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos.
{{/layout-cell}}
{{layout-cell}}
Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus.
{{/layout-cell}}
{{/layout-section}}
{{/layout}}
Results in:
Two columns, one behaving as sidebar on the left
{{layout-section ac:type="two_left_sidebar"}}
{{layout-cell}}
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos.
{{/layout-cell}}
{{layout-cell}}
Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus.
{{/layout-cell}}
{{/layout-section}}
{{/layout}}
Results in:
Three columns, sidebar-content-sidebar
{{layout-section ac:type="three_with_sidebars"}}
{{layout-cell}}
On the other hand, we denounce with righteous indignation
{{/layout-cell}}
{{layout-cell}}
But in certain circumstances and owing to the claims of duty.
{{/layout-cell}}
{{layout-cell}}
On the other hand, we denounce with righteous indignation.
{{/layout-cell}}
{{/layout-section}}
{{/layout}}
Results in:
Multimedia
The Multimedia macro is a bridge between Confluence and XWiki. It uses the JW Player open-source embeddable media player for web sites, supporting many commonly-used audio and video formats.
Parameters
Parameter | Description | Required | Default |
---|---|---|---|
page | The page to which the multimedia file is attached | No | |
name | File name of the attached multimedia file. | Yes | |
width | The player width, in pixels. If not defined, the player tries to determine automatically the width from the played media file. | No | |
height | The player height, in pixels. If not defined, the player tries to determine automatically the height from the played media file. | No | |
autostart | If the parameter is set to true then the video or audio file will start playing as soon as the page is loaded. | No | false |
Examples
Video
Results in:
Loading the video player...
Audio
Results in:
Loading the video player...
Anchor
By including the Anchor macro in a page, you can link to a specific part of a page. Once you have added a link to the anchor, clicking on the link will bring you back to the location of the anchor.
Example
For anchor "test":
Link syntax:
Team
Parameters
Parameter | Name | Description | Default |
---|---|---|---|
tag | Tag | Tag that users need to have to be shown | |
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 | rendering.macro.team.parameter.scope.name | rendering.macro.team.parameter.scope.description | auto |
Examples
All users
- CG Certificate Generator
- DA Dorina Anton
- XN XWiki Network
- AMA Ana-Maria Anea
- AC Andreea Chirica
- AF Alexandru Farcasi
- AL Arnaud Laprévote
- AL Anca Luca
- AN Alexandra Nicolae
- AS Alexandra Siriciuc
- CA Camelia Andrei
- CA Clément Aubin
- CL Cédric Lamblin
- CR Clemens Robbenhaar
-
Dorina Anton
- IA Ilie Andriuță
- IB Iulia Balan
- JSD Jean-Sébastien Dennebouy
- KH Kévin Hoarau
- LC Lucian Chevereseanu
- LD Ludovic Dubost
- MB Mohamed Boussa
-
Marius Dumitru Florea
- MH Michael Hamann
- ML Manuel Leduc
- MO Marian Onofrei
- MP Mathieu Pace
- NP Nikita Petrenko
- OLF Oana-Lavinia Florean
- O(F Oana (Tăbăranu) Florea
- PP Paul Pantiru
- RJ Raphaël Jakse
- RS Raluca Stavro
-
Stéphane Laurière
- SN Stefana Nazare
- S(M Silvia (Rusu) Macovei
- SU Simon Urli
- TC Teodor Caras
- TM Thomas Mortagne
- Options
All users, no LDAP or OpenIDC requirements, bigger
- CG Certificate Generator
- DA Dorina Anton
- XN XWiki Network
- AMA Ana-Maria Anea
- AC Andreea Chirica
- AF Alexandru Farcasi
- AL Arnaud Laprévote
- AL Anca Luca
- AN Alexandra Nicolae
- AS Alexandra Siriciuc
- CA Camelia Andrei
- CA Clément Aubin
- CL Cédric Lamblin
- CR Clemens Robbenhaar
-
Dorina Anton
- IA Ilie Andriuță
- IB Iulia Balan
- JSD Jean-Sébastien Dennebouy
- KH Kévin Hoarau
- LC Lucian Chevereseanu
- LD Ludovic Dubost
- MB Mohamed Boussa
-
Marius Dumitru Florea
- MH Michael Hamann
- ML Manuel Leduc
- MO Marian Onofrei
- MP Mathieu Pace
- NP Nikita Petrenko
- OLF Oana-Lavinia Florean
- O(F Oana (Tăbăranu) Florea
- PP Paul Pantiru
- RJ Raphaël Jakse
- RS Raluca Stavro
-
Stéphane Laurière
- SN Stefana Nazare
- S(M Silvia (Rusu) Macovei
- SU Simon Urli
- TC Teodor Caras
- TM Thomas Mortagne
- Options
All users, no LDAP or OpenIDC requirements, some colors
- CG Certificate Generator
- DA Dorina Anton
- XN XWiki Network
- AMA Ana-Maria Anea
- AC Andreea Chirica
- AF Alexandru Farcasi
- AL Arnaud Laprévote
- AL Anca Luca
- AN Alexandra Nicolae
- AS Alexandra Siriciuc
- CA Camelia Andrei
- CA Clément Aubin
- CL Cédric Lamblin
- CR Clemens Robbenhaar
-
Dorina Anton
- IA Ilie Andriuță
- IB Iulia Balan
- JSD Jean-Sébastien Dennebouy
- KH Kévin Hoarau
- LC Lucian Chevereseanu
- LD Ludovic Dubost
- MB Mohamed Boussa
-
Marius Dumitru Florea
- MH Michael Hamann
- ML Manuel Leduc
- MO Marian Onofrei
- MP Mathieu Pace
- NP Nikita Petrenko
- OLF Oana-Lavinia Florean
- O(F Oana (Tăbăranu) Florea
- PP Paul Pantiru
- RJ Raphaël Jakse
- RS Raluca Stavro
-
Stéphane Laurière
- SN Stefana Nazare
- S(M Silvia (Rusu) Macovei
- SU Simon Urli
- TC Teodor Caras
- TM Thomas Mortagne
- Options
All users, with LDAP or OpenIDC requirements
- AMA Ana-Maria Anea
- AC Andreea Chirica
- AF Alexandru Farcasi
- AL Arnaud Laprévote
- AL Anca Luca
- AN Alexandra Nicolae
- AS Alexandra Siriciuc
- CA Camelia Andrei
- CA Clément Aubin
- CL Cédric Lamblin
- CR Clemens Robbenhaar
-
Dorina Anton
- IA Ilie Andriuță
- IB Iulia Balan
- JSD Jean-Sébastien Dennebouy
- KH Kévin Hoarau
- LC Lucian Chevereseanu
- LD Ludovic Dubost
- MB Mohamed Boussa
-
Marius Dumitru Florea
- MH Michael Hamann
- ML Manuel Leduc
- MO Marian Onofrei
- MP Mathieu Pace
- NP Nikita Petrenko
- OLF Oana-Lavinia Florean
- O(F Oana (Tăbăranu) Florea
- PP Paul Pantiru
- RJ Raphaël Jakse
- RS Raluca Stavro
-
Stéphane Laurière
- SN Stefana Nazare
- S(M Silvia (Rusu) Macovei
- SU Simon Urli
- TC Teodor Caras
- TM Thomas Mortagne
- Options
All users with names, disable tools
- CG Certificate Generator
- DA Dorina Anton
- XN XWiki Network
- AMA Ana-Maria Anea
- AC Andreea Chirica
- AF Alexandru Farcasi
- AL Arnaud Laprévote
- AL Anca Luca
- AN Alexandra Nicolae
- AS Alexandra Siriciuc
- CA Camelia Andrei
- CA Clément Aubin
- CL Cédric Lamblin
- CR Clemens Robbenhaar
-
Dorina Anton
- IA Ilie Andriuță
- IB Iulia Balan
- JSD Jean-Sébastien Dennebouy
- KH Kévin Hoarau
- LC Lucian Chevereseanu
- LD Ludovic Dubost
- MB Mohamed Boussa
-
Marius Dumitru Florea
- MH Michael Hamann
- ML Manuel Leduc
- MO Marian Onofrei
- MP Mathieu Pace
- NP Nikita Petrenko
- OLF Oana-Lavinia Florean
- O(F Oana (Tăbăranu) Florea
- PP Paul Pantiru
- RJ Raphaël Jakse
- RS Raluca Stavro
-
Stéphane Laurière
- SN Stefana Nazare
- S(M Silvia (Rusu) Macovei
- SU Simon Urli
- TC Teodor Caras
- TM Thomas Mortagne
All users with names, disable letter avatars, only in the main wiki
-
Certificate Generator
-
Dorina Anton
-
XWiki Network
-
Ana-Maria Anea
-
Andreea Chirica
-
Alexandru Farcasi
-
Arnaud Laprévote
-
Anca Luca
-
Alexandra Nicolae
-
Alexandra Siriciuc
-
Camelia Andrei
-
Clément Aubin
-
Cédric Lamblin
-
Clemens Robbenhaar
-
Dorina Anton
-
Ilie Andriuță
-
Iulia Balan
-
Jean-Sébastien Dennebouy
-
Kévin Hoarau
-
Lucian Chevereseanu
-
Ludovic Dubost
-
Mohamed Boussa
-
Marius Dumitru Florea
-
Michael Hamann
-
Manuel Leduc
-
Marian Onofrei
-
Mathieu Pace
-
Nikita Petrenko
-
Oana-Lavinia Florean
-
Oana (Tăbăranu) Florea
-
Paul Pantiru
-
Raphaël Jakse
-
Raluca Stavro
-
Stéphane Laurière
-
Stefana Nazare
-
Silvia (Rusu) Macovei
-
Simon Urli
-
Teodor Caras
-
Thomas Mortagne
- Options
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:
![]() |
Dorina Anton |
![]() |
Marius Dumitru Florea |
![]() |
Stéphane Laurière |
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:
Expand
This macro allows you to insert an expandable section, with a title and content. Compatible with Confluence migrations.
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:
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 | Name | Description | Default |
---|---|---|---|
author | Author | Filter the results by author(s) of the last modifications. | none |
spaces | Space | Display pages, blog posts or attachments only from certain specified spaces. You can specify one or more space keys, separated by a comma or a space.
Special values: "@self" - the current space, "@global" - all spaces in wiki, "@all" or "*" - all spaces in every wiki. | @self |
labels | Label | Filter the results by label. The macro will display only the pages etc which are tagged with the label(s) you specify here. You can specify one or more label values, separated by a comma or a space.
| none |
width | Width of Table | Specify the widths of the macro display, as a percentage of the window widht. | 100% |
types | Content Types | Filter by content type (page, blogpost, comment, attachment). You can specify one or more types, separated by a comma or a space. | all types |
max | Maximum Number of Results | Restrict the number of displayed results. | 15 |
theme | Theme | Choose the appearance of this macro:
| concise |
showProfilePic | Show User Profile Pictures | Display the profile pictures of the authors. | false |
hideHeading | Hide Title | Determines whether the macro hides or displays the text 'Recently Updated' as a title above the list of content. | false |
Example
Results in:
Macros used only in the context of Confluence migration
Gliffy
The Gliffy macro is a Confluence specific macro. It is a bridge between the Gliffy macro used in Confluence and the Diagram macro used in the XWiki Diagram Application. The aim of this macro is to allow users to view and modify the diagrams migrated from Confluence. By default, the macro displays the preview of the Gliffy diagram. The user can create the editable version of the diagram, by using its representation into an XWiki diagram, having always the option to go back to the preview of the original diagram.
Parameters
Parameter | Description |
---|---|
name | The diagram identifier. It should be the name of the attachment storing the Gliffy diagram data. It should not have a filename extension. The Gliffy diagram exports consist in attachments added to the parent page. For example, for a diagram called MyGliffyDiagram, there will be two attachments on the parent page : MyGliffyDiagram.png (the filename with a ".png" extension) representing the preview of the diagram and MyGliffyDiagram (with no filename extention) representing the diagram data. |
Example
Results in:
Balsamiq
This macro is a bridge for the Confluence Balsamiq Wireframe macro. It displays the image preview of the mockup, as it was migrated from Confluence.
The wireframe preview is an attachment added to the parent page. For example, for a wireframe identified with MyWireframeID, there will be an attachment on the parent page of this form: <balsamiq_MyWireframeID[_branchID].png. This means that there will be a prefix called balsamiq followed by an underscore (_), then the resource identifier (MyWireframeID in this case), then an arbitrary suffix (if it is set, by default it will be called Master). So, here are some filenames matching our example :
- balsamiq_MyWireframeID_Master.png
- balsamiq_MyWireframeID.png
Parameters
Parameter | Description | Accepted values | Default value | Mandatory | |
---|---|---|---|---|---|
initialResourceID | The ressource ID that is part of the mockup filename attached to the current page (in the example above, it would be MyWireframeID). | Yes | |||
initialBranchID | The branch on which the file was stored. If it exists, by default, Confluence sets it to Master. | ||||
Alignment | The alignment of the wireframe preview. | Left, Center and Right | Left |
Example
Results in:
Mockup
This macro id a bridge for the Confluence Balsamiq Mockup macro. It displays the image preview of the mockup, as it was migrated from Confluence.
The mockup preview is an attachment added to the parent page. For example, for a mockup identified with MyMockupID, there will be an attachment on the parent page of this form: <balsamiq/mockup>_MyMockupID[_branchID].png. This means that there should be a prefix called either mockup or balsamiq, followed by an underscore (_), then the resource identifier (MyMockupID in this case), then an arbitrary suffix (if it is set, by default it will be called Master). So, here are some filenames matching our example:
- balsamiq_MyMockupID_Master.png
- balsamiq_MyMockupID.png
- mockup_MyMockupID.png
Parameters
Parameter | Description |
---|---|
Name | The resource ID that is part of the mockup filename attached to the current page (in the example above, it would be MyMockupID). |
initialResourceID | In case the Name parameter is not set, this is parameter will be taken into account for identifying the attachment representing the mockup preview. |
initialBranchID | The branch on which the file was stored. If it exists, by default, Confluence sets it to Master. |
Example
This means that the accepted preview filenames attached to the current page are:
- balsamiq_2278E287-509B-183B-1098-2EC38DDDB7D8_Master.png
- mockup_2278E287-509B-183B-1098-2EC38DDDB7D8_Master.png
Filename number 1. has priority, so in case both files are attached to the current page, the first one is displayed.
It results in:
Confluence Gallery
The Confluence Gallery macro is a bridge between Confluence and XWiki. This bridge uses the XWiki implementation of the Gallery macro under the hood and therefore assumes that the Confluence gallery macro is prefixed during import. There are a few things to note:
Only a subset of the parameters supported by the Confluence macro are supported by this bridge macro: title, exclude, include and page. The remaining parameters are ignored:
- columns does not make sense for the XWiki macro as the images are displayed differently
- excludeLabel and includeLabel are not supported since XWiki does not support attachment tags
- sort and reverse have not been implemented in this bridge macro
Parameters
Parameter | Description | Required | Default |
---|---|---|---|
title | Title of the gallery. | No | |
exclude | Excluded images (comma separated). | No | |
include | Included images (comma separated). | No | |
page | Pages containing the images to display. Current page if empty. | No |
Example
All images in the current page:
Results in:
Excerpt
The Excerpt macro is a bridge macro between Confluence and XWiki. It allows the user to mark part of the page's content for use by other macros. Note the Excerpt include macro is not yet available.
The macro can also be used to hide part of the content of a page.
Parameters
Parameter | Description | Default |
---|---|---|
atlassian-macro-output-type | The ouput type. It can be either BLOCK or INLINE. | INLINE |
hidden | If true, the content of the macro will be hidden. | false |
Example
Example of excerpt with HTML:
{{excerpt}}
|=Title1|=Title2|=Title3
|Text1|Text2|Text3
{{/excerpt}}
Results in:
Title1 | Title2 | Title3 |
---|---|---|
Text1 | Text2 | Text3 |
Example of hidden excerpt:
{{excerpt hidden="true"}}
My hidden content.
{{/excerpt}}
Result in:
My hidden content.
Tip
This is a bridge macro between Confluence Tip macro and XWikis Success macro.
Parameters
Parameter | Description |
---|---|
title | The title of the tip. |
Example of usage
This is my tip with a title.
{{/tip}}
Result :
Drawio
The Drawio macro is a bridge between Drawio macro used in Confluence and the Diagram macro used in XWiki. The aim of this macro is to allow users to view and also to modify the Drawio/Diagrams.net diagrams migrated from Confluence. By default, the macro displays the preview of the Drawio diagram. The user can create the editable version of the diagram, by using its representation into an XWiki diagram, always having the option to go back to the preview of the original diagram.
Parameters
Parameter | Description |
---|---|
diagramName | The diagram identifier. It should be the name of the attachment storing the Drawio diagram data. It should have a `.drawio` filename extension. The Drawio diagram exports consist in attachments added to the parent page. For example, for a diagram called MyDrawioDiagram.drawio, there will be two attachments on the parent page: MyDrawioDiagram.drawio.png (the filename with a ".png" extension) representing the preview of the diagram and MyDrawioDiagram.drawio representing the diagram data in Diagrams.net's native format. |
Example of usage
The syntax of the macro using the diagram called "MyDrawioDiagram.drawio" is the following:
The result is the following:
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.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
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.pro:xwiki-pro-macros-api 1.9.3
- com.xwiki.licensing:application-licensing-licensor-api 1.24.1
- org.xwiki.platform:xwiki-platform-office-ui 13.10
- com.xwiki.pdfviewer:macro-pdfviewer-ui 2.5
- org.xwiki.contrib:macro-jwplayer-ui 2.1.10
- org.xwiki.platform:xwiki-platform-rendering-wikimacro-store 13.10
Junior Architect