RoboHelp Topic Footnotes

The following is a list of the topic footnotes RoboHelp uses in order to format RTF and DOC files for online help. The footnotes appear as subscript text next to the topic title. Each footnote directs RoboHelp to manipulate the topic in a certain way, such as include it as an index entry or in the table of contents.

Footnote Symbol Footnote name Function
* build tag-indicator An optional footnote that allows you to conditionally include topics in a specific version of a Help system.
# topic ID A required footnote that uniquely identifies a particular topic. RoboHelp uses the topic ID for links, as well as TOC and index references.
$ title An optional footnote that lists a topic in the WinHelp viewer when users perform a search. Popups typically do not use this footnote.
K index keywords (k-keywords) An optional footnote that identifies words or phrases included in the Help system's index. Index keywords are optional. Typically, popups are not included in an index, so you will not want to add this footnote to those topics.
A See Also keywords (a-keywords) An optional footnote that defines topic keywords for inclusion in See Also information. See Alsos provide links to related topics and provide additional paths for users to find information through Alink macros. Popups are typically not assigned See Also keywords.
+ browse sequence code An optional footnote that specifies a reading order for a group of topics. This allows users to browse through related topic content using browse buttons built into the Help system. Popups are typically not included in browse sequences.
! topic entry macro An optional footnote that executes a macro when a user accesses the topic. These types of macros are called topic entry macros and are similar to program scripts. Topic entry macros allow you to customize the appearance of a specific topic, such as change window size or change background color.
@ comment text An optional footnote that adds internal comments to a topic that users will not be able to see. Comments are a useful tool to convey information to other writers. You can use RoboHelp Explorer's Topic List to sort topics by comments.
> default topic window Specifies the default topic window used to display topics accessed from the Index, Find or Search tabs.

 

 


Hokum Reference