You are here: More Information > Special Tasks
Special Tasks
Technical Reference
> Documenting without Editor > Formatting Comments > Text Formatting > Link Tag
Close
Doc-O-Matic 10
Link Tag

In Doc-O-Matic there are several ways to link to other topics: You can:

  • Manually link to other topics using the link or the XML compatible xref tags.
  • Link to Urls or files using the extlink or the XML compatible exref tags.
  1. Enter <extlink_linktarget_> or <exref target= "_target_"> to link to targets outside the project. Doc-O-Matic does not verify the _linktarget_. For this reason you must ensure that the target is valid and the exporter understands how to create a hyper link to it.
  2. To link to the following external targets enter:
Output Format
External Help Topics
Web Page
File
In RTF
RTF Topic ID
http:// and the name of the Web page.
Note: Doc-O-Matic assumes that the target is an URL and it uses the ShellExecute macro to open a browser window.
File:// and the relative or absolute path to the filename.
Note: The file can only be opened if the program that is used to open the file is installed on the computer.
In HTML
HTML Topic ID
http:// and the name of the Web page
File:// and the absolute path to the file.
In PDF
http:// and the name of the Web page
pdf:// filename.
  1. Enter <link_topicid> or <xref target="topicid"/> to insert native inline links manually.
  2. To have Doc-O-Matic replace the inserted link text with the target title, select the Replacing link text with target title check box in the section definition. For example you might not want to insert full names of functions as target text but you want full names (classname::membername or classname.membername) to appear in the output. For details, see New Section.

Linking, Linking Aliases, This section explains how you can create links in your comment block.

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