Gretyl's Portal

Heretto Help

Show Page Sections

Publish with PDF Generator

Publish Content with PDF Generator

The Heretto PDF Generator enables you to quickly publish PDF documents.

  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 Heretto PDF Generator publishing scenario.
    Publishing scenarios are configured by your CCMS Administrator.
  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. Set the publishing parameters.
    The publishing scenario can include the following parameters.
    DITAVAL (args.filter)
    Optional parameter. Enables you to select a DITAVAL file for conditional processing. This parameter may be pre-set and fixed in a publishing scenario.
    Locales
    Optional parameter. Enables you to select a locale (target language) when publishing localized content. If your content is not localized, this parameter defaults to the source language.
    Track changes
    Include or exclude tracked changes (suggestions) from the Content Editor in the output.
    Note:

    By default, this feature may not be available. For more information, contact your Customer Success Manager.

    Debug publish
    Generates additional files that are added in the debug folder to the output ZIP file. You can use those files to troubleshoot publishing issues in your publication. This option is only available in DITA-OT and PDF Generator publishing scenarios for those users with Administrator privileges.
  5. If applicable, provide the XSLT parameters values.
  6. Click Publish.
    The resource publishes. It may take a moment to complete.
  7. Download a ZIP file with all publication-related resources by hovering over the publishing job and clicking Download .
    Figure 1. Successfully Completed Publishing Job
    A Successfully Completed Publishing Job

Republish Content

You can easily republish content without the need to set parameters like you would when starting a new publishing job. It's useful when you troubleshoot publishing issues or want to publish new changes in your content.

When you republish content, Heretto CCMS uses the same publishing parameters that were originally set for the completed publishing job. You can view the details set for any completed publishing job in the Publish window that opens after you click a completed publishing job.

Important:

Republishing a publishing job replaces the previous output in the publishing job. The publishing job number remains the same.

All users with publishing permissions can re-publish content they or other users published.

  1. In the Content Library, click a topic or map, and in the resource drawer select Output.
  2. Click a publishing job that you want to republish.
  3. In the top-right corner of the Publish window, click More options Hamburger style option button and select Republish.

New output published according to the original parameters is ready to view and download.

Preview Content with PDF Generator

The PDF Generator enables you to preview content you are working on. Previewing content is helpful when you want to quickly check what your content looks like in the PDF output without generating numerous publishing jobs in the Output tab. Previews are not saved as publishing jobs in the Output tab.

  1. In the Content Library, open a map or a topic.
  2. From the Preview menu available in the top-right corner, select a publishing scenario.

    The listed scenarios include both default PDF Generator scenarios, and your custom PDF Generator scenarios, if any.

A new tab opens in the browser. Depending on the state of your content, one of these options happens:

  • green tick mark Preview is generated successfully, no errors: The PDF is shown in the new tab, from where you can view, download, and print it.
  • yellow exclamation mark Preview is generated with errors/warnings: A .zip file with the PDF and a cr.log file is downloaded and the new tab remains empty.

    This happens when errors/warnings do not prevent output from being generated. For example, your map links to a resource that is not included in the map. Review the cr.log file and resolve issues in content.

  • red x mark Preview failed: The Failed message is shown in the new tab.

    This happens when errors are severe and prevent output from being generated. Publish your content instead of previewing it and resolve errors reported in the publishing job.

    Note:

    When publishing, users assigned the Administrator role can also select a Debug publish option that generates additional files in the debug folder of the output ZIP file. Those files can also be used to troubleshoot publishing issues.