DITA publishing

See how from FrameMaker you can use the publishing processes to generate output for your DITA content.

From FrameMaker you can use the following processes to generate output for your DITA content.

Save as PDF

See how FrameMaker Save As PDF feature allows you to output a DITA topic or DITA map (including bookmap) as a PDF.

The FrameMaker Save As PDF feature allows you to output a DITA topic or DITA map (including bookmap) as a PDF. The PDF output that is created uses the display of the WYSIWYG view. This means that the structured application formatting rules applied to the topic or map are output to the PDF.

To create a PDF output of a DITA topic, choose File > Save As PDF.

If you use the Save As PDF feature to create a PDF output of a map, in the Save Document dialog, you can choose the option Prompt For DitaVal File.

You can use the DITAVAL feature to conditionally output the contents of the topics in the map. For details, see DITAVAL.

Multi-channel publishing

Understand how multi-channel publishing feature of FrameMaker allows you to output DITA topic or map to a number of output formats.

The multi-channel publishing feature of FrameMaker allows you to output DITA topic or map to the following output formats:

DITA Open Toolkit

Understand what is DITA Open Toolkit and how you can generate output using DITA Open Toolkit in FrameMaker.

The DITA Open Toolkit (DITA-OT) is a set of Java-based, open source tools that provide processing for DITA maps and topic content. FrameMaker has out-of-the-box support for DITA Open Toolkit 3.0 and 2.3. DITA-OT transforms DITA content (maps and topics) into deliverable formats.

By default, FrameMaker allows you to publish your DITA content into the following output formats:

  1. PDF2

  2. XHTML

  3. CHM (Install HTML Help Workshop to generate CHM)

  4. Custom

You can also generate output for formats such as Docbook, Java help, and RTF. To enable other output formats, see Change the output type list.

Generate output using DITA OT

  1. With the appropriate DITA file in focus, select Structure > DITA > Generate DITA-OT Output.

    The Generate DITA-OT Output dialog is displayed.

    Generate DITA-OT Output dialog
    Generate DITA-OT Output dialog in FrameMaker

  2. Select an output type.

  3. Select View Log File option if you want to launch the log file after publishing completes.

    By default, the DITA-OT is installed when you install FrameMaker. However, if you have separately installed the toolkit, you can specify the install location in the DITA-OT Directory field. The change to the field is only applicable for the current output. The next time you open the Generate DITA-OT Output dialog, the directory is reset to the FrameMaker default. To change the default directory, see Use a different DITA-OT package.

  4. Select Open Output Folder option to open the output folder in Windows explorer. The output folder is shown in Windows explorer after publishing completes.

  5. Select Keep This Dialog Open After Build option to keep this dialog open even after publishing completes.

  6. Choose a DITAVAL file to specify conditional filtering of content using attribute-value pairs defined in the DITAVAL file. For more information on using DITAVAL files, see DITAVAL.

    If you plan to use the same DITAVAL file when generating out for multiple documents, you can specify the file name and location in the ditafm.ini. In this case, you do not need to choose a DITAVAL file every time you generate the output.

    Note: If you specify a DITAVAL file in both locations (ditafm.ini and Generate DITA-OT dialog), the file chosen in the Generate DITA-OT output dialog takes precedence.
  7. Click Build.

FrameMaker invokes DITA-OT and generates the output in the same folder as the source topic or map.

Change the output type list

By default, FrameMaker allows you to use the DITA-OT to generate output for PDF2, XHTML, and HTML help. However, you can use the toolkit to generate output for a number of other formats. To generate output in other formats, you need to update the ditafm.ini.

Important: The following procedure requires changes to the ditafm.ini file. Before making any changes, you are recommended to take a backup of this file.
  1. Open the ditafm.ini file in the current user AppData folder: %appdata%\Adobe\FrameMaker\xx\ditafm.ini

  2. Locate the following text in the file:

    Count=3
    1=xhtml
    2=htmlhelp
    3=pdf
    Note: The numbered list above is the same as the list of output formats available in the Generate DITA-OT Output dialog.
  3. To add or remove output types from the Generate DITA-OT Output dialog, you need to specify the Count as the number of types to display in the list.

  4. The following list is the list of all available output types that you can include. To include one or more of the following types, you need to add these to the numbered list and ensure that the number sequence is maintained:

    • docbook

    • eclipsecontent

    • eclipsehelp

    • htmlhelp

    • javahelp

    • net.sourceforge

    • html

    • odt

    • pdf

    • tocjs

    • troff

    • wordrtf

    • xhtml

    Note: The output type entries in the ditafm.ini file are case-sensitive. You need to make the entries as list above.

    The following example adds the Eclipse help and Word RTF formats to the existing list.

    Count=5
    1=xhtml
    2=htmlhelp
    3=pdf2
    4=eclipsehelp
    5=wordrtf
    Note: You can completely change the list to include any set of output types.
  5. Restart FrameMaker for the changes to take effect.

Use a different DITA-OT package

FrameMaker has integrated DITA Open Toolkit 2.3. If you already have a different version of DITA Open Toolkit installed, you can customize the DITA Open Toolkit path by wither editing the dita initialization file or from Customize DITA-OT dialog.

For a one-time change, you can change the directory path when you generate the output using the DITA Open Toolkit.

To change the FrameMaker default DITA-OT directory through dita initialization file:

  1. Open the ditafm.ini file in the current user AppData folder:

    %appdata%\Adobe\FrameMaker\xx\ditafm.ini						
  2. Locate the following text in the file:

    DitaDir=%FMHOME%\fminit\ditafm\DITA-OT
  3. Modify the value of DitaDir to point to the alternative DITA-OT folder.

    For example, C:\DITA-OT_3.1.2.

  4. Restart FrameMaker.

    The new DITA OT path is populated in the DITA Generate Output dialog.

To change the FrameMaker default DITA-OT directory through Customize DITA-OT dialog:

  1. Choose Structure > DITA > Generate DITA-OT Output to pen the Generate DITA-OT Output dialog.

  2. Click the Customize button to open Customize DITA-OT dialog.

    Customize DITA-OT dialog
    Customize DITA-OT dialog in FrameMaker
  3. Provide the following details on this dialog:

    DITA-OT Directory

    Specify the path where the custom DITA-OT.zip file is stored. You can use the %FMHOME% variable, which refers to the FrameMaker install location. This path is saved in DITA_DIR variable, which can be used to specify the path of other related folders.

    Ant Command

    Specify the path of the Ant script folder. This path is relative to the DITA-OT directory on your file system.

    Ant Home

    Specify the path of the Ant installation folder.

    Classpath

    Specify the path of the Java libraries.

    Build File

    Specify the path of the Ant Build script file build.xml. This path is relative to the DITA-OT directory.

    Extra Params

    Specify any additional parameters required by your custom DITA-OT plug-in.


April 29, 2020

Legal Notices | Online Privacy Policy