You are here: Interface Components > Settings
Other Interface Components
Doc-O-Matic Tools
Messages
> General > Sections > Edit Section
Close
Doc-O-Matic 10
Edit Section

How to get here: In Settings on the General Settings tab, select [General Settings] > Sections.

  1. In the Name box, type a unique name for your section. You must not use the name for another section in your project.
  2. Click the Type arrow to display the list. For details, see the Section Type table.
  3. To replace text or a character, select the Output Replacing check box. For example, you might replace "," by spaces (enter spaces) or paragraphs (enter: \n). The text is replaced in all output formats.
  4. To remove additional spaces in the output, select the Trim check box.
  5. If you use XMLDoc as documentation standard, select the XML tags in the XMLDoc tags list or enter them in the XMLDoc box.
  6. If you use Javadoc as documentation standard, select the Javadoc tags in the Javadoc tags list or enter them in the Javadoc box.
  7. In the Description box, describe the purpose of the section.
  8. Under Options, turn on one of the following options:
Option
Meaning
Autolink
Turns on or off the autolinking feature within the section.
Remove line 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.
End automatically after paragraph
Section ends automatically after a paragraph, the following text till the next section delimiter is displayed as default section. This style is not used in the editor.

automatic linking A Doc-O-Matic feature that automatically creates links from words or symbol names to topics the topic IDs of which are the same as the words or symbol names or can be associated with them. 

line feed ASCII character that moves the insertion point to the next line. 

section delimiters Characters that separate section text from section starters. 

DTX file (.dtx file) A file that Doc-O-Matic uses to store comments and topic text. DTX files are also called Topic Files

Section (Default)
Section (VS-Template)
Type
Settings Page
Body Source
Body Source
Symbol Body Source
Class Hierarchy
Inheritance Hierarchy
Class Hierarchy
Container
Container
Symbol Container
Pascal, C++, C#, Visual Basic, PHP, MATLAB, JavaScript, IDL, Java
Pascal, C++, C#, Visual Basic, PHP, MATLAB, JavaScript, IDL, Java
Syntax
Links
Links
Topic Links
Navigation Links Format (HTML)
Reports
Reports
Reports
Section Format (HTML, PDF, RTF), Table Layout
Overload List
Overload List
Overload List
Navigation
Navigation
Topic Navigation
Members
Members
Member Description Section
Copyright © 2000-2020 toolsfactory software inc. All rights reserved.