Topic headings in PDF

Navigation:  Publishing > PDF and Printed Manuals >

Topic headings in PDF

Previous pageReturn to chapter overviewNext page

Show/Hide Hidden Text

The formatting of your topic headings in your Help & Manual project is ignored in PDF. This is one of the key things to understand when generating PDFs in Help & Manual. Only the plain text of your topic headings is exported to the PDF document (the full formatting and layout of the body of the topics are included, of course). The formatting of the headings is defined in your print manual template, where you also define the layout of your PDF file.

Click to expand/collapseHow topics and headings are exported to PDF

Topic content:
When you publish to PDF the entire content of your topic files is exported to PDF with all its formatting and layout as you define it in the Help & Manual editor. Only the margins are set in the print manual template because there are no margins in the H&M editor, which is designed primarily for electronic documentation formats.

Topic headings:
The text of your topic headings are exported from your project as plain, unformatted text. No other content from the header box is imported (i.e. no graphics, hyperlinks etc). The formatting, positioning, spacing and layout of the topic headings are defined in the print manual template. You can use either the topic caption from the Table of Contents (TOC) or the topic header from the header box above the H&M editor for your topic headings. This is useful because it allows you to use longer (heading) or shorter (caption) versions of the heading texts as necessary.

Click to expand/collapseHow topic heading texts are inserted in your PDF documents

Your topic heading texts are inserted in the Table of Contents and Topics sections of your print manual templates using variables. The <%HEADING1%> ... <%HEADING6%> variables insert the headings from the TOC captions for topics in the TOC levels 1-6, the <%HEADINGLONG1%> ... <%HEADINGLONG1%> variables (Topics section only) insert the headings from the heading box above the H&M editor.

For more details see the help of the Print Manual Designer program.