The Workiva Integration Plug-in (InDesign Plug-in) is a tool that can be used to help InDesign users prepare to bring back content back into Workiva. When bringing content back into Workiva, it will be converted from IDML to XHTML. The purpose of this plugin, is to support the use case of creating an XHTML file with XBRL.
Note: This can also be used when no XBRL exists.
Initial content should be created in Workiva and exported as ICML, then imported to InDesign. The Workiva Integration Plugin should be used as designers are preparing the artwork, and before bringing the content back into Workiva as an IDML file.
The Workiva InDesign Integration Plugin is provided so that designers have a validation tool that identifies issues within an InDesign document that would corrupt or are otherwise not appropriate for conversion into XHTML. This plugin is easy to import in both Mac and PC versions of InDesign and writes a report at the click of a button. In all cases the things we point-out are XHTML conditional and not a specific condition of Workiva policy.
Download and install InDesign plug-in
To install the plug-in:
- Download plug-in either for Windows or MacOs.
- After the download completes, launch the program.
- Reboot InDesign and you will find the plug-in listed at the bottom of the Window panel.
Note: You many get warnings about security but you can safely ignore those. On a Mac, you may have to accept the plug-in in the Privacy and Security preferences.
Once you open the plug-in, it will look at the current document to write you a report.
Here are the buttons and their functions:
- Stop/Start: If you want to monitor the ICML, use the start/stop button. You can hit Start when the ICML is initially imported, or you can wait till later in the process.
- Import ICML: This button will look at your desktop to find the file exported from Workiva.
- Export IDML: This is for when you want to save to the Workiva folder on your desktop.
- Ungroup: Since all items should be ungrouped, this helps to ungroup all items exist in the file in an easy way.
- Validate: Pressing this button produces a log file showing warnings based around converting this document from IDML to XHTML. This log file can be found in the same folder of the IDML export. Remember to review it before every import into Workiva.
The validation list will let you know if something needs to be updated or recommends you to include some best practice informational items. This list is made after clicking the Validate button.
As an example, if you get this message, “All placed items must be web complaint (SVG, PNG, JPG or GIF): placed items ARE NOT web compliant”. This needs to be updated.
While, “This is informational, best practice is to not include overridden styles: styles ARE overridden” This should be updated but it is up to you.
Here are some common examples of validation messages you may encounter:
|Needs to be updated||Best practice|