By default, new topics always have a "header", displayed in a separate editing box above the main topic editor. You can turn the header off with the options menu in the top left corner of the editor window if you want. This turns off the header for the current topic.
Initially, this header contains the title of the topic, formatted with the standard Heading1 style and with the background color set in the HTML topic page template. You can also add other content, including graphics, hyperlinks etc.
Header formatting, background colors and additional content are only supported in electronic help formats (HTML Help, WebHelp, eBooks and Visual Studio Help). ePUB eBooks have limited or no support for additional content. In print-style formats (PDF, DOCX, printed manuals) only the plain text from the header is exported when you publish and the formatting is defined separately
Formatting the header text:
By default the header text has the standard Heading1 style. The easiest way to format your header text is to edit this style in Then all new headers will automatically have the selected formatting. You can format headers manually by selecting the text and using the formatting tools in the tab if you want, but then you must do this separately for every single topic.
Setting the header background color:
In most electronic output formats the header background color is defined by the HTML topic page template.
Important: Edit in the skin file if you are using a skin!
If you are using a skin to publish this is defined in the topic page template in the skin file, not the template in your project. Make a copy of the .hmskin skin file in your project folder to edit it. Then open it in Help+Manual by selecting .hmskin as the file type to edit in the Open dialog. The template is in the same location as in a normal project file.
In the Project Explorer go to and select the Default template. Then you can set the background colors for the header and the topic body. The background colors you set in the template are automatically displayed in the editor.
See Background colors and help viewers for more details on this.
|
To turn off the header for a topic deactivate the Topic has a separate header option in the options menu at the top left corner of the editor window. This will create a topic without a header in your published output.
Warning: Turning off the header deletes any additional content you have added to the header box. If you turn the header on again the box will only contain the standard topic title, taken from the topic's TOC entry. The content will not be lost while you are still editing the current topic (you can restore it by reactivating the option) but once you leave the current topic it will be deleted permanently.
|
You can insert any content in the topic header box that you would normally insert in the main body of the topic, including graphics, hyperlinks and so on. This content will be published with the header in electronic formats (HTML Help, WebHelp, eBooks and Visual Studio Help) but not in print-style formats (PDF, DOCX, printed manuals).
Note that content added to the header will only be displayed in the current topic. If you want to include the same content in every topic (for example a logo) you need to edit the HTML topic page template and add the content to the header section of the template. See Using HTML Templates for more details.
If you want to include additional with your headers in PDF and printed manuals you need to add it to the header definitions in the print manual template – see PDF & Printed Manuals for details.
|
The topic header and its formatting and background color are not exported or used in PDF and printed manuals. In these formats, only the plain text topic title is exported, the formatting is applied with the print manual template for PDF and printed manuals (which use the same PDF templates).
In PDF you can use either the TOC topic title or the text from the topic header (if it is different). This is done by selecting either the <%HEADINGx%> variables in the template for the TOC topic title or the <%HEADINGLONGx%> variables for the text from the header box in your template in Manual Designer.
See PDF & Printed Manuals for details on accessing and editing print manual templates for PDF.
In Word DOCX the heading style from the header are used in the body text of the DOCX document, but the styles of the entries in the TOC at the beginning of the document use the Heading 1 ... Heading 9 styles defined in your DOCX template.
See MS Word DOCX for details on configuring your DOCX output for publishing.
|
See also:
Background colors and help viewers
Using HTML Templates
PDF & Printed Manuals