You are here: Creating Documentation > Topic Editor > Word-processing Features > Adding Sections
Close
Doc-O-Matic 10
Adding Sections

This topic describes how you can divide your topics in logical areas such as examples, see also lists and notes. 

In Doc-O-Matic these parts are called sections. All sections have a specific meaning in your topic, (for example a summary, notes, remarks, parameter description or the version of the program you are documenting). Sections consist of headings and section text. You can create as many sections as you need for your project. 

When you write text in the Editor without adding a specific section you are writing text for the default section. In the default setting the description section is the default section

Doc-O-Matic includes 22 predefined sections and 12 section types. In addition, there are 16 sections and 16 section types that are used for several AutoDoc features.

  1. There are two ways to add sections in a topic. You can:
    • On the Editor tab, in the Sections group, click Append Section , or select Append Section on the shortcut menu. This adds a new section heading at the end of the topic.
    • On the Editor tab, in the Sections group, click Insert Section , or select Insert Section on the shortcut menu. This inserts a new section heading at the current paragraph.
  2. On the Section menu, select the section you want to add.
    Note: Sections you have already used in your topic appear on the bottom of the Section menu.
  3. Add text to the section you have created.

A section in a specific topic is always printed in one block. If you use a section twice in a topic the two parts are combined. The only exceptions are Additional Information type sections (for example the Example section). These sections can be used several times in a topic.

Sections you enter in the Editor appear in a specific way, however this is not how sections appear in the output. You can customize the appearance of all sections for all output formats separately.

In the Editor
In the output
Additional HTML features
Headings
  • Section names appear as headings.
  • Section names appear as headings.
  • Section names are omitted.
  • Section names appear as headings except when the section is the first section in the topic
  • The first heading in Additional Information and Named Section type section is used as heading.
  • Images appear in addition or instead of headings.
  • Section headings are expandable.
  • Links to section headings are shown below the topic title.
  • Tab set names appear as heading for tab sets. By default Syntax is displayed as heading of the declaration source tab set.
Section Appearance
  • Default Setting: Sections appear in the order in which they are inserted.
  • Definition option on the Application Option page Editor: Sections appear in the order they are listed on the Sections Settings page.
  • Sections appear in the order set on the Section Appearance page.
  • Additional Information, Navigation, Class Hierarchy and Body Source type sections appear on a separate page.
  • Sections can appear in a pop-up window.
  • Sections can appear in a tab set.

Doc-O-Matic can automatically create summary sections. You can turn on this feature on the Automatic Section Settings page. 

You can use sections as conditional texts. To create different types of documentation from only one project you can create special sections (for example "enterprise version") and prevent the export of this section. For details, see How can I create different documentation from one source?.

Copyright © 2000-2020 toolsfactory software inc. All rights reserved.