Confluence Migration Toolkit

Last modified by Administrator on 2024/10/03 00:04

Buy extension
from 1900€ Try extension
for free Contact us

Category	Other
Rating	1 2 3 4 5 0 Votes
License	GNU Lesser General Public License 2.1
Minimal XWiki version supported	13.10
Sources	Issues

Migrate your Confluence data, page history, users, permissions, attachments and metadata in just a few minutes using this set of dedicated tools. All the applications that you need to migrate are automatically installed.

Once your migration is done, enjoy the long term technical support covering XWiki, all Pro Apps, recommended extensions and community extensions (best effort).

To migrate from Confluence to XWiki you will need:

an XWiki instance with administrator access (advanced user, view hidden pages)
access to your XWiki instance's configuration files, if you are running XWiki on your premise
a Confluence server XML backup file

Please follow the instructions in the "Documentation" tab for a full breakdown of each step.

This toolkit offers the following services:

license & technical support for all Pro Apps, including Confluence Migrator (Pro), Pro Macros, Confluence Bridge Macros, and Task Manager (Pro)
technical support on XWiki core
technical support on product recommended extensions
technical support on community extensions (best effort)

At the service level, it is equivalent to Gold support.

In trial mode, the Confluence Migrator (Pro) is limited to 30 pages per migration.

The application can be purchased via online order (credit card payment), following the “How to Buy” procedure described in the "PRICING" tab. For manual orders (bank transfer payment) please contact sales@xwiki.com.

Confluence Migrator
- Prerequisites
- Data migration
Confluence Bridge Macros and Generic Pro Macros
Generic Macros
Macros used only in the context of Confluence migration
Supported Confluence macros

Confluence Migrator

Prerequisites

an XWiki instance with administrator rights
access to your XWiki instance's configuration files (if you are running XWiki on premise)
Confluence Migration Toolkit installed on your XWiki instance
administrator access to the Confluence instance that you wish to migrate content from or a server XML backup file

Once you have installed the Confluence Migration Toolkit, go to the Confluence Migrator Pro, open the prerequisites section and perform the necessary configuration in order to make sure the XWiki instance will support the data migration.

If a prerequisite is met, a checkmark will appear next to its respective line in the dedicated section.

Data migration

Upload export package into XWiki

In order to migrate your data, first attach the Confluence backup file in the dedicated section of the migrator.

Note that if you are using a trial, you will be able to import one space and up to 30 pages per migration. All the other functionalities (prerequisites, import configuration, migration report, simultaneous migrations etc.) are available in the trial version. In order to unlock the full capabilities please obtain a license.

You will be able to attach multiple files and start the data migration from any of them. It is also possible to use a space export. If your Confluence backup fails to upload please make sure that your XWiki instance has enough storage and memory, and also that the attachment limit is not too low. If you are using XWiki in the Cloud, please contact the support team, in order for them to perform the necessary configuration.

Once you have identified the export file that you wish to use, click on "Select package". You will be redirected to the title page, where you can name your migration and configure the import options.

Select export package from server

Alternatively, if the Confluence export packages are placed on a machine that XWiki has access to, please use the "Select an export from server" option:

If you wish to modify the default import configuration, for example, to skip user import or to not preserve history, click on "Advanced migration options". Please see below the documentation on each parameter of the Advanced migration options.

Once you are satisfied with the configuration, click on "Save & View". You will be redirected to the package analyser step. The analysis of the package may take a while if the export is very large.

Once the analysis of the package is done, the list of spaces will appear. You can select all, multiple or one space and search for a space based on their key. If a single space export is used, this step is skipped.

After you have selected all the spaces that you wish to migrate in this run, click on "Confirm". You will be redirected on the import log page. The process of importing and moving the pages into their correct location may take a while if the export is very large.

Finally, when the data migration is done, you will be redirected to the report page, where you will see the pages that have been successfully imported, along with the ones affected by errors and links issues.

You will be able to also later review the report by clicking on the migration page in the application's homepage. Moreover, you can run multiple migrations in parallel and see their status.

Advanced migration options

You can fine-tune your migration by configuring the advanced migration options. Please see below the details on each parameter:

Properties of the input filter stream (Confluence XML)

