Publish as DOCX

DOCX is the file format used by Microsoft Word to store documents. The DOCX format does include XML. For some customers, Inspire provides a publishing configuration and a publishing plug-in for DOCX.

Before you begin

  • If you don't see the DOCX options described in this topic, contact your Vasont salesperson to purchase this feature.

  • An Inspire administrator can define at the user and role level whether the Publish action is available.

    • By default, only administrators can publish content in Inspire.
    • You can see the Publish option only if you're an administrator or have the can_publish module property.

Tips and tricks

To publish an Inspire component as a DOCX file:

  1. Click Components_TopMenuOpt Components.
  2. In the Folders pane, locate the component that you want to publish.
  3. In the Components pane, right-click the component and then select Publish.
  4. On the Publish Component screen, by default, Inspire provides a Publish Name for your publishing request (job) using the component's File Name without the GUID. You can do any of the following to this job name:
    • Optionally, you can change the Publish Name to a different set of characters.
      • Use 100 characters or less
      • You must use underscores (_) instead of spaces.
    • Select a Publish Configuration to populate the Publish Name.
      • If the configuration includes a Publish Name, it overwrites anything previously used or entered into this field.
      • If the configuration does not include a Publish Name, you can leave the default of the component's File Name or enter a new name.

    • If you leave Publish Name empty, Inspire uses the component's File Name without the GUID.

    • To add a token to the Publish Name when publishing a component, follow the steps in Publish a component with tokens.
  5. Optionally, on the Publish Component screen, in Publish Configuration, select the publish settings you want to use.

    This configuration is created by an administrator and includes settings such as populating the Publish Name, identifying the export process to use, validating XML, and using profiling attribute filters.

    An administrator can choose a Publish Configuration to be shown automatically as the default. If you need to use something other than the default, you can select another option.

    The same settings on the Publish Component screen can also be set by an administrator in the Publish Configuration.

    • If you select options on the Publish Component screen, your settings are used even if they are in conflict with the Publish Configuration that an admin creates.
    • If you select options on the Publish Component screen that don't conflict with the Publish Configuration that an admin creates, then both sets of options are used.
  6. In Export Configuration (Publish), select the format as Publish Docx.
  7. If you've applied profiling attributes to content in the component you're publishing, you can use filters.
    1. To choose the profiling attributes you want included in the publishing job, click Add Filter.
    2. On the Filter profiling attributes tab, select the options you want to publish, and then click Select.
      You'll see the profiling attributes you select on the Publish Component dialog, listed after the Clear Filter button.
  8. If you want to verify that your XML code in your component is valid according to your framework at the time of publishing, select the Validate XML option.
    By default this option is not selected.
  9. If you want to import the published deliverable back into Inspire automatically, select Create Attachment.
    1. In Target Folder, select the location where you want the publish deliverable saved.

      The file is saved as a binary. By default, it is named using the following default format: Publish-{ComponentName}-YYYY-MM-DD-HHHHMM. However, an administrator can configure Inspire to omit the timestamp from the published file name.

  10. To add a snapshot to the history for this component and all referenced content, click Create snapshot.
    1. On the Create snapshot dialog, in Name, enter a descriptive title for the version in 50 characters or less.
    2. Optionally, in Comment, enter additional information differentiating this version from other snapshots in 2000 characters or less.
    3. On the Create snapshot dialog, click Create.
    You'll see a component snapshot labeled On Demand on the History tab. Look in Component details for a list of the components that were included when you created the snapshot.

    Follow the steps in View a snapshot.

  11. On the Publish Component dialog, click Publish.
    Result:

    In the top-right corner, you see a message that Inspire is preparing your publishing job.

    After Inspire successfully submits the job, you receive a notification that you can review on the Notifications tab, in Slack if it's configured for notifications, and in email.

    Tips and tricks

    • You can use Publish Server to see job status and histories, download files related to a job, and re-publish content from an existing job. To learn about job management, read Welcome to Publish Server.
      • Open Publish Server from a link in the following places:
      • For the DOCX publishing formats, you download a single standalone file
    • By default, when you select one component to publish, Inspire provides a Publish Name using the component's File Name without the GUID. You can change the Publish Name, and you see it on the Publish portal in the Title column.
    • The Publish Name is not the same as the deliverable (published content) name.
      • You can create whatever job Name you want.
      • Deliverables are named by Inspire using the following default format: Publish-{ComponentName}-YYYY-MM-DD-HHHHMM. However, an administrator can configure Inspire to omit the timestamp from the published file name.