Documentation Center

Adding CHM output format

To publish from Content Manager to CHM, create an output format for CHM. After it is created, it is available in Publication Manager to add as output for your publications.

Before you begin

To perform this task, the following must be true:
  • The user performing the task has an Output Formats Management privilege or a System Administrator privilege.
  • The style sheets for the output format being added are in place.

Procedure

  1. Sign in to Organize Space.
  2. On the top tab level, select the Settings tab.
  3. On the second tab level, select the System tab.
  4. On the third tab level, select the Output Formats tab.
  5. Select Add new at top right.
    The Add new output format dialog opens.
  6. In the GENERAL area, set the following properties:
    PropertyMandatory or optional? Description of value
    Output format nameMandatory The name of the output format. This is the name that users see in Publication Manager or in Organize Space when they publish. A good name for this output format is "CHM".
    Resolutions prioritizedMandatory A list of one or more resolutions to use for the output format. The first value in the list should be the resolution you want to see included in the topics. By default, the other resolutions are only used by custom publishing processes.
    Resolutions to exportMandatory You can ignore this property if Resolutions prioritized has only one value, or if you have no custom publishing processing that uses resolutions beyond the first one.
    If Resolutions prioritized has multiple values, and you have custom publishing using those values, select one of the values:
    All Resolutions
    This exports all resolutions listed under Resolutions and publishes them to output. Do not select this value if you are publishing your objects with logical IDs (that is, if you have set the ContentObjectIdLevel property to the value logical in the publish post-process plugin DitaDeliveryPrepareOverallPackage). This is because such a configuration would cause different resolutions of the same image to be published to the same output URL, which would lead to conflicts.
    First Matching Resolution Only
    This exports and publishes only one resolution of the image: the first resolution listed under Resolutions that exists as a resolution for the image.
    EDT of the outputMandatory The electronic data type of the output.For a CHM output format, select CHM from the list.
    DITA-OT transformation typeOptional The DITA Open Toolkit transformation type.. For a CHM output format, select htmlhelp from the list.

    For non-Western languages, you require a custom alternative to the DITA-OT HTML Help plugin. Please contact RWS Professional Services, or an implementation partner, to learn more about what options are available to you.

    Style processorMandatory The engine that will apply the layout and style.. For a CHM output format, select DITA Open Toolkit from the list.
  7. In the PUBLISHING RELATED SETTINGS area, set the following properties (which are all selected by default):
    PropertyDescription of value
    Clean up after publishingOnly clear this option if you want to debug the publishing process and want to keep temporary files, like transport packages, on the server to investigate. Remember to delete such files and select this option again after you are done debugging.
    Resolve variables during publishingOnly clear this option if your target output format, rather than the publishing engine, will resolve variables for you.
    Include missing objectsThis option determines how a referenced image that doesn't exist is handled:
    • Select this value if you want the missing image to be represented by a placeholder image showing the text "Object missing".
    • Clear this value if you want the missing object to be handled by the output format (for example, by showing a "broken image" icon on the published webpage).
  8. Select OK to close the dialog and to add the new output format to the list of output formats that are available to assign to a publication version.
  9. Restart IIS on the Content Manager server.