Publish one project component

After you've created a project to collect components and develop content, you can transform your Inspire content into a format your customers can use, such as PDF or HTML.

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

Set notifications. If you have changed the defaults and want to see publishing notifications, make sure you configure them before publishing. Follow the steps in Set notification preferences for publishing.

Use tokens in the job's Publish Name. When publishing a component or from a profile, you can use a token in the job Name to pull in data so you don't have to type it in every time you send the component out for publishing.

To publish one project component:

  1. Click Projects_TopMenuOpt Projects.
  2. On the Project Management tab, double-click the row of the project that contains the component you want to publish.
    You can also open the project by:
    • Select the row, right-clicking, and selecting Open.
    • Select the row, clicking Action_Menu the Options menu, and selecting Open.
  3. On the project tab, in the Content pane, to open the Content folder, click the expand arrow Expand folder.
  4. To select a component, click the name.
  5. Next to the component name, click Action_Menu the Options menu, and then select Publish.
  6. 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.

    • Examples of ways you can use a token in the job's Publish Name field:

      • To add the name of the MyMap component, use {$componentname}

        Example Publish Name = MyMap

      • To add the topic title of the MyMap component, use {$title}

        Example Publish Name = UserManual

      • To add the file name of the MyMap component, use {$filename}

        Example Publish Name = MyMap_ceb80930-0712-48d2-92a5-9c2ee7d2ff7d.xml

      • To add the current date and time to the job name for MyMap, use {$datetime}

        Example Publish Name = MyMap2024-04-30-111017

      • To add the name of the user who created the publishing job for MyMap, use{$username}

        Example Publish Name = MyMapjanedoe@mycompany.org

      • To add the code for the language used in the component MyMap, use {$langcode}

        Example Publish Name = MyMapen-US

      • To add the name of the language used in the component MyMap, use {$langname}

        Example Publish Name = MyMapEnglish

      • If you need a system variable that isn't in the list of examples, contact your Inspire support representative.
  7. 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.
    For some customers, Inspire provides a publishing configuration and a publishing plug-in for DOCX. If it's supported for your organization, you can select the Publish Docx option.
  8. In Export Configuration (Publish), select the format you want the output to be in, for example PDF or HTML.

    Your configuration choice is used to create the output, even if it is in conflict with the Export Configuration (Publish) set in the Publish Configuration by an administrator.

  9. 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.
  10. 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.
  11. 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.

  12. 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.

  13. 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.

    When you completes a task that triggers a notification, such as publishing content, the Slack and email body contain:

    • The notification with ten or less Issues, Errors, and Warnings.
    • A link at the bottom of the message [See Full Version].
    • You can click the [See Full Version] link to expand a section under the link with the full details.
      • 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.

    Tips and tricks

    You can use Publish Server to see job status and history, 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 following Inspire publishing formats, you download a ZIP file that includes multiple files:
        • HTML
      • For the following publishing formats, you download a single standalone file:
        • PDF
        • DocBook PDF
        • DocBook HTML
        • DOCX
      • When you use the Zoomin publishing option, you must open the notification and use the link to go to the Zoomin site.
      • For custom publishing options, you can configure the publishing deliverables.