HelpSmith Topics
Making Help Authoring a Pleasure To Do

How to exclude topics from a help file?

I want to exclude some topics from a specific version of my help file, but cannot figure out how to do so.

Should I use/define Build Tags for all of my help topics?

8

Comments

In HelpSmith, conditional compilation is based on Build Tags.

For example, you can:

  • Use standard Build Tags (e.g. #HTMLHelp, #WebHelp, etc.) to include/exclude a topic in a specific output format.
  • Add custom Build Tags at:

Project|Project Options|General|Build Tags

For more details on including/excluding a topic, you can visit:

https://www.helpsmith.com/webhelp/topics/including-excluding-help-topics.htm

10

Does it mean that if I want to include/exclude a topic, I have to edit the Build Options of any topics in my project manually?

5

Yes, you should define Build Options for each topic.

By default, a topic has the "All Builds" setting in its Build Options, which means that the topic will be included to the compilation with any Build Tags, which can be selected during the compilation.

7

Please note that HelpSmith allows you to change Build Options for multiple topics:

  1. In the Project Manager, select multiple topics with the mouse, or by clicking on the needed topics while holding down the Ctrl key.
  2. Right-click on one of the selected topics, and then click Properties.
  3. In the Item Properties dialog, click Build Options.
  4. Define the Build Options that you need.
  5. Click OK.
12

Add a Comment

Please Login or Register or leave comments.

Hello World
Lorem ipsum dolor sit amet
OK
Login
Nickname or Email:
Password:
If you do not have an account, you can register.