You are here: Creating Documentation > AutoDoc Features > Automatic Linking
Close
Doc-O-Matic 10
Automatic Linking

The Automatic Linking feature is one of the most sophisticated Doc-O-Matic AutoDoc features. When you turn this feature on (this is the default), Doc-O-Matic scans any text for linkable parts and automatically creates links from words or symbol names in topic text to other topics.

Generic Topics

If a word matches a topic ID of a generic topic the word is automatically linked to this topic.

Symbol Topics

Depending on the context of the linked symbol name Doc-O-Matic autolinks if a word matches a symbol name. For example, within classes Doc-O-Matic automatically links to the symbol when it detects its name. Members of derived classes are automatically linked to the corresponding members in base classes. To link to a member from another class Doc-O-Matic needs classname::membername or classname.membername to be able to autolink it. 

To autolink functions you must not insert their topic IDs (classname::functionname@parm@parm) but you can enter their name. If functions can not be identified because there are several functions with the same name (for example overloaded functions) Doc-O-Matic automatically links to the first function declared in the source. 

Using namespaces the fully qualified name of a symbol is prefixed with the fully qualified namespace. There are two options for autolinking when using namespaces. You can:

  • Use the usage information in your source code. Doc-O-Matic first links symbols within a namespace and then in the namespaces that are used in this class.
  • Ignore the usage information in namespaces. Within namespaces the autolinking feature works also if you do not add namespace to the symbol name. To autolink symbols that belong to different namespaces, you must insert fully qualified names prefixed with fully qualified namespaces.
Link Text

Linked word appears as link text by default. To use the topic title as link text you have to turn on - for each section separately - the Replace link text with target title option. For details, see New Section.

Link Aliases

To link to other topics, you can use link aliases. To link words to other topic IDs, type the words and topic IDs on the Linking Aliases page. For example, you can use this feature to link to the glossary topic.

The following table shows where you can turn on autolinking, the corresponding Help topic and the default setting.

Automatic Linking
Help Topic/Option to turn on or off the automatic linking feature
Default Setting
Documentation text for each configuration
AutoDoc > Linking
Turned on
Declaration source and source code paragraphs for each configuration
AutoDoc > Linking
Turned on
Topic
Property Tags, Topic Properties / <autolink ONlOFF> comment block/ Topic Property Auto Linking
Depending on Settings
Section
New Section / [General Settings] > Sections
Turned on
Word for each configuration
AutoDoc > Linking- Banned word list
For example: a, an, and, as and so on
Words of minimum length for each configuration
AutoDoc > Linking - minimum auto-linking word length
Length: 0
Body source code
AutoDoc > Code Options > Body Source
Turned off
Other namespaces
[General Settings] > Source Parsing > Namespaces
Turned on
Copyright © 2000-2020 toolsfactory software inc. All rights reserved.