Authoring - Hiding topic headings

HelpServer displays content in a typical tri-pane web browser window. In the left pane the table of contents is shown. In the right pane the user can view the topics by selecting them one by one in the table of contents. To support this approach, each topic’s description appears in the table of content.

In printed output however it could be desirable not to have a topic’s description printed. For example, if the topic is an introduction in a book or a chapter. In such cases you are able to hide the description for printed output. Most of the time this approach will only be applicable to the first topic in a folder but you are able to hide the description of any topic.

As an example, we have added an ‘Introduction’ topic to the ‘Chapter: The eagle’ in the 'Animal information' project.

Introduction topic added

In the next image you see how the printed output looks.

Topic description shown in printed output

The introduction topic’s description looks a bit unrealistic. It also appears in the table of contents.

Topic description shown in table of content

To change this behavior, follow these steps.

Hiding a topic description

Popup the menu of the 'Introduction' topic in the ‘Chapter: The eagle’ and select the 'Properties > Hide description' option. Now, re-launch a print of the ‘Book: Birds’ and the result will look like in the next images.

Topic description hidden in printed output

This is definitely an improvement and the description does no longer appear in the table of contents.

Topic description hidden in table of contents

Changing the classes

You can also indicate this behavior in the folder class. For example you could create a new topic class that is used for introductions in chapters. Make sure that this topic class is added to the ‘Chapter’ folder class and select the option 'Hide description' on the right window.

Option 'Hide description' indicated in the classes

If authors then add a new ‘Introduction’ object to a chapter then the description will be hidden automatically in the printed output.

The description remains visible in the Workbench.

Authoring

 About HelpServer
 Starting up and logging on
 The basic working principles
 Using the content in help and documentation systems
 Formatting the content
 Searching and replacing text
 Reusing content with shares
 Navigating with hyperlinks
 Navigating with pointerpaths
 Using bookmarks and jumps
 Duplicating content with clones
 Using tables
 Including media files
 Navigating to web pages
 Using embedded chunks
 Including html code
 Navigating with menus
 Using snippets
 Spelling checking
 Using the view mode
 Creating an index
 Creating a FAQ
 Creating a glossary
 Team authoring
 Working with projects
 Setting up structured authoring
 Generating file based output
 Creating printed output
 About the print lay-out
 Creating a new print lay-out
 Customizing a print lay-out
 Assigning a print lay-out to content manually
 Assigning a print lay-out to content automatically
 Hiding topic headings
 Creating unsecured PDF files
 Importing files and folders
 Loading files in the project gallery
 Converting legacy content
 Including legacy content in real time
 Transferring objects between installations
 Smartcontent
 Notification
 Feedback
 Translating
 Customizing the look and feel
 User accounts
 Security
 Working with templates
 Working with metadata
 Versioning
 Auditing
 Workflow management
 Annotations
 Using event exits
 Appendix A: The URL parameters
 Appendix B: The object indicators
 Appendix C: Play Javascript