Doc-O-Matic - Documentation Web Help

You are here: More Information > Special Tasks > Documenting without Editor > Topic Structure > New Section

Doc-O-Matic 6

New Section

Collapse All

Related Settings

Sections, Section Delimiter, Translating the Output

You can create new sections for your project.

To create a new section

On the Views Bar, click Settings.
Click the General Settings tab.
Select Sections.
In the Sections list, click Add.
In the Name box, type the name of the section you want to create. The name has to be unique in your project.
In the Type list, select a section type.
In Options select one or more options.
If you use XMLDoc, enter the corresponding tag in the XMLDoc box.
If you use Javadoc, enter the corresponding tag in the Javadoc box.
Click Ok. The new section is listed in the section list.
Select the new section and in Starters type the starter strings of the new section. If you do not enter section starters Doc-O-Matic automatically uses the section name as Section Starters.
The name of the section is shown as heading in the output. Depending on the type of section sections appear different in the output and Doc-O-Matic handles them differently.
To insert a section in your comments, enter the starter strings as very first character in a comment line. If you are using the Editor the first starter string in the starter string list of a section is inserted in your source code as section starter by default. If you did not enter Section Starters Doc-O-Matic inserts the section name in your source code.

Section Types Overview

Doc-O-Matic provides the following section types:

Section Type	Meaning
Standard	Text with no special meaning.
Parameter Description	Text contains descriptions of function parameters. Avoid character formatting in parameter names. In the output this section can be formatted as list of parameter names and descriptions or as two-column table.
Return Description	Text contains the description of a function return value.
Return Values	Text contains descriptions of return values. Avoid character formatting of values. In the output this section can be formatted as list of return values and descriptions or as two-column table.
Additional Information	Text contains additional information on the topic. In this section examples can be given. Section appear on a separate page in Help systems. Can be used more than once in a topic without being concatenated. Each section can be named individually by adding a user heading as first string after the section starters.
Summary	Text contains a brief description of the purpose of the item being described. This section can be generated automatically.
See Also List	Text contains either a comma separated list of topic IDs or symbol names used as See Also list or normal description text. The topic ID can also be placed each in a separate line. This section is shown on a separate page in HTML Help and in a pop-up window in Windows Help. Commas and paragraphs can be replaced in the output. (Option Output Replacing)
Ignored Text	Text that shall be ignored by Doc-O-Matic.
Glossary Text	Text that does not appears in the topic but can be used for reports and glossary pages.
Implementation Description	Text in this section is used for the description of the body source code of functions and files.
Named Section	Inserting its name as first string into the section and separating it from the rest by a comma can name this section. Commas and paragraphs can be replaced in the output. (Option Output Replacing)
Value Description List	Text contains value lists. Avoid character formatting of values. In the output this section can be formatted as list of values and descriptions or as two-column table.

Note: The section types Member Description Section, Topic Navigation, Symbol Body Source, Reports, Topic Links, Class Hierarchy and File Links are used by Doc-O-Matic to automatically created the corresponding sections. You can rename these sections. In section types Syntax (Pascal, C++, VB.NET, C#, JavaScript, Java and IDL) declaration source of the used programming language and translate declaration source to other programming languages is presented. If you use one of these sections in your comments source and text in these sections replace automatically added and translated source.

Additional Options Overview

There are some additional options that specify how Doc-O-Matic processes sections.

Option	Meaning
Autolink	Turns on or off the autolinking feature within the section.
Remove link feeds	Removes line feeds. If this option is turned on, Doc-O-Matic joins adjacent lines.
Remove spaces	Removes unnecessary white spaces. If this option is turned on, Doc-O-Matic turns a sequence of white spaces into one single white space.
Replace link text with target title	Replaces the link text with the target title. This applies for manually added links and for automatically created links. For example if you use function names as link text but you want the symbols title (classname::membername or classname.membername) to appear as link text in the output you can turn on this feature for each section that you use.
In Separate Line	Section text starts in a new line in the DTX or source file. If this option is turned on the section heading (starter) is written in a separate line. If it is turned off, the section text follows the starter at the same line, separated by a Section Delimiter.
Output Replacing	Replace text or a character in this section (for example commas or paragraphs (enter \n)) with other text (for example "\|"). The entered characters are replaced in all output formats.
Trim	Additional spaces are removed.
XMLDoc	XMLDoc starter strings. Note: You must turn on the XMLDoc feature so that you can use XMLDoc.
Javadoc	Javadoc starter strings. Note: You must turn on the Javadoc feature so that you can use Javadoc.