Restrictions

The current version of the Word Template Export has some functional restrictions:

  • No graphic elements, such as emojis, in template language statements text content

  • Wiki markup rendering does not support Wiki "anchor" links

  • No nested Word tables in template language statements text content

  • Word tables with multiple rows in template language statement text content must be preceded and followed by at least a single space. 
    Please read Working with Tables to understand rendering restrictions and conditions.

  • Exporting with an active tree filter requires a template that uses the $selectedFilter expression and the filter statement

  • Use of text boxes may cause errors in word template

  • Since exporting pages rely on application links, there are some limitations when using the $selectedTreePage expression


Working with Tables

Word tables in template language must follow certain conditions to render data in a new table or in table rows.

Tables with multiple rows that is NOT preceded or followed by at least a single space will have an unexpected result.

The table MUST be preceded or followed by at least a single space.

Sample templates

Advanced Report (please see table under [[\wiki $.description]] [[/wiki]])

Sample Table Template that render values in a table

 

The table MUST NOT be preceded or followed by at least a single space.
The table MUST consist only of a single row.

Sample templates

Advanced Report (please see table under [[\each $.linkedissues]])

Sample table template that render values as table rows

 

$selectedTreePage expression export limitations

The Page context item’s “content” property must be placed on a separate line on its own as shown in the snippet below at line #3.

The rendered page will start from the expression's line position, so any text before it will be replaced.

1 2 3 4 Page (Default value is Title): [[$.]] Page Content: [[$.content]] Page Created: [[$.created]]
  1. The Page context item properties, except for the title, will return blank by default when data can’t be retrieved and if the Confluence server is down. Also read “Limitations on performance“.

  2. The HTML content of Confluence pages being rendered in the exported template are retrieved via Confluence REST API. The data retrieved from this API does not provide stylesheets and properties so not everything in the generated export will look exactly like how it is when displayed in Confluence.

  3. Large images set on their original sizes in Confluence will not be resized to fit the page. They will be rendered as is when exported.

  4. When an image is resized, in some cases only its height or width is shown in the retrieved data from the Confluence REST API, which results to weird or elongated images when exported. This may be fixed by also setting either the height or width to the same value of whichever property exists.

  5. Known issue: Converted base64 images are not supported in MS Word 2013 or lower versions.

There are 2 Confluence REST APIs used per page rendered on a Word export.

To get page details (created, creator, url, updated), we call /content/{pageId}. To get HTML content, we call /content?...expand=body.export_view. During the first API call per page, values will be "cached" so that succeeding statements that will get page details or content on the same page will just retrieve the cached value to avoid duplicate connections to Confluence REST API.

If there is a problem with connecting to the linked Confluence API URL, timeout is set to 500 ms or 0.5 sec (per API) before an empty string during export. Assuming details and content will be retrieved, failed connections will add 1 sec per page to the Word export performance.

With this, we advise to make sure application links and permissions are configured correctly to avoid performance issues.