Setting D2HML Topic Properties

1. Select the Doc-To-Help ribbon and click Topic Properties. The D2HML Topic Properties dialog opens.

2. Make changes in the different sections of the dialog.

   General

   • ASCII Name Specifies the ASCII-only string used to identify the topic in situations where non-ASCII characters are not allowed. This property is important for authoring in languages that have non-ASCII alphabets, such as Cyrillic and Asian languages. In some instances, names generated by Doc-To-Help must be ASCII. Such instances include identifiers in *.h and *.bas map files that are used for context-sensitive Help in C and Visual Basic programming language.
   • URL Specifies the name of the generated HTM file for this topic. You can edit the name manually, or you can set a rule for it in the Project Settings dialog ("URL mode" field). You can also limit the character length of this URL using the "Truncate file name length" field in the Project Settings. Another way to edit the URL is to double-click in the URL cell in the Topics Panel and type it there.
   • Context ID The unique numeric identifier assigned to the topic during compilation (read-only). This allows the topic to be used in context-sensitive Help. Context ID settings are managed in the Project Properties dialog. See Context-Sensitive Help.
   • Comments An editable text box for comments by the author. These comments are not accessible by the end user.
   • Default Topic If selected, this will be the topic displayed when online output is opened (the "home page"). The default topic can also be set by selecting a topic in the Topics window, right-clicking, and choosing Default Topic.
   Appearance

   • Contents Title This field lets you change the topic title in the table of contents (Contents pane) without changing the actual topic title in the source document. See Creating a Table of Contents.
   • Display Title This field allows for modification of a topic title with respect to searches without changing the actual topic title in the source document. Use this property to add qualifying text to like-named topics. For example, a search for "intro" may yield several topics named Introduction, but by modifying the Display Title, you can force results such as Introduction (Help Authoring) and Introduction (HTML), without adding the text in parentheses to the source documents. This is the equivalent of adding a<Title> in HTML.
   • Related Links Label Specifies the text that precedes the subtopic buttons for this topic. If you clear this field, there will be no text above the buttons. If you would like to change the label text for a specific target, change it in the Help Targets dialog. The default label is More: See Managing Related Topics.
   • Include in Search If selected, search is enabled for this topic in NetHelp targets. If cleared, this topic is excluded from the search.
   • Disable Comments If checked, DISQUS commenting will be disabled for this topic. See Adding DISQUS Commenting to NetHelp Targets.
   Condition

   • Platforms Sets a platform-based condition for the selected topic. The topic will be included in all the target platform(s) selected. A platform includes all the targets that produce the output specified; Online Help, HTML Help, NetHelp, Printed Manual, etc. See Conditions.
   • Targets Sets a target-based condition for the selected topic. The topic will be included in all the target(s) selected. See Conditions.
   • Attributes Set an attribute-based condition for the selected topic. The topic will be included or excluded when creating conditional builds (e.g., internal or external.) Use the Attributes dialog (Project > Attributes) to create custom attributes. See Conditions and Creating and Using Attributes.
   • Disable Comments If checked, DISQUS commenting will be disabled for this topic. See Adding DISQUS Commenting to NetHelp Targets.
3. Click OK.

Note Topic properties will be hidden by default. See Showing Hidden Hotspots.