Parameter name	Description	Example value	Default value
Import archived documents	Confluence exports can contain archived documents. XWiki doesn't have a concept of archived document. This parameter lets you optionally import archived documents as regular XWiki documents instead of ignoring them.		FALSE
Import archived spaces.	Confluence exports can contain archived spaces. XWiki doesn't have a concept of archived space. This parameter lets you optionally import archived spaces as regular XWiki spaces instead of ignoring them.		FALSE
Import attachments	If you don't want to import document attachments, set this to false.		TRUE
Base URLs	The list of base URLs leading to the Confluence instance. They are used to convert wrongly entered absolute URLs into wiki links. The first URL in the list will be used to compute page URLs used in the conversion report if the the 'Store Confluence details' property is used. This parameter is used to convert (fix) absolute URLs present as links in the documents that will get imported. The bases of this URLs should be input in this field so that they are converted from the Confluence to the XWiki links. For example, adding in this field www.<myconfluence>.com/wiki/spaces will convert absolute links such as www.<myconfluence>.com/wiki/space/KEY/page into www.<myxwiki>.com/bin/view/KEY/page.		N/A
Blog Space name	This field defines the name of the space under which blog posts will be imported. By default, a "Blog" space will be created under "SPACE KEY".		Blog
Import blog posts	This field decides whether to import blog posts or not. By leaving the default value "true", blog posts will be imported. By changing the value to "false", blog posts will not be imported. Note that if you wish to import blog posts you need to install the Blog Application in XWiki.		TRUE
Cleanup mode	The mode to use for cleaning up temporary files produced when parsing the Confluence package. SYNC: clean up right after the filter stream is done. ASYNC: same, but asynchronously. NO: don't clean up at all		SYNC ASYNC in the Confluence Migrator Pro Application
Produce rendering events for the content	Parse the content to produce rendering events (if the output filter supports them).This is needed in very specific conditions. We do not recommend modifying this parameter unless you know what you are doing.		FALSE
Import contents	This parameter defines whether to import the body and set content of regular documents and blog posts (if blog posts are imported). We do not recommend modifying this parameter.		TRUE
XWiki Conversion	This parameter defines whether to convert user, space and document references from the Confluence names to the XWiki names. This includes user id mapping and group mapping described below, which will not be applicable if this parameter is set to false. The confluence syntax to XWiki syntax This is needed in very specific conditions. We do not recommend modifying this parameter unless you know what you are doing. In particular, XWiki may not be able to render your imported documents and links will probably be broken if you disable this.		TRUE
Default locale	This parameter defines the locale that will be used for the imported documents. Usage example: you have a xwiki instance that you want to be localized with both en and fr. The default locale for your instance is en. You have a Confluence instance that has its content in French. You import from Confluence to XWiki and all the created documents will have their locale set to your xwiki default locale (en) and the content brought from Confluence wwill be in French. Ideally, you set the parameter default locale to "fr" so all the imported documents will have their locale equal to "fr". Now, if you want to also have an English version of the documents, you create it and translate it.	fr	N/A
Page name validation	This parameter defines whether the pages should be validated against and converted using XWiki's current page naming strategy. This works if the XWIKI CONVERSION field is set to "true". This is needed in very specific conditions. We do not recommend modifying this parameter unless you know what you are doing. In particular, XWiki may not be able to render your imported documents and links will probably be broken if you disable this.		TRUE
Excluded pages	List in this field the Confluence pages to ignore from the import. The format is a comma separated list of page IDs where each number is a page id. See also the Ranges and the Included pages parameters.	54,323,412,312,365,400
Group name mapping	This field offers the option to specify a list of A=X relations where A is a Confluence group name and X is an XWiki group name. A will be renamed to X. These sets are separated using the pipe character (\|). If several Confluence groups are mapped to the same XWiki group, the groups will be merged: users of all the Confluence groups will be added to the given XWiki group. For instance, with A=X\|B=X, users in Confluence group A and in Confluence group B will be added to XWiki group X. If X is empty, the group will be discarded. This parameter is used for two things: Group and user imports Permission migration (the Confluence permission applying to Confluence group A will be translated and will apply to XWiki group X). Also note the existence of the "group name prefix" and the "group name sufix" output filter stream parameters that apply on top of this mapping.		system-administrators=XWikiAdminGroup\|site-admins=XWikiAdminGroup\|administrators=XWikiAdminGroup\|users=XWikiAllGroup\|confluence-users=XWikiAllGroup\|_licensed-confluence=\|confluence-administrators=XWikiAdminGroup
Import history	Set this to false if you want to discard previous revisions of documents (for performance, space or import speed concerns)		TRUE
Home redirect	When non nested import is used, home pages are renamed so they can be the home page of spaces in XWiki. If set to true, redirects are output so links to these pages are not broken. When nested import is used, this parameter is ignored.		TRUE
Included pages	This field allows you to specify pages that should be imported. The format is a comma separated list of page IDs where each number is a page id. See also the Ranges and the Excluded pages parameters.	54,323,412,312,365,400
Macro content syntax	This parameter defines the target syntax to be used. This is needed in very specific conditions. We do not recommend modifying this parameter unless you know what you are doing		N/A
Max Page count	if you want to limit the number of imported pages, set this to the desired number. -1 disable any limitation		-1
Nested import	Defines how to handle nested spaces false: use the old XWiki behavior, which also corresponds to how Confluence represents parent relationship between pages. The Nested Pages Migrator Application will be needed to convert this relationship into the current native XWiki way of representing parentship. true: use the new XWiki behavior.		false true in the Confluence Migrator Pro Application. Note: the default will probably be changed to true at some point in the future.
Import non-blog content	This field defines whether to import non-blog contents (normal documents) or not. When this parameter and the IMPORT BLOG POSTS are set to "true", both regular pages and blog posts get imported. Set this parameter to "false" if you wish to import only blog posts present in an export package.		TRUE
Object ID ranges	Ranges of Confluence objects to read. Can be used to restore an interrupted migration. Several comma-separated ranges can be given. Note that the order used for these ranges are not increasingly big ids, but in the order they are processed by the Confluence module. This order may change between versions of the parser, but is guaranteed to be the same between different runs using the same version of the Confluence module. Ranges must not overlap. Overlapping ranges are not supported, may lead to surprising results and their behavior is not guaranteed to be stable. In the same vain, ranges must be ordered in the parsing order.	[4242,] - only read object id 4242 and all the following ones (4242,] - same, but exclude object id 4242 [,4242] - read all objects until object id 4242 included [,4242) - same, but exclude 4242 [4242,2424], [3456,1234] - read objects between 4242 and 2424 both included, then ignore objects until 5656 and read objects between 5656 and 1234 both included (notice how IDs may look disordered)
Prefixed macros	This field stores an allowlist of macros that should be prefixed. A few macros exist both in XWiki and in Confluence under the same name. In order to allow the usage of the bridge macros (dedicated to displaying content in the same manner as it was in Confluence), those macros should be prefixed so that the bridge macros (e.g. "confluence_gallery") are used and not the original XWiki macro (e.g. "gallery"). We do not recommend modifying this parameter.		attachments,gallery,chart
Import rights	This parameter definer whether permissions set in Confluence should be migrated into XWiki. This parameter definer whether permissions set in Confluence should be migrated into XWiki. Importing users and groups is not mandatory; rights will be imported without. However, if you disable user or group import to import them using another method, for the correct rights to apply to the correct users and groups, you will need to create the users and the groups with the exact same names that are in Confluence, or that are specified in the User id mapping and Group name mapping parameters (as these two parameters will be respected by the right migration even if groups and users are not imported).		TRUE
Root space name	If you want content to be put in a specific space instead of at the wiki root, set this to the name of this space	Migrated
Space Home Page	This parameter defines which document name to use for the Confluence space home page. Changing this is needed in very specific conditions. We do not recommend modifying this parameter unless you know what you are doing. Anything else than WebHome could lead to suprising behavior.		WebHome
Title spaces from their home page	Title spaces using the Confluence home page titles instead of the Confluence space names. Home pages in Confluence are usually named something like "Home" or "SPACENAME Home", which is not very helpful. In Confluence, spaces are named and that's usually what you want as the title of spaces in XWiki. However, if you happen to have useful home page titles, you may want to set this to true. Space name are always taken from Confluence space keys regardless what you choose here.		FALSE
Store Confluence details	This parameter specifies whether to store Confluence metadata in migrated documents as objects. This is usually useless, but in some cases, this metadata can be useful for debugging purposes and might end up useful to support CQL-based Confluence macros like spacebylabel or detailssummary in the future.		FALSE
Import tags	Set this to false if you don't want Confluence labels to be migrated to XWiki tags		TRUE
Unknown macro prefix	This field defines the prefix to be used for the macros specified in the "Prefixed macros" field. We do not recommend modifying this parameter.		confluence_
Unprefixed macros	This field stores a denylist of macros that should not be prefixed. We do not recommend modifying this parameter.		N/A
User id mapping	A mapping between Confluence user id located in the package and wanted ids. Similar to GROUP NAME MAPPING, this field stores a list of A=B couples separated with a pipe character (\|) where A is the name of a Confluence user and B is the desired user name in XWiki.	user1=User1\|charliedo=CharlieDo\|ConfluenceAlice=Alice\|ConfluenceBob=Bob
Produce user references	This parameter defines if links to user profiles should be created for existing Confluence user profile links.		FALSE
Import users	Import the users and groups found in the confluence package. If this parameter is set to true, user profiles present in the export package will be imported into XWiki. Setting this parameter to "false" may be needed if you use a central user directory service like LDAP or Active Directory, in which case you need to decide on a careful user migration strategy.		TRUE
Users wiki	The wiki where to import users.If you have a multi wiki environment and you set the Import users to "true", you can specify here the wiki in which users should be created.		N/A (current wiki)
Verbose	This field defines whether to create detailed import logs or not. If you are using the Confluence Migrator Pro Application, we do not recommend modifying this parameter.		TRUE

Imported macros

At the end of each migration you will obtain a list of all the macros present in the imported package and their supported status (supported, partial, not supported). On the Confluence Migrator's homepage the summary of all the macros, along with their number of occurrences is displayed:

Confluence Bridge Macros and Generic Pro Macros

Generic Macros

Can be used outside the context of a Confluence Migration.

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"/}}

{{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	authors - includes users who edited the page(s). comments - includes people who commented to the page(s) Several values can be given, separated by commas. Values "labels" and "watches" are not supported in this bridge macro.
order	Order	count	Possibles values: count - order by number of contributions name - order contributors by name alphabetically update - order by last contribution date
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: inline - a comma-separated list list - a bullet list.
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: children - include direct children of the specified pages descendants - include all children of the specified pages (blank) - include only the specified pages
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

{{contributors showCount="true" spaces="Sandbox" scope="descendents" showPages="true" mode="list"/}}

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

{{content-report-table maxResults="10" spaces="DEMO" labels="tech,xwiki"/}}

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

{{excerpt}}
|=Title1|=Title2|=Title3
|Text1|Text2|Text3
{{/excerpt}}

Results in:

Example of hidden excerpt:

{{excerpt hidden="true"}}
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

{{expand title="Expand this section to learn more"}}
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

{{msStream url="https://web.microsoftstream.com/video/2113" width="700px" alignment="right" showinfo="true" start="00:05:04"/}}

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

{{panel}}
Content of the panel
{{/panel}}

Results in:

Simple panel with border and size

{{panel borderColor="black" width="50%"}}
Content of the panel
{{/panel}}

Results in:

Panel with title and colors

{{panel bgColor="#dbf4ff" titleBGColor="#2a8af7" titleColor="#ffffff" width="50%" title="Title of the panel"}}
Content of the panel
{{/panel}}

Results in:

Panel with title and colors and border

{{panel bgColor="#dbf4ff" borderColor="#2a8af7" titleBGColor="#2a8af7" titleColor="#ffffff" title="Title of the panel"}}
Content of the panel
{{/panel}}

Results in:

Panel with bootstrap classes

{{panel classes="col-sm-12" bgColor="#dbf4ff" titleBGColor="#2a8af7" titleColor="#ffffff" title="Title of the panel"}}
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

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

{{team requireExternalAuth="false" letterAvatarBgColor="#05C" letterAvatarFontColor="#FFA"/}}

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

{{team showUsernames="true" disableLetterAvatars="true" scope="global"/}}

Results in:

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

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

{{userList users="XWiki.JohnDoe,XWiki.StefanaNazare,XWiki.MarySmith" properties="avatar,username"/}}

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 name="XWikiLogo.png"/}}

{{view-file display="button" name="migration-gif-2.mp4"/}}

{{view-file display="full" name="XWikiSAS.pdf" height="600"/}}

Results in

Macros used only in the context of Confluence migration

In order to display properly certain data imported from Confluence we have developer numerous bridge macros. We propose native XWiki alternatives for them, to be used post migration. All bridge macros are prefixed with "confluence_" and the unprefixed version is also supported for compatibility reasons, for users that migrated before the prefix was introduced.

Anchor

