Adding Text to Special Pages

You can add text to automatically created pages by using Special Topics. Special Topics are topics that have a special meaning to Doc-O-Matic when generating your documentation. Special Topics have certain predefined IDs. The purpose of a Special Topic is to give Doc-O-Matic information that is contained nowhere else.

There are three types of Special Topics:

Special Topics such as !!INDEX, !!CONTENTS, !!WELCOME and !!COPYRIGHT_FOOTER. Using these topics you can add text to indexes, table of contents and the welcome page in HTML and to footers in all output formats. You do not need to create these Special Topic to make Doc-O-Matic generate for example an index.
The !!COPYRIGHT topic. You need to export this topic to add a copyright page to your PDF and RTF document.
Special Topics such as !!CLASSES are automatically created as folders (Contents Entries) to group symbol topics. There are several ways to include them in the output. You can:
- Show them as folders in the TOC only.
- Generate AutoDoc content for them.
- Create a "real" topic and manually add text to these topics. Overviews are automatically generated.

To create a special topic

There are several ways to create Special Topics. You can:
- Click New Topic on the Manage tab in the Create Content group and then type a predefined topic ID in the Topic ID box.
- Select one of the grouping level topics - for example Macros, and then click Document
- Add the template.dtx file to your project. It contains all special topics and standard text for each special topic. You can find the file in the support subdirectory in the Doc-O-Matic directory.
- Change the default text or add text to the Special Topics.

Notes

All Special Topics start with the two characters !!. We recommend not to use IDs in your project that start with that sequence because it is likely that additional Special Topics are added in future releases.

Special Topics Overview

This table lists all Special Topic IDs, shows whether they are needed to make Doc-O-Matic create the Special Pages and shows the output formats in which Special Topics or the changes appear. A Special Topic ID must start with "!!".

Special Topic	Meaning	Output
!!INDEX HTML Index	A brief description for the HTML index page.	HTML Help Systems
!!SYMREF	In each output format a grouping level for all symbol types is automatically generated. When you create a topic for this special topic, the !!SYMREF folder becomes the !!SYMREF topic.	HTML Help Systems, PDF, RTF
!!CONTENTS	A brief description for the HTML contents page.	HTML Help Systems
!!COPYRIGHT	The copyright topic is used to create the copyright page for PDF documents. The copyright page contains legal information about the documentation, such as information about the author of the topic and information about trademarks. The copyright topic is the second page of the generated documentation.	PDF, RTF
!!WELCOME	The description is used for the welcome page of you Help Systems.	HTML Help Systems
!!COPYRIGHT_FOOTER	The copyright notice of your company. Appears in registered commercial versions instead of the copyright information of toolsfactory above the footer of each topic page.	HTML Help Systems, RTF, PDF
!!GLOSSARY	This topic exists for backward compatibility. In this version of Doc-O-Matic glossaries are created as reports. In the added templates file the !!GLOSSARY topic containing a glossary report is included. Can be formatted like any other topic. For more information about glossaries, see Creating a Glossary.	HTML Help Systems, RTF, PDF
!!CLASSES	In each output format a grouping level for symbol types is automatically generated. When you divide your hierarchy into modules the ID is suffixed with the module name. When you create a topic for this special topic, the !!CLASSES folder becomes the !!CLASSES topic. On the AutoDoc Folder page you can generate content for these topics.	HTML Help Systems, PDF, RTF
!!FUNCTIONS	In each output format a grouping level for all symbol types is automatically generated. When you create a topic for this special topic, the !!FUNCTIONS folder becomes the !!FUNCTIONS topic. On the AutoDoc Folder page you can generate content for these topics.	HTML Help Systems, PDF, RTF
!!RECORDS	In each output format a grouping level for all symbol types is automatically generated. When you create a topic for this special topic, the !!RECORDS folder becomes the !!RECORDS topic. On the AutoDoc Folder page you can generate content for these topics.	HTML Help Systems, PDF, RTF
!!TYPES	In each output format a grouping level for all symbol types is automatically generated. When you create a topic for this special topic, the !!TYPES folder becomes the !!TYPES topic. On the AutoDoc Folderpage you can generate content for these topics.	HTML Help Systems, PDF, RTF
!!VARIABLES	In each output format a grouping level for all symbol types is automatically generated. When you create a topic for this special topic, the !!VARIABLES folder becomes the !!VARIABLES topic. On the AutoDoc Folder page you can generate content for these topics.	HTML Help Systems, PDF, RTF
!!CONSTANTS	In each output format a grouping level for all symbol types is automatically generated. When you create a topic for this special topic, the !!CONSTANTS folder becomes the !!CONSTANTS topic. On the AutoDoc Folder page you can generate content for these topics.	HTML Help Systems, PDF,RTF
!!MACROS	In each output format a grouping level for all symbol types is automatically generated. When you create a topic for this special topic, the !!MACROS folder becomes the !!MACROS topic. On the AutoDoc Folder page you can generate content for these topics.	HTML Help Systems,PDF RTF
!!FILES	In each output format a grouping level for all symbol types is automatically generated. When you create a topic for this special topic, the !!FILES folder becomes the !!FILES topic. On the AutoDoc Folder page you can generate content for these topics.	HTML Help Systems, PDF, RTF