Under maintenance

Heretto Help

Optional Configurations for Heretto CCMS Publishing

Heretto CCMS offers a number of publishing options that can be enabled for different publishing engines, like DITA Open Toolkit (DITA-OT) Cloud or PDF Generator.

These publishing options are optional. To enable them, contact your Customer Success Manager or the Heretto support team.

Publishing option

Description

Presentation in UI

DITA-OT Cloud

PDF Generator

Include source language metadata in locales

Include Heretto CCMS metadata and taxonomy-driven attributes present in source language files in the related target language DITA-OT outputs, like HTML.

Not present

Compare versions of the same publication

Add an option to the publishing interface that enables you to compare versions of the same publication that live on different branches or in different releases.

Compare to option with a drop-down in the publishing interface

Webhooks: Initiate a manual NotifyPull API call

Available only for when webhooks are configured. Adds the Notify button in the publishing interface to initiate a manual NotifyPull API call.

Webhooks option with a drop-down in the publishing interface

Run preflight checks to check for any issues in your document before publishing it, like broken links or invalid structures

Options:

  • automatic (default)

    Preflight checks run every time users open the publishing interface.

  • manual

    Users can run preflight checks on demand.

  • mandatory

    Users must resolve any identified issues before they will be able to publish.

User interface varies based on preflight check option configured

Compare Versions of the Same Publications with DITA-OT

Heretto CCMS has an optional configuration that enables you to compare versions of the same publication that are available on different branches or in different releases. This option only works with the PDF output type in publishing scenarios that use DITA Open Toolkit (DITA-OT) 2.5.x or higher. To enable the option, contact your Customer Success Manager or the Heretto support team.

All users with publishing permissions can compare versions of the same publications by using a DITA-OT scenario.

  1. In the Content Library, click a map and in the right pane select Output > Publish.
  2. From the list on the left, select a DITA-OT publishing scenario.
  3. Optional: In the Enter description field, add a meaningful description of the publishing job.
    Once you publish the document, you can see that description in the list of completed publishing jobs.
  4. From the Compare to drop-down menu, select a branch or release to compare to the current content.
  5. Set the rest of the publishing parameters.
  6. Click Publish.

    The resource publishes in the In progress section. A progress bar provides details about the publishing process.

  7. Download a ZIP file with all publication-related resources by hovering over the publishing job and clicking Download .
    Figure 1. A Successfully Completed Publishing Job
    A Successfully Completed Publishing Job
The PDF output file highlights content differences with red and green.