Office Macro

Last modified by Thomas Mortagne on 2014/10/20 17:09

cogDisplays the content of an office attachment as HTML inside the current document
Developed by

XWiki Development Team

0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise, XWiki Enterprise Manager


XWiki Enterprise >= 2.5 Milestone 2



{{office reference="file.doc" filterStyles="false"/}}
{{office reference="attach:file.doc" filterStyles="false"/}}
{{office reference="url:" filterStyles="false"/}}
{{office attachment="file.doc" filterStyles="false"/}}

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
attachmentnoa valid attachment reference The name of the attachment to display. Deprecated since 5.4.6 and 6.2.2, use reference instead.
referencenoa valid resource reference or a valid attachment reference Since 5.4.6 and 6.2.2 The reference of the attachment to display. The supported resources are URLs (url:) and attachments (attach:). If no reference type or an unknown reference type is provided it's parsed as attachment reference.
filterStylesyestrue/falsetrueWhether to filter out all non-essential styles from the parsed content


Displays an office attachment defined as an attachment in another page:

{{office attachment="[email protected]" filterStyles="false"/}}


Starting with XWiki Enterprise 3.0 Milestone 3, Office Macro uses the Gallery Macro to display office presentations:



The office macro uses the office server to convert presentation slides into images. By default these images are not very large. If you want to configure the image dimensions and other stuff you'll have to copy document-formats.js from the jodconverter jar to WEB-INF/classes and edit it. For instance, if you want the slide images to have 1024px width you have to change this line:

"PRESENTATION": {"FilterName": "impress_html_Export"},


"PRESENTATION": {"FilterName": "impress_html_Export", "FilterData": {"Width": 1024}},

You can also control the compression level / quality of the generated images:

"PRESENTATION": {"FilterName": "impress_html_Export", "FilterData": {"Quality": 90, "Width": 1024}},

Prerequisites & Installation Instructions

The OpenOffice Server needs to be configured and started in order for this macro to work. See the prerequisites for the Office Importer Application for instructions.

Tags: office
Created by Sergiu Dumitriu on 2010/10/04 02:53

Get Connected