Legacy bridge macro for the Confluence "anchor" macro. The "anchor" macro gets converted into XWiki's native "id" macro upon migration. XWiki's native "id" macro must be used following migration.

Parameters

Parameter	Default	Description in Confluence	Parameter supported in XWiki?	Comments
Anchor Name	None	This is the anchor name that you will use when creating the link. The anchor name can include spaces. Confluence will remove the spaces automatically when building a URL that points to this anchor. The anchor name is case sensitive. You must use the same pattern of upper and lower case letters when creating the link as you used when creating the Anchor macro.	yes	id macro must be used

Attachments

The Attachment macro is a bridge between Confluence and XWiki. It uses the XWiki implementation to display attachments in the page content.

Parameters

Parameter	Default	Description in Confluence	Parameter supported in XWiki?	Comments
Filename Patterns (patterns)	all	A comma-separated list of regular expressions, used to filter the attachments by file name. Note that the parameter values must be regular expressions. For example: To match a file suffix of 'jpg', use .jpg (not .jpg). To match file names ending in 'jpg' or 'png', use .jpg,.png	yes
Attachment Labels (labels)	(none)	A list of labels, used to filter the attachments to display. If you wish to enter more than one label, separate the labels with commas. Confluence will show only attachments that have all the labels specified. (The match is an AND, not an OR.) For information on labelling the attachments, see Add, Remove and Search for Labels.	no	This is for labels on attachments, not pages. We support migration of page labels to page tags, but we do not support attachment labels.
Include Old Attachment Versions (old)	false	A value of true will include previous attachment versions in the list.	no
Sort By (sortBy)	date	The sort order for attachments. Note that people viewing the page can change the sort order by clicking the column headings. Valid values are: date – sorts by updated date in reverse chronological order (newest first) size – sorts largest to smallest name – sorts alphabetically created date - sorts by creation date in reverse chronological order (newest first)	yes
Sort Order (sortOrder)	ascending	Used in combination with the Sort By parameter, to sort the attachments in ascending or descending order.	yes
Allow Upload (upload)	true	If selected, the list of attachments will include options allowing users to browse for, and attach, new files.	yes
Page Title (page)	(none)	Used to display attachments from another page. If you do not enter a page title, the macro will display the files attached to the current page.	yes
Show Previews (preview)	true	Used to display a preview of the attached file. If true, preview will be visible when the list item is expanded. It can be useful to disable previews if you have very large attachments.	no

Example

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

In XWiki, we migrate the attachments of this macro (bmpr mockup and png version) and we display the png image. We do not support launching the editor.

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

{{confluence_wireframe initialResourceID="2278E287-509B-183B-1098-2EC38DDDB7D8" initialBranchID="Master" Alignment="Center"/}}

Results in:

Column

Bridge macro used to display layouts created in Confluence with columns and sections. This macro is used in conjunction with the Section macro.

Parameters

Parameter name	Required	Default	Description in Confluence	Parameter supported in XWiki?	Comments
width	No	100% of the page width, divided equally by the number of columns in the section.	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%).	yes

Examples

Simple column

{{confluence_column width="350px"}}
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.
{{/confluence_column}}

Results in:

Columns usage in Section

{{confluence_section border="true"}}

