Getting started with the Word Template Exporter for Confluence

Convert your Confluence pages into professional looking Word documents
word-template-exporter-confluence confluence word help

Introduction

The Word Template Exporter for Confluence add-on allows you to export your Confluence content to professional looking Word documents. You can simply use our default template or provide your own Word template. This allows you to completely customize header, footer, styles and more. If your company already has a Word template, simply upload it to Confluence and use it to export content. This tutorial will show you how to get started.

Word Template Exporter for Confluence banner

Installation

The add-on is available on the Atlassian Marketplace. At the time of writing it is only available for Confluence Server. (Please contact us if you are customer of Confluence Cloud). For server installations, you can use the Universal Plugin Manager (UPM):

  1. To visit the UPM, go to > Confluence Administration > Add-ons in the Confluence header
  2. From there click on the Find new add-ons. link at the top of the page.
  3. Then enter Word Template Exporter for Confluence.
  4. Click the install button and follow the instructions.

How to export content using the default template

To export content from Confluence to a Word document, first open the Confluence page that you would like to export. If you’d like to export the entire Confluence space, navigate to the home page of that space.

  1. In the menu on the top right select Export with Word template. Don’t confuse it with the option Export to Word. The latter is the out-of-the box Word export functionality which does not support styling nor templates.
    Export with Word template menu
  2. This opens a dialog with options. Select the desired options. If you only want to export a single page, select This page only. If you would like to produce a Word document based on the current page and all its children, select This page and all its child pages. Click on the little arrow of the template drop-down and select Default Template.
    Export options dialog
  3. Click the Start export button. This action usually completes within a few seconds. However, depending on the size of the content, it may take several minutes. The download of the word document will start automatically. Please do not navigate away from the current page.

Here’s an example of the resulting word document:

Export options dialog

How to use a custom template

In the previous example we used the default template exporting content from Confluence to Word. An easy way to get started with custom templates is to take the default template, modify it and upload it under a different name. To download the default template, follow the steps from above to bring up the Export options dialog. Then click on the highlighted words default template, as shown in the following screenshot:

Export options dialog

Clicking this link will download the .dotx template to you computer. You can then open and modify it. For example let’s modify the header and add a company logo to it.

After making the desired changes, save the template under a different name, e.g. my-template.dotx. It’s important that you save it as a template file (.dotx extension) and not as a regular word document (.docx extension).

To use the new template, you must first upload it to Confluence as an attachment. The location of the page where you upload the attachment does not matter. Maybe you already have an existing “Marketing” or “Template” page. If not, maybe now is a good time to create one.

Template attachment

After you have uploaded the template file, follow the steps from before to bring up the Export options dialog. Click on the option to select a template and notice that now the list contains the template you attached. This list shows all attachments of type .dotx. If you have other attachments with the same file extension, these will automatically show up in the list, too.

Export options dialog

To start the export, select your template from the list and click the Start export button.

Here’s an example of the resulting word document:

Export options dialog

Troubleshooting and feature requests

Please find resolutions to common issues below. If you encounter a different issue or have ideas and feature requests, please do not hestiate to email us or submit a request.

No valid license found

Problem

When clicking the export button, an error page is displayed with the following message: “No valid license found. Please contact your Confluence administrator.”

Cause

The license of the add-on is missing, not valid or expired.

Solution

Enter a valid license for the add-on: 1. Go to the add-on administration at > Confluence Administration > Add-ons. 2. Enter Word Template Exporter for Confluence in the search box. 3. Review License details and License key. 4. Enter a valid license key and click the update button.

No menu option Export with Word template

Problem

The menu only shows the standard Export to Word option, but not the Export with Word template option.

Cause

The add-on is not installed or wasn’t loaded correctly.

Solution

Make sure that the add-on is installed (see installation instructions above). If the menu option still does not show up, consult your Confluence administrator to check for errors in the log file.

Using custom table styles in your Word template

word-template-exporter-confluence confluence word help