Office Word Macro

Add the Office Word macro to a page to display the contents of a Word document.

This is great for situations where you can't simply copy the content into the Confluence page, because you want to preserve formatting or other Word functionality. 

This macro embeds your document in the page, rather than showing a simple preview. People viewing the page don't need Word installed to be able to see the document. 

On this page:

Screenshot: A page with an Office Word macro displaying a Word document with images and tracked changes.

 


There are other ways to add a document to your page:

  • Insert the file directly into the page. We'll display a PDF thumbnail of the document.
  • Use the Widget Connector Macro to embed a Google Doc.

Add this macro to your page

To add the Office Word macro to a page:

  1. Upload the Word file to your page, then publish the page. See Upload Files to learn how to do this. 
  2. From the editor toolbar, choose Insert > Other Macros.
  3. Choose Office Word from the Confluence content category.
  4. Select the attached file you want to display. 
  5. Choose Insert

You can then publish your page to see the macro in action. 

Screenshot: Configuring the Office Word macro in the macro browser. 


Edit the attached file

If you have Word installed, you can edit the attached file, and automatically re-upload the file back to Confluence. 

See Edit Files for more information on the ways to do this. 

Change the macro parameters

Macro parameters are used to change the behaviour of a macro.

To change the macro parameters:

  1. In the editor, click the macro placeholder and choose Edit.
  2. Update the parameters as required then choose Insert.

Here's a list of the parameters available in this macro. 

Parameter

Default

Description

Page Name

The page which contains the macro

Enter a page name, if you wish to display a document which is attached to another Confluence page.


File Name

none

The file name of the Office or PDF document to be displayed. The document must be attached to a page on your Confluence site.

If the file does not appear, publish the page, then head back into the editor and try again.

Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

Limitations

The Office file must be attached to the current page, or another Confluence page. The macro can't display live Office 365 files. If you use Office 365, you'll need to download the file, and then upload it to Confluence to display it with this macro. Alternatively, you could just link to the Office 365 file. 

If your uploaded file does not appear in the File Name menu in the macro browser, you'll need to publish the page, and then hit Edit to return to the editor. 

Rendering very large or complex files can put a lot of load on Confluence. For this reason, in Confluence Data Center we'll prompt you to download the file if we can't display with a set time limit. This limit varies depending on system properties set by your administrator, but is generally about 30 seconds. You can continue to view other content on the page while we attempt to display the file contents. 

Other ways to add this macro

Add this macro as you type

Type followed by the start of the macro name, to see a list of macros. 

Add this macro using wiki markup

This is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: viewdoc

Macro body: None.

{viewdoc:page=Docs|name=My document.doc}
Last modified on Jul 6, 2023

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.