Write/build introductory topics

When you make source code documentation, you may want to write some extra topics to include in your documentation in addition to the code documentation. (If you use the New Library Help Project Wizard to create the projects and select the LibraryStandard.topics template in the wizard, a topic file with an introductory topic will be created.)

First create a new topic file.

In the right hand pane write the topics you want to include, like the following:

<!DOCTYPE DLHelpSource>
<Topic Title="Introduction">
  This is the first topic.
<TopicBook Title="Units">
   <TopicLink Unit=MainUnit Title="Main Unit">
   <TopicLink Unit=Unit2>

The <TopicLink> tag are used to make special links to your help file when generating a content (.CNT) file, which you turn on by selecting the file MyCustomTopics as "Contents Source" in the "Topic Files" tab. See also Building a contents file.

If you also want to have HTML output, you need to provide links to the units and/or components within the topic text. You can use the <See> element for this, e.g. "The main feature of the <See Class=TMyComponent> is that it enables you to..." will embed a link to TMyComponent, use <See Unit=MyUnit> to embed a link to MyUnit. If you want some text to only show up in the HTML output, but not in the WinHelp output, wrap the HTML-only text within <IfHTML>...</IfHTML> tags.

It is also possible to use an ordinary help authoring tool, and import the output of Time2HELP into this tool (or vice versa). See Topic ID's generated by Time2HELP for Time2HELP's topic id name scheme.

See also
About topic files
DLHelpSource Schema / Document Type

HTML generated by Time2HELP