Creating the Topic Files

Windows Help files usually consist of several rich-text format (RTF) files, with each file divided into one or more topics. A topic is any distinct unit of information that is separated by a page break, such as a Contents screen, a conceptual description, a set of instructions, a keyboard table, a glossary definition, a list of jumps, a picture, and so on.

You create topic files using a word processor or a text editor that can generate RTF files. (To ensure the highest compatibility, we recommend that you use Microsoft Word for Windows.) Creating Help topics involves roughly the same phases as creating printed books: gathering information, writing, and editing.

Generally, when gathering information for the Help topics, a Help author can rely on these sources:

nThe product specification

nThe application’s printed documentation

nHelp files from a previous release of the application

nHands-on experience using the alpha and beta software

nThe software engineers creating the application

Topic files also contain special Help codes that pass organizational and build information to the Windows Help compiler. Within the topic text, you create cross-reference links, pop-up window hot spots, macro commands, references to graphics files, and other codes particular to your Help file. The finished topic files contain the content and build information for the Help file.