{{confluence_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.
{{/confluence_column}}

{{confluence_column width="300px"}}
Content in the column 2
{{/confluence_column}}

{{confluence_column width="300px"}}
Content in the column 3
{{/confluence_column}}

{{confluence_column width="250px"}}
Content in the column 4
{{/confluence_column}}

{{/confluence_section}}

Results in:

Section

Bridge macro used to display layouts created in Confluence with columns and sections. This macro is used in conjunction with the Column macro to personalise the page layout.

Parameters

Parameter	Default	Description in Confluence	Parameter supported in XWiki?	Comments
Show Border (border)	false	Select this option to draw a border around the section and columns. Note: Without a Column macro , the border will not be displayed correctly.	yes

Examples

Simple section without border

{{confluence_section}}
Content of a simple section, without border.
{{/confluence_section}}

Results in:

Simple section with border, no column

No border is added, because the borders are applied on columns, when they exist.

{{confluence_section border="true"}}
Content of a simple section, with border.
{{/confluence_section}}

Results in:

Simple section with border and column

{{confluence_section border="true"}}
{{confluence_column}}
Content of a simple section, with border.
{{/confluence_column}}
{{/confluence_section}}

Results in:

Section with 4 columns

{{confluence_section border="true"}}

{{confluence_column width="250px"}}
Content in the column 1
{{/confluence_column}}

{{confluence_column width="300px"}}
Content in the column 2
{{/confluence_column}}

{{confluence_column width="300px"}}
Content in the column 3
{{/confluence_column}}

{{confluence_column width="250px"}}
Content in the column 4
{{/confluence_column}}

{{/confluence_section}}

Results in:

Children

Children bridge macro implemented reusing the documentTree XWiki native feature. Pagetree or children native XWiki macros should be used post migration.

Parameters

Parameter	Default	Description in Confluence	Parameter supported in XWiki?	Comments
Show Descendants (all)	false	Choose whether to display all the parent page's descendants. If true shows the complete tree of pages underneath the parent page, regardless of Depth of Descendants	no	pagetree macro can be used to limit the number of pages displayed.
Parent Page (page)	current	Specify the page to display children for, from either the current space or a different space. Enter: '/' — to list the top-level pages of the current space, i.e. those without parents. 'pagename' — to list the children of the specified page. 'spacekey:' — to list the top-level pages of the specified space. 'spacekey:pagename' — to list the children of the specified page in the specified space.	yes	Page picker implemented in XWiki's pagetree macro.
Number of Children (first)	none	Restrict the number of child pages that are displayed at the top level. Your administrator may enforce a maximum number for this parameter.	yes	Mapped to limit parameter from pagetree macro.
Depth of Descendants (depth)	none	Enter a number to specify the depth of descendants to display. For example, if the value is 2, the macro will display 2 levels of child pages. This setting has no effect if Show Descendants is enabled. Your administrator may enforce a maximum number for this parameter.	yes
Heading Style (style)	none	Choose the style used to display descendants.	no	Some display options available in pagetree macro but not in the Confluence bridge children macro.
Include Excerpts (excerpt)	none	Allows you to include a short excerpt under each page in the list. Choose between: None - no excerpt will be displayed Simple - displays the first line of text contained in an Excerpt macro on any of the returned pages. If there is not an Excerpt macro on the page, nothing will be shown. Rich content - displays the contents of an Excerpt macro, or if there is not an Excerpt macro on the page, the first part of the page content including formatted text, images, and some macros. Note that your administrator may have set this parameter to none for it to apply to the whole site.	no
Sort Children By (sort)	Manual if manually ordered, otherwise alphabetical	Leave blank to display pages in the order they currently appear in the page tree. Alternatively, choose: creation — to sort by content creation date title — to sort alphabetically on title modified — to sort of last modification date.	no	Default alphabetical ordering applied.
Reverse Sort (reverse)	false	Use with the Sort Children By parameter. When set, the sort order changes from ascending to descending.	no

Example

Show all children of the current page:

Show first 5 children of a specified page:

Content by label

Bridge macro used to display filters done with the Content by label macro in Confluence.

Parameters in Confluence

Filter	Description	Operators	Parameter supported in XWiki?	Comments
Label*	Include pages, blog posts or attachments with these labels.	OR (multiple values in the same filter) AND (multiple Label filters)	yes
With ancestor	Include pages that are children of this page. This allows you to restrict the macro to a single page tree.	OR (multiple values in the same filter)	no
Contributor**	Include pages or blog posts that were created or edited by these people.	OR (multiple values in the same filter)	yes
Creator	Include items created by these people.	OR (multiple values in the same filter)	yes
Mentioning user	Include pages and blog posts that @mention these people.	OR (multiple values in the same filter)	no
With parent	Include only direct children of this page (further sub-pages won't be included)	EQUALS (one page only)	partial	Parent is maintained post import.
In space**	Include items from these spaces.	OR (multiple values in the same filter)	yes
Including text**	Include items that contain this text.	CONTAINS (single word or phrase)	yes
With title	Include items that contain this text in the title.	CONTAINS (single word or phrase)	yes
Of type**	Include only pages, blogs or attachments.	OR (multiple values in the same filter)	partial	Types page and blogs are supported.
Display preview			no	excerpt/page
max	Maximum number of results		yes
sort	What to sort on. The only supported values are "modified", "creation" and "title" for now. Ignored if an order by clause is present in the cql parameter.		yes
title	A title to display before the results		yes
showSpaces	Whether to display the Confluence space in which the documents are (true) or not (false).		yes
showLabels	Whether to display the tags of the documents (true) or not (false).		yes
excerpt	Whether to show excerpts of documents (true) or not (false).		no
excerptType	Whether to show "simple" excerpts or "rich content" excerpt.		no

Additional parameters in XWiki

Parameter	Description	Required	Default
operator	Whether all the tags should match (AND), or any (OR). This value is ignored if the cql parameter is set.	No	OR
reverse	Whether to reverse the sort (true) or not (false).	No	false
cql	A query written in the Confluence Query Language (CQL) syntax defining the list of documents to show. See the documentation.	If labels is not given.	(empty)

Example

{{confluence_contentbylabel cql="label = ~"xwiki~" and type = ~"page~" and space = ~"FOS~"" maxCheckbox="false" reverse="false"/}}

Results in

Details and Details Summary (Page Properties and Page Properties Report)

For compatibility with content migrated from Confluence and this is particularly true for the Details and Details Summary macros. We strongly encourage people to use native XWiki features, like App Within Minutes or XWiki classes and objects, which are more powerful and better integrated in the platform.

Details (Page Properties)

Parameters in Confluence

Parameter	Default	Description in Confluence	Parameter supported in XWiki?
Page Properties ID	(None)	Optional ID used to identify a particular Page Properties macro on a page. Specify this ID in the Page Properties Report to include summary information from macros with this ID only.	yes
Hidden	False	Determines whether the data in the Page Properties macro will be displayed on the current page. This setting does not affect the display of the detail in the Page Properties Report macro.	yes

Details Summary (Page Properties Report)

Parameters in Confluence

Filter	Description in Confluence	Operators	Parameter supported in XWiki?	Comments
Label*	Include pages, blog posts or attachments with these labels.	OR (multiple values in the same filter) AND (multiple Label filters)	yes
With ancestor	Include pages that are children of this page. This allows you to restrict the macro to a single page tree.	OR (multiple values in the same filter)	no
Contributor**	Include pages or blog posts that were created or edited by these people.	OR (multiple values in the same filter)	yes
Creator	Include items created by these people.	OR (multiple values in the same filter)	yes
Mentioning user	Include pages and blog posts that @mention these people.	OR (multiple values in the same filter)	no
With parent	Include only direct children of this page (further sub-pages won't be included)	EQUALS (one page only)	partial	Parent is maintained post import.
In space**	Include items from these spaces.	OR (multiple values in the same filter)	yes
Including text**	Include items that contain this text.	CONTAINS (single word or phrase)	yes
With title	Include items that contain this text in the title.	CONTAINS (single word or phrase)	yes
Of type**	Include only pages, blogs or attachments.	OR (multiple values in the same filter)	partial	Types page and blogs are supported.
id	The group of properties to show. If empty, will show page properties without identifiers.		yes
headings	Which column of the page properties to show. By default, all columns are shown. Columns with comma in their names require being quoted		yes
columns			yes
sort	What to sort on. The only supported values are "modified", "creation" and "title" for now. Ignored if an order by clause is present in the cql parameter. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.		yes
showLastModified	Show the last modified time of the page		yes
showPageLabels	Show the tags of listed documents		yes
showCreator	Show the initial author of the listed documents		yes
showLikesCount			no
showUnresolvedCommentsCount			no
firstcolumn	A custom title for the document name column		yes

Additional parameters in XWiki

Parameter	Description	Mandatory	Default	Example
cql	A query written in the Confluence Query Language (CQL) syntax defining the list of documents to show. See the documentation.	If labels is not given	(empty)	label = "examplelabel" and space = currentSpace ( )
operator	Whether all the tags should match (AND), or any (OR). This value is ignored if the cql parameter is set. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.	No	OR	AND
max	Maximum number of results. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.	No	(unset)	15
sort	What to sort on. The only supported values are "modified", "creation" and "title" for now. Ignored if an order by clause is present in the cql parameter. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.	No	(unset)	title
reverse	Whether to reverse the sort (true) or not (false). Note: this parameter doesn't exist in Confluence, it's an XWiki addition.	No	false	true

Side by side comparison post import (XWiki on the left, Confluence on the right):

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.

In XWiki we recommend using the native XWiki diagram feature, also based on drawio.

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.

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.

Besides the diagramName parameter, the {{drawio}} macro used in Confluence has other parameters that don't have to be cleaned, because these parameters are being ignored by this bridge macro.

Example of usage

The syntax of the macro using the diagram called "MyDrawioDiagram.drawio" is the following:

Results in:

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. We recommend using the native XWiki gallery macro after migration.

Parameters

Parameter	Default	Description in Confluence	Parameter supported in XWiki?
Gallery Title (title)	Nothing	Specify a title for your gallery.	yes
Number of Columns (columns)	4	Specify the number of columns for your table.	no
Images to Exclude (exclude)	No exclusions. Include all the pictures on the page.	The gallery will ignore any pictures specified. You can specify more than one picture, separated by commas. Note: The filename and filetype for this parameter are case-sensitive. For example, 'my picture.PNG' will not be recognized as 'my picture.png'.	yes
Include these Images Only (include)	Include all the pictures on the page.	If you specifically include one or more pictures, the gallery will show only those pictures. You can specify more than one picture, separated by commas. Note: The filename and filetype for this parameter are case-sensitive. For example, 'my picture.PNG' will not be recognized as 'my picture.png'.	yes
Exclude Images with these Labels (excludeLabel)	No exclusions. Include all the pictures on the page.	The gallery will ignore any pictures that have the specified label. You can specify more than one label, separated by commas. For information on labeling the attachments, see Add, Remove and Search for Labels.	no
Include Images with these Labels Only (includeLabel)	None. The images are not filtered by label.	Filters the images to display, based on a list of labels. If you wish to enter more than one label, separate the labels with commas. Confluence will show only images that have all the labels specified. (The match is an AND, not an OR.) For information on labeling the attachments, see Add, Remove and Search for Labels.	no
Use Images in these Pages (page)	If no page is specified, the gallery macro displays the images attached to the page on which the macro is used.	Specify the title of the page which contains the images you want displayed. You can specify more than one page name, separated by commas. To specify a page in a different space, use the following syntax: SPACEKEY:Page Title	yes
Sort Images By (sort)	None. The sort order is unspecified and therefore unpredictable.	Specify an attribute to sort the images by. Sort order is ascending, unless you select the Reverse Sort parameter (see below). Options are: name – file name. comment – comment linked to the attached file. date – date/time last modified. size – size of the attached file.	no
Reverse Sort (reverse)	Off. Sort order is ascending	Used in combination with the Sort Images By parameter above. Use Reverse Sort to reverse the sort order, from ascending to descending. Available values in storage format and wikimarkup: true – Sort order is descending. false – Sort order is ascending.	no

Example

All images in the current page:

Results in:

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.

Post migration, in XWiki we recommend using the native diagram feature.

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.

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.

Besides the name parameter, the {{gliffy}} macro used in Confluence has other parameters that don't have to be cleaned, because these parameters are being ignored by this bridge macro.

Example

Results in:

Info, Tip, Note, Warning

Info

Info: same name as XWiki's "info". XWiki native "info" macro will be used post migration.

Parameters in Confluence

Parameter	Default	Description in Confluence	Parameter supported in XWiki?	Comments
Optional Title (title)	none	The title of the box. If specified, the title text will be displayed in bold next to the icon.	yes	title parameter from XWiki's info macro
Show information/tip/Exclamation Mark/Warning Icon (icon)	true	If "false", the icon will not be displayed.	no

Tip

Tip: bridge for Confluence tip to XWiki's success macro. XWiki native "success" macro should be used post migration.

Parameters in Confluence

Parameter	Default	Description in Confluence	Parameter supported in XWiki?	Comments
Optional Title (title)	none	The title of the box. If specified, the title text will be displayed in bold next to the icon.	yes	title parameter from XWiki's success macro
Show information/tip/Exclamation Mark/Warning Icon (icon)	true	If "false", the icon will not be displayed.	no

Note

Note: bridge for Confluence tip to XWiki's warning maccro. XWiki native "warning" macro should be used post migration.

Parameters in Confluence

Parameter	Default	Description in Confluence	Parameter supported in XWiki?	Comments
Optional Title (title)	none	The title of the box. If specified, the title text will be displayed in bold next to the icon.	yes	title parameter from XWiki's warning macro
Show information/tip/Exclamation Mark/Warning Icon (icon)	true	If "false", the icon will not be displayed.	no

Warning

Warning: same name as XWiki's warning macro. XWiki native "warning" macro will be used post migration.

Parameters in Confluence

Parameter	Default	Description in Confluence	Parameter supported in XWiki?	Comments
Optional Title (title)	none	The title of the box. If specified, the title text will be displayed in bold next to the icon.	yes	title parameter from XWiki's warning macro
Show information/tip/Exclamation Mark/Warning Icon (icon)	true	If "false", the icon will not be displayed.	no

Layout

Bridge macro used to display layouts created in Confluence with layout, layout-section and layout-cell macros.

We support importing the following layout options:

two equal,
three equal,
two columns, one behaving as sidebar on the right,
two columns, one behaving as sidebar on the left
three columns, sidebar, content, sidebar

Examples

Two equal columns

{{confluence_layout}}
{{confluence_layout-section ac:type="two_equal"}}
{{confluence_layout-cell}}
Lorem Ipsum is simply dummy text of the printing and typesetting industry.
{{/confluence_layout-cell}}

{{confluence_layout-cell}}
There are many variations of passages of Lorem Ipsum available.
{{/confluence_layout-cell}}
{{/confluence_layout-section}}
{{/confluence_layout}}

Results in:

Three equal columns

{{confluence_layout}}
{{confluence_layout-section ac:type="three_equal"}}
{{confluence_layout-cell}}
Nemo enim ipsam voluptatem quia voluptas sit aspernatur.
{{/confluence_layout-cell}}

{{confluence_layout-cell}}
Nor again is there anyone who loves or pursues or desires to obtain pain of itself.
{{/confluence_layout-cell}}

{{confluence_layout-cell}}
To take a trivial example, which of us ever undertakes laborious physical exercise.
{{/confluence_layout-cell}}
{{/confluence_layout-section}}
{{/confluence_layout}}

Results in:

Two columns, one behaving as sidebar on the right

{{confluence_layout}}
{{confluence_layout-section ac:type="two_right_sidebar"}}
{{confluence_layout-cell}}
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos.
{{/confluence_layout-cell}}

{{confluence_layout-cell}}
Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus.
{{/confluence_layout-cell}}
{{/confluence_layout-section}}
{{/confluence_layout}}

Results in:

Two columns, one behaving as sidebar on the left

{{confluence_layout}}
{{confluence_layout-section ac:type="two_left_sidebar"}}
{{confluence_layout-cell}}
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos.
{{/confluence_layout-cell}}

{{confluence_layout-cell}}
Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus.
{{/confluence_layout-cell}}
{{/confluence_layout-section}}
{{/confluence_layout}}

Results in:

Three columns, sidebar-content-sidebar

{{confluence_layout}}
{{confluence_layout-section ac:type="three_with_sidebars"}}
{{confluence_layout-cell}}
On the other hand, we denounce with righteous indignation
{{/confluence_layout-cell}}

{{confluence_layout-cell}}
But in certain circumstances and owing to the claims of duty.
{{/confluence_layout-cell}}

{{confluence_layout-cell}}
On the other hand, we denounce with righteous indignation.
{{/confluence_layout-cell}}
{{/confluence_layout-section}}
{{/confluence_layout}}

Results in:

LiveSearch

Converted into search location macro upon import. XWiki native Search Location should be used post migration.

Parameters in Confluence

Parameter	Default	Description in Confluence	Parameter supported in XWiki?	Comments
Restrict to this Space Key (spaceKey)	all spaces	Specify a space key to limit the search to a single space. Case-sensitive. You can't specify multiple spaces. Alternatively, use @self to restrict the search to the current space.	yes	reference
Restrict to label(s) (labels)		Specify labels to limit the search to content with that label. If unspecified will search all content regardless of label.	yes	tags
Size (size)	medium	Choose a medium or large search field size.	no
Placeholder text (placeholder)		Specify the placeholder text to appear in the search field, for example 'Search this space'	yes
Type (type)	all	Specify the content types to be included in the search - choose from pages, blogs, comments, space descriptions, or all content types.	yes	The search should be restricted to this kind of elements (possible values: title, content, comment, attachment, attachmentName, attachmentContent, object, all; default: all)
Additional (additional)	space name	Display the space name, a page excerpt or nothing under the search result.	no

Additional parameters in XWiki

Parameter	Default	Description
excerpt	1	Show excerpts with highlighted matches in suggested results
suggest	1	Suggest results as the search is typed
buttonText		Text displayed on the button
float	false	Adding float to the search block
box	false	Display the search bar in a box
className		The search should be restricted to documents with objects of this type

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 name	Required	Default	Parameters in Confluence	Parameter supported in XWiki?
Page name (page)	No	Current page	The name of the page to which the multimedia file is attached. Start typing the name of the page and then select it from list of suggested pages. Include the spacekey if you want to specify a page in another space (for example, MYSPACE:My Page Title)	yes
File* (name)	Yes	None	File name of the attached multimedia file.	yes
Width	No	If not specified, the browser will determine the width based on the file type.	Width of the movie window to be displayed on the page. By default, this value is specified in pixels. You can also choose to specify a percentage of the window's width, or any other value accepted by HTML.	yes
Height	No	If not specified, the browser will determine the height based on the file type.	Height of the movie window to be displayed on the page. By default, this value is specified in pixels. You can also choose to specify a percentage of the window's height, or any other value accepted by HTML.	yes
Autoplay (autostart)	No	false	If the parameter is set to true then the video or audio file will start playing as soon as the page is loaded. If this option is set to false then the file will not play until the user clicks the icon or image on the page.	yes

Examples

Video

{{confluence_multimedia name="file_example.mp4" width="500" height="200" /}}

Audio

Multiexcerpt and Multiexcerpt Advanced

"multiexcerpt-macro" and "multiexcerpt-fast-inline-macro" are converted into "excerpt" macro. Excerpt macro must be used following migration.

Multiexcerpt include

"multiexcerpt-include-macro" is converted into "excerpt-include" macro. Variable and templateData are not supported. Excerpt include macro must be used following migration.

Multiexcerpt include Advanced

"multiexcerpt-fast-include-block-macro" is converted into "excerpt-include" macro. Variable and templateData are not supported. Excerpt include macro must be used following migration.

Multiexcerpt include Advanced inline

"multiexcerpt-fast-include-inline-macro" is converted into "excerpt-include" macro with inline support. Variable and templateData are not supported. Excerpt include macro must be used following migration.

Mathblock

Add a block math expression. Bridges the mathblock Confluence macro using the XWiki's Mathjax macro.

Parameter	Description	Mandatory?	Default value
anchor	The anchor to make a reference to this math expression	No	Empty

Note: the alignment parameter is not yet supported.

Usage example

{{confluence_mathblock anchor="myanchor"}}
2+\frac 1 2 x
{{/confluence_mathblock}}

This block can be referenced like in the following sentence. Expression {{mathblock-ref anchor="myanchor"/}} shows some random and non-sensitical math.

MathBlock-ref

Add a reference to a block math expression. Bridges the mathblock-ref Confluence macro using the XWiki's Mathjax macro.

Parameter	Description	Mandatory?
anchor	The anchor of the math expression to reference.	Yes

Usage example

Mathinline

Add an inline math expression. Bridges the mathinline Confluence macro using the XWiki's Mathjax macro.

Parameter	Description	Mandatory?
body	The math expression. It can start with --uriencoded--, in which case the math expression needs to be url-encoded.	Yes

Usage example

The answer is {{confluence_mathinline body="--uriencoded--\sqrt%7B2+x%5e3%7D=\cfrac%7B1%7D%7Ba_1%7D"/}}

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

{{confluence_mockup initialResourceID="2278E287-509B-183B-1098-2EC38DDDB7D8" initialBranchID="Master"/}}

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.

Results in:

PageTree

This macro is a bridge for the Confluence Page Tree macro. It displays the list of pages in the specified page using the Document Tree Macro.

Parameters

Parameter	Description	Accepted values	Default value	Mandatory
root	The space to show.	@home (list the pages under the home page of the space), @self (under this page), @none (all the pages of the space), @parent (all the pages in the parent space), or the name of a space	@home	No

Example of usage

PageTree Search

Converted into search location macro upon import. XWiki native Search Location should be used post migration.

Parameters in Confluence

Parameter	Default	Description in Confluence	Parameter supported in XWiki?
Name of Root Page (root)	none	The name of the root page whose hierarchy of pages will be searched by this macro. If this not specified, the root page is the current page. Note: Unlike the Page Tree macro, the Page Tree Search macro does not accept the special values that start with an @ sign, such as @home or @self.	yes

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

{{confluence_paste-code-macro language="java" title="Hello World Example"}}
class Simple{
    public static void main(String args[]){
        System.out.println("Hello World !");
    }
}
{{/confluence_paste-code-macro}}

Results in:

Profile

Confluence's "profile" gets converted into XWiki's "userProfile" upon migration. UserProfile macro should be used after migration.

Time

The Time Confluence bridge macro show the time given in its datetime parameter.

Example

Result

2023-10-11

ViewXLS

Macro "viewxls" is converted into "view-file" at import step. "view-file" macro must be used following migration.

ViewDOC

Macro "viewdoc" is converted into "view-file" at import step. "view-file" macro must be used following migration.

ViewPPT

Macro "viewppt" is converted into "view-file" at import step. "view-file" macro must be used following migration.

ViewPDF

Macro "viewpdf" is converted into "view-file" at import step. "pdfviewer" or "view-file" macro must be used following migration.

ViewFile

Macro "viewfile" is converted into "view-file" at import step. "view-file" macro must be used following migration.

Supported Confluence macros

XWiki and Confluence both have their sets of macros, usually used to present content in a particular manner. In order for a macro used in Confluence to display in the same manner in XWiki, the macro has to have the same name and supported parameters. In an effort to make the transition as easy as possible for organisations that migrate from Confluence to XWiki, the Pro Applications team has dedicated significant efforts to creating XWiki macros identical to the most used Confluence macros. These macros are all present in the Pro Macros bundle.

For the macros that do not support migration and that are used on the Confluence instance, the wiki content will be imported, but they will not be displayed in XWiki identically to the Confluence counterpart. In view mode, an error message will appear, while in wiki edit mode, the syntax and content of the macro will be visible. As the wiki content will be imported and stored, if one of the currently unsupported macros will become available in the Pro Macros package, the content will subsequently be displayed identically to the Confluence counterpart following the update and introduction of said macro in the Pro Macros.

If one or multiple macros are required, the Client may choose to sponsor the development of those macros. Please contact sales@xwiki.com if you would like to inquiry about the development of certain macros.

Macro name	Migration supported	Comments
expand	Yes
details	Yes
toc	Yes
jira	Partial	Parameters : server, columns id, columns, jqlQuery, serverId. Depends on the parameters supported.
children	Yes	Basic version of the macro is available. Some parameters are missing.
recently-updated	Yes
anchor	Yes
panel	Yes
view-file	Yes
status	Yes
info	Yes
create-from-template	No	Already included in the standard «Create» wizard of XWiki. Should not be migrated
code	Yes
contentbylabel	Yes
include	Yes
tasks-report-macro	Yes	Part of the Task Manager (Pro) application
display-footnotes	No
pagetree	Yes
detailssummary	Yes
warning	Yes
tip	Yes
note	Yes
attachments	Yes
column	Yes
excerpt-include	Yes
section	Yes
excerpt	Yes
pagetreesearch	Yes
profile-picture	Yes
contributors	Yes
livesearch	Yes	mapped to Search Location Macro
roadmap	No
blog-posts	No	Migrate to the Blog application. Complexity depends on the parameters to migrate
noformat	Yes
viewxls	Yes
gliffy	Yes
table-filter	No
ui-expand	No
mathinline	Yes
calendar	No	Configurable calendar macro. Date macro exists.
change-history	Partial	Same information as the History panel, which is displayed by default in the page. The migration will imply removing the change history macro and using the history tab.
ui-button	No
style	No	Migrate to SSX
jirachart	No	Improvements of the JIRA macro
div	No
gadget	No
navmap	No
widget	No
pivot-table	No
viewppt	Yes
table-chart	No
listlabels	in progress
scroll-ignore	No
viewpdf	Yes
auitabspage	No
auitabs	No
status-handy	No
jira-key	No	Migration to the XWiki JIRA macro, which is already capable to display the status of a single issue.
content-report-table	Yes
multiexcerpt	Yes
ui-tab	No
ui-tabs	No
chart	No
table	No
auihorizontalnav	No
plantuml	No
unmigrated-wiki-markup	No
numberedheadings	No
popular-labels	No	Migration to tag cloud
bgcolor	No
table-excerpt-include	No
ui-text-box	No
table-joiner	No	CQL parser required
multiexcerpt-include	Yes
table-excerpt	No
outgoing-links	No
task-list	Yes	Part of the Task Manager (Pro) application
userlister	Yes
confluence-advanced-macros	No
footnote	No
viewdoc	Yes
live-template	No
drawio	Yes
pagestatus	No
confluence-information-plugin	No
jira-jqlQuery	No	Migration to the XWiki JIRA macro, which is already capable to execute JQL queries
ui-step	No
ui-steps	No
multimedia	Yes
tasklist	Yes	Part of the Task Manager (Pro) application
html	Yes	in some instances macro call is html-macro
survey	No
markdown	No
tooltip	No
spreadsheets	No
gallery	Yes
vote	No
hideelements-macro	No
scroll-exportbutton	No
unmigrated-inline-wiki-markup	No
mathblock	Yes
scroll-pagebreak	No
toc-zone	No
incoming-links	No
htmlcomment	No
insight-objects-macro	No
linkgraph	No
dbbox	No
report-info	No
report-table	No
timestamp	No
pageapproval	No
scroll-pagetitle	No
scroll-tablelayout	No
auiprogress	No
auiprogressstepstatic	No
get-metadata	No
favpages	No
loremipsum	No
polls	No
add-label	No
contributors-summary	No
profile	Yes
mockup	Yes
scroll-landscape	No
add-page-form	No
shared-block	No
scroll-imagemap	No
json-from-table	No
add-page	No
lucidchart	No
multivote	No
table-plus	Partial
center	No	Migrate to XWiki syntax.
rw-search	No
scroll-only	No
metadata	No
user-macro	No
tel	No
oitlogo	No
link-to	No
scroll-title	No
jiraissues	No
list-permitted-users-macro	No
workflowreport	No
sharelinks-urlmacro	No
scroll-portrait	No
search	No
unit	No
card	No	Re-use the existing tabs macro
deck	No	Re-use the existing tabs macro
wireframe	Yes
rss	No
tr	No	Migrate to XWiki syntax
ui-children-cards	No
pagebreak	No
tableplus	No
link-window	No
plantumlrender	No
conditionalcontent	No
auimessage	No
metadata-from	No
flowchart	No
auibutton	No
th	No	Migrate to XWiki syntax
sv-translation	No
topusers	No
include-shared-block-inline	No
questionslist-macro	No
inc-drawio	No
span	No	Macro to generate wiki syntax
globaltimeline	No
include-shared-block	No
discussion-information-box	No
discussion-contributors	No
childtabs	No
discussion-list	No
redirect	No
latex	No
lastmod	No	Equivalent to recently updated macro
portfolio-for-jira-plan	No
usage	No
spaceaccessusersminimal	No
space-attachments	No
countdown	No
recently-updated-dashboard	No	"legacy macro" according to confluence docs, which seems to recommend the "recently updated macro" instead
collapsible-panel	No
join-event	No
join-event	No
playsql-query	No
choose-label	No
english	No
scroll-ignore-inline	No
pocketquery	No
tbd	No
cql-search	No
italian	No
page-info	No
pageactivity	No
img	No	Migrate to XWiki syntax
highlight	No
pagetreecreator-button	No
csv	No
progress-bar	No
index	No
pagetreecreator-default-value	No
csv-table	No
align	No
alert	No
json-table	Partial
mermaid-macro	No
visio	No
button	No	Similar generic macro available
spacegraph	No
talk	No
spaces	No
popular	No
iframe	No	Migrate to XWiki syntax + HTML macro
excel	No
divbox	No	Could be translated to standard wiki syntax
miro	No	Advanced embed : possibility to define how to display Miro drawings
viewfile	Yes
cheese	No
scroll-office-ignore	No
new-anchorpage	No
scroll-content-block	No
related-labels	No
contact-qr-code	No
fancy-bullets	No
auibuttongroup	No
create-page	No
ancestor-labels	No
viewpdf	Yes
space-breadcrumbs	No
discussion-summary	No
metadata-report	No
discussion-space-contributors	No
space-metadata	No
aui-tab-group	No
handy-tip	No
ptc-template-properties-macro	No
excerpt-includeplus	Yes
upcoming-events	No
localtab	No
parent-link	No
html-include	No
localtabgroup	No
creation-infos	No
event-calendar	No
content-by-user	No
scroll-pdf-ignore	No
roundrect	No	Migrate to XWiki syntax
pagetreecreator-multi-button	No
pre	No
cloak	No	Re-use the existing show/hide macro
toggle-cloak	No	Re-use the existing show/hide macro
link-page	No
attachment-table	No
talk-report	No
math	No
handy-carousel	No
auidialog	No
spaceaccessusers	No
tabs-group	No
tab-pane	No
document-states-report	No
include-version	No
alias	No
handy-post-organizer	No
horizontal-nav-group	No
horizontal-nav-item	No
nav-group-advanced	No
nav-item-advanced	No
lozenge	No
ui-image	No
google-calendar	No
mathdisplay	No
network	No
ptc-tag-description	No
recently-used-labels	No
tracking-info	No
includeplus	No
plantumlreader	No
spreadsheet-table	No
child-counter	No
version-history	No
space-details	No
scroll-office-only	No
mathblock-ref	Yes
search-box	No
ptc-template-page-properties-macro	No
priority1	No
rw-users	No
clickable	No
question-answer-list-macro	No
scroll-office-only-inline	No
imagemap	No
checkbox-list	No
confluence-button	No
include-children	No
scroll-pdf-only	No
create-space-button	No
latex-formatting	No
map	No
priority2	No
checkbox	No
german	No
auihorizontalnavpage	No
handy-reminder	No
im	No
markdown-from-url	No
page-status	No
confluence-open-api	No
database-structure	No
document-stats-report	No
sv-pagetree	No
scroll-only-inline	No
priority3	No
recently-updated-dashboard-category	No
rw-pagetree	No
rw-news	No
navitabs	No
global-reports	No
flowchartrender	No
scroll-bookmark	No
orpheaned-links	No
metadata-values	No
timeline-template	No
zeiterfassung	No
confiform	No
confiform-value	No
ptc-jira	No
listallgroups	No
mugshot-gallery	No
pageapproval-report	No
space-metadata-list	No
metadata-list	No
noprint	No
ui-children	No
pagetitle	No
page-view-macro	No
vertical-nav-group	No
vertical-nav-item	No
sp-infobulle	No
scroll-indexterm	No
scroll-office-index-term	No
scroll-office-ignore-inline	No
workflow-reporter	No
metadata-calculate	No
database-info	No
playsql-chart	No
vbcp-macro	No
confiform-entry-register	No
course-list	No
format-text	No
page-permissions	No
scroll-to-top	No
gatracking	No
space-news	No
rw-users-space	No
rw-favpages	No
spaceadmins	No
childrenbylabel	No
surveydisplay	No
french	No
japanese	No
increment-metadata	No
space-metadata-from	No
metadata-table	No
atlassian	companion
diagramly	No
subpages	No	Equivalent to children macro
wiki-markup	No
rate	No
aui-pages-by-label-tab	No
searchandsortbydate	No
contributor	Yes
ptc-jira-automation	No
bibtex-display	No
tbody	No
userloginlist	No
space_administrators	No
labeltabs	No
canadian-en	No
lock-content-macro	No
currency-converter	No
view-generic-group-rule-execution-logs	No
view-export-rule-execution-logs	No
handy-post-organizer-content	No
chinese	No
english-us	No
layout	Yes
td	No	Migrate to XWiki syntax
composition-setup	No	Cannot be migrated. Specific to the Composition extension
float	No	Migrate to XWiki syntax
jira-chart	No
banner	No
showcase	No
show-card	No
bibtex-reference	No
getbitbucketadmins	No
getitrackusers	No
jql-table	No
lastupdateddate	No
mathjax-block-macro	Yes
mathjax-inline-macro	Yes
monthcalendar	No
prezi	No
privacy-mark	No
rest-table	No
table-enhancer	No
wasdalink	No
database-query-compact	No
csv-export	No
google-map	No
tableenhancer	No
dynamic_checkboxes	No
signature	No
graphity	No
gallery	Yes
enhanced-profile	No
umgebungsliste-vvp	No
members-page-disclaimer	No
activeusers	No
mail-form	No
subspaces	No
text-data	No
list-data	No
date-data	No
number-data	No
user-options	No
list-option	No
attachment-data	No
label-options	No
report-column	No
local-reporter	No
text-sort	No
report-empty	No
checklist-wiki	No
checklist-excerpt	No
checklist-label	No
easy-dropdown-menu-predefined	No
easy-dropdown-menu	No
/ shortcut	No
pdfpagebreak	No
odoo-connect	No
forecast	No
popular-pages	No
tagcloud	No	Cloud of Tags XWiki alternative
getcustomername	No
getsalesopportunity	No
getusername	No
unitube	No
requirement	No
requirement-baseline	No
requirement-property	No
requirement-report	No
requirement-report-pages	No
jira-confluence-issue-field-macro	No
jira-confluence-issue-macro	No
chart-plugin	No
hautonumheadmacro	No
listables	No
leanix-widget	No
folder-attachments	No
sa-page-version	No
html-macro	No
cnfl-code-snippet	No
lref-onedrive-embedded-file	No
lref-onedrive-files-list	No
decisionreport	No
lref-onedrive-file	No
simple-qa-export-view	No
simple-qa-overview	No
hover	No
multiexcerpt-macro	Yes
multiexcerpt-enhanced-permissions	No
multiexcerpt-include-macro	Yes
markdown-url	No
markdown-attachment	No
css-class	No
css-style	No
marked	No
drawio-sketch	No	Editor with a custom skin
show-if	No
hide-if	No
viewport-redirect	No
viewport-url-redirect	No
viewtracker	No
recently-viewed	No
viewtracker-report	No
mail-input	No
responses-table	No
checkbox-button-group	No
mail-date-picker	No
hide	No
sql-query	No
sql	No
cache	No
future	No

Macro name

Migration supported

Comments

expand

Yes

details

Yes

toc

Yes

jira

Partial

Parameters : server, columns id, columns, jqlQuery, serverId. Depends on the parameters supported.

children

Yes

Basic version of the macro is available. Some parameters are missing.

recently-updated

Yes

anchor

Yes

panel

Yes

view-file

Yes

status

Yes

info

Yes

create-from-template

Already included in the standard «Create» wizard of XWiki. Should not be migrated

code

Yes

contentbylabel

Yes

include

Yes

tasks-report-macro

Yes

Part of the Task Manager (Pro) application

display-footnotes

pagetree

Yes

detailssummary

Yes

warning

Yes

tip

Yes

note

Yes

attachments

Yes

column

Yes

excerpt-include

Yes

section

Yes

excerpt

Yes

pagetreesearch

Yes

profile-picture

Yes

contributors

Yes

livesearch

Yes

mapped to Search Location Macro

roadmap

blog-posts

Migrate to the Blog application. Complexity depends on the parameters to migrate

noformat

Yes

viewxls

Yes

gliffy

Yes

table-filter

ui-expand

mathinline

Yes

calendar

Configurable calendar macro. Date macro exists.

change-history

Partial

Same information as the History panel, which is displayed by default in the page. The migration will imply removing the change history macro and using the history tab.

ui-button

style

Migrate to SSX

jirachart

Improvements of the JIRA macro

div

gadget

navmap

widget

pivot-table

viewppt

Yes

table-chart

listlabels

in progress

scroll-ignore

viewpdf

Yes

auitabspage

auitabs

status-handy

jira-key

Migration to the XWiki JIRA macro, which is already capable to display the status of a single issue.

content-report-table

Yes

multiexcerpt

Yes

ui-tab

ui-tabs

chart

table

auihorizontalnav

plantuml

unmigrated-wiki-markup

numberedheadings

popular-labels

Migration to tag cloud

bgcolor

table-excerpt-include

ui-text-box

table-joiner

CQL parser required

multiexcerpt-include

Yes

table-excerpt

outgoing-links

task-list

Yes

Part of the Task Manager (Pro) application

userlister

Yes

confluence-advanced-macros

footnote

viewdoc

Yes

live-template

drawio

Yes

pagestatus

confluence-information-plugin

jira-jqlQuery

Migration to the XWiki JIRA macro, which is already capable to execute JQL queries

ui-step

ui-steps

multimedia

Yes

tasklist

Yes

Part of the Task Manager (Pro) application

html

Yes

in some instances macro call is html-macro

survey

markdown

tooltip

spreadsheets

gallery

Yes

vote

hideelements-macro

scroll-exportbutton

unmigrated-inline-wiki-markup

mathblock

Yes

scroll-pagebreak

toc-zone

incoming-links

htmlcomment

insight-objects-macro

linkgraph

dbbox

report-info

report-table

timestamp

pageapproval

scroll-pagetitle

scroll-tablelayout

auiprogress

auiprogressstepstatic

get-metadata

favpages

loremipsum

polls

add-label

contributors-summary

profile

Yes

mockup

Yes

scroll-landscape

add-page-form

shared-block

scroll-imagemap

json-from-table

add-page

lucidchart

multivote

table-plus

Partial

center

Migrate to XWiki syntax.

rw-search

scroll-only

metadata

user-macro

tel

oitlogo

link-to

scroll-title

jiraissues

list-permitted-users-macro

workflowreport

sharelinks-urlmacro

scroll-portrait

unit

card

Re-use the existing tabs macro

deck

Re-use the existing tabs macro

wireframe

Yes

rss

Migrate to XWiki syntax

ui-children-cards

pagebreak

tableplus

link-window

plantumlrender

conditionalcontent

auimessage

metadata-from

flowchart

auibutton

Migrate to XWiki syntax

sv-translation

topusers

include-shared-block-inline

questionslist-macro

inc-drawio

span

Macro to generate wiki syntax

globaltimeline

include-shared-block

discussion-information-box

discussion-contributors

childtabs

discussion-list

redirect

latex

lastmod

Equivalent to recently updated macro

portfolio-for-jira-plan

usage

spaceaccessusersminimal

space-attachments

countdown

recently-updated-dashboard

"legacy macro" according to confluence docs, which seems to recommend the "recently updated macro" instead

collapsible-panel

join-event

playsql-query

choose-label

english

scroll-ignore-inline

pocketquery

tbd

cql-search

italian

page-info

pageactivity

img

Migrate to XWiki syntax

highlight

pagetreecreator-button

csv

progress-bar

index

pagetreecreator-default-value

csv-table

align

alert

json-table

Partial

mermaid-macro

visio

button

Similar generic macro available

spacegraph

talk

spaces

popular

iframe

Migrate to XWiki syntax + HTML macro

excel

divbox

Could be translated to standard wiki syntax

miro

Advanced embed : possibility to define how to display Miro drawings

viewfile

Yes

cheese

scroll-office-ignore

new-anchorpage

scroll-content-block

related-labels

contact-qr-code

fancy-bullets

auibuttongroup

create-page

ancestor-labels

viewpdf

Yes

space-breadcrumbs

discussion-summary

metadata-report

discussion-space-contributors

space-metadata

aui-tab-group

handy-tip

ptc-template-properties-macro

excerpt-includeplus

Yes

upcoming-events

localtab

parent-link

html-include

localtabgroup

creation-infos

event-calendar

content-by-user

scroll-pdf-ignore

roundrect

Migrate to XWiki syntax

pagetreecreator-multi-button

pre

cloak

Re-use the existing show/hide macro

toggle-cloak

Re-use the existing show/hide macro

link-page

attachment-table

talk-report

math

handy-carousel

auidialog

spaceaccessusers

tabs-group

tab-pane

document-states-report

include-version

alias

handy-post-organizer

horizontal-nav-group

horizontal-nav-item

nav-group-advanced

nav-item-advanced

lozenge

ui-image

google-calendar

mathdisplay

network

ptc-tag-description

recently-used-labels

tracking-info

includeplus

plantumlreader

spreadsheet-table

child-counter

version-history

space-details

scroll-office-only

mathblock-ref

Yes

search-box

ptc-template-page-properties-macro

priority1

rw-users

clickable

question-answer-list-macro

scroll-office-only-inline

imagemap

checkbox-list

confluence-button

include-children

scroll-pdf-only

create-space-button

latex-formatting

map

priority2

checkbox

german

auihorizontalnavpage

handy-reminder

markdown-from-url

page-status

confluence-open-api

database-structure

document-stats-report

sv-pagetree

scroll-only-inline

priority3

recently-updated-dashboard-category

rw-pagetree

rw-news

navitabs

global-reports

flowchartrender

scroll-bookmark

orpheaned-links

metadata-values

timeline-template

zeiterfassung

confiform

confiform-value

ptc-jira

listallgroups

mugshot-gallery

pageapproval-report

space-metadata-list

metadata-list

noprint

ui-children

pagetitle

page-view-macro

vertical-nav-group

vertical-nav-item

sp-infobulle

scroll-indexterm

scroll-office-index-term

scroll-office-ignore-inline

workflow-reporter

metadata-calculate

database-info

playsql-chart

vbcp-macro

confiform-entry-register

course-list

format-text

page-permissions

scroll-to-top

gatracking

space-news

rw-users-space

rw-favpages

spaceadmins

childrenbylabel

surveydisplay

french

japanese

increment-metadata

space-metadata-from

metadata-table

atlassian

companion

diagramly

subpages

Equivalent to children macro

wiki-markup

rate

aui-pages-by-label-tab

searchandsortbydate

contributor

Yes

ptc-jira-automation

bibtex-display

tbody

userloginlist

space_administrators

labeltabs

canadian-en

lock-content-macro

currency-converter

view-generic-group-rule-execution-logs

view-export-rule-execution-logs

handy-post-organizer-content

chinese

english-us

layout

Yes

Migrate to XWiki syntax

composition-setup

Cannot be migrated. Specific to the Composition extension

float

Migrate to XWiki syntax

jira-chart

banner

showcase

show-card

bibtex-reference

getbitbucketadmins

getitrackusers

jql-table

lastupdateddate

mathjax-block-macro

Yes

mathjax-inline-macro

Yes

monthcalendar

prezi

privacy-mark

rest-table

table-enhancer

wasdalink

database-query-compact

csv-export

google-map

tableenhancer

dynamic_checkboxes

signature

graphity

gallery

Yes

enhanced-profile

umgebungsliste-vvp

members-page-disclaimer

activeusers

mail-form

subspaces

text-data

list-data

date-data

number-data

user-options

list-option

attachment-data

label-options

report-column

local-reporter

text-sort

report-empty

checklist-wiki

checklist-excerpt

checklist-label

easy-dropdown-menu-predefined

easy-dropdown-menu

/ shortcut

pdfpagebreak

odoo-connect

forecast

popular-pages

Installation Steps

This paid extensions requires 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	25	50	100	250	500	1000
Gold	1900	3800	5750	8750	11500	17500
Platinum			11500	17500	23000	35000

The Confluence Migration Toolkit package contains a collection of extensions, paid and free. If you choose to buy the full package, a discount will be applied and the final price per extension will be lower that if you would buy extensions individually. The price above is valid for purchases via online order (credit card payment), following the “How to Buy” procedure described below. The Confluence Migration Toolkit package, which can be purchased through manual order (bank transfer payment) by contacting sales@xwiki.com. Below is the list of all the extensions that are included in Confluence Migration Toolkit package.

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.0.2

Updated dependencies

Confluence Migrator Pro v1.24.4
Pro Macros v1.22.3
Task Manager Application v3.5.1
PDF Viewer v2.5.5

Extension details

This information is only displayed to Administrators. Your users can't see this tab.

License

GNU Lesser General Public License 2.1

Sources

https://github.com/xwikisas/confluence-migration-package/confluence-migration-package-ui

Issues

GitHub

Type

Developed by

XWiki SAS

Compatibility

Requires 13.10 or above.

Installable with the Extension Manager

Dependencies

com.xwiki.confluencepro:application-confluence-migrator-pro-ui 1.24.4
com.xwiki.pro:xwiki-pro-macros-confluence-bridges-ui 1.22.3
com.xwiki.task:application-task-ui 3.5.1
org.xwiki.contrib.blog:application-blog-ui 9.13.9
com.xwiki.licensing:application-licensing-licensor-api 1.26

Tags:

Created by Teodor Caras on 2024/08/02 14:24

Confluence Migration Toolkit

Confluence Migration Toolkit

Confluence Migrator

Prerequisites

Data migration

Upload export package into XWiki

Select export package from server

Advanced migration options

Imported macros

Confluence Bridge Macros and Generic Pro Macros

Generic Macros

Button

Parameters

Examples

Contributors

Parameters

Examples

Content Report Table

Parameters

Examples

Excerpt

Parameters

Example

Excerpt Include

Parameters

Example

Expand

Parameters

Example

Microsoft Stream

Parameters

Example

Panel

Parameters

Examples

Simple panel

Simple panel with border and size

Panel with title and colors

Panel with title and colors and border

Panel with bootstrap classes

Profile Picture

Parameters

Examples

Status

Parameters

Examples

Team

Parameters

Examples

All users

All users, no LDAP or OpenIDC requirements, bigger

All users, no LDAP or OpenIDC requirements, some colors

All users, with LDAP or OpenIDC requirements

All users with names, disable tools

All users with names, disable letter avatars, only in the main wiki

Recently Updated

Parameters

Example

User List

Parameters

Example

User Profile

Parameters

Example

View File

Parameters

Example

Macros used only in the context of Confluence migration

Anchor

Parameters

Attachments

Parameters

Example

Balsamiq

Parameters

Example

Column

Parameters

Examples

Simple column