You are here: Building Output > Customizing the Generation Process > Resolving External Links
Close
Doc-O-Matic 10
Resolving External Links

There are two ways to resolves external links. If you create external links by using the link database feature, Doc-O-Matic processes them just as native links and verifies them during the generation process. But Doc-O-Matic does not verify "real" external links. Therefore, you must make sure that the target is valid and that links in the created format can go to such targets.

Link Database Feature

All topic IDs you use as native targets must either be in your current project or in a Doc-O-Matic link database. Add link databases on the Project Manager to your project. For more information about how to use the link database feature in the Topic Editor, see Using Link Databases.

HTML Help

You do not need a link database prefix when you are generating HTML Help files. When you are generating multiple cross-linked HTML Help projects, you need to store output files in the same folder. For example, when you create a HTML Help file, which links to the MFC documentation, you must copy the generated CHM (and .CHI) files to the same folder in which the MFC HTML Help files are located. 

The exporter for HTML Help resolves links automatically.

Help 2

In Help 2 namespaces are used to identify each project. You must not store projects that link to each other in the same folder.

Resolving Order

You can determine whether link database links are resolved before native links or after them on the Project Database page. Doc-O-Matic attempts to detect real native targets first and then it attempts to detect targets in all link databases by default.

Assume you have two projects, one named 3D Engine and one named First Person Shooter. You store the projects in folders that are subfolders of the same root directory.

"C:\Projects\Docs\3DEngine"

and

"C:\Projects\Docs\Shooter".
  1. Add prefixes for the link database of each project on the Files & Format > Files & Folders > Link Database page of the HTML configuration. The prefix has to be the path to the subfolder in which the HTML Files of the project are located, relative to the root directory.
  2. The link database entries of the Doc-O-Matic project 3D Engine would then be
"../3DEngine/"
  1. For the First Person Shooter project it would be
"../Shooter/".
  1. Now each link to a 3D Engine topic from First Person Shooter is prefixed with the relative path from the shooter folder to the 3D Engine folder. This is necessary if only one Doc-O-Matic generated WebHelp system can exist in a certain folder at the same time because you use numbered file names.
  2. Build each project to create entries in link databases of the two projects. Doc-O-Matic can not resolve your links this time.
  3. Then build the projects again. Now the links are resolved.
  4. To link to PDF documents that are not stored in the same folder, you also need to add prefixes in the way described above. Enter your prefixes on the Files & Format > Files & Folders > Link Database page.

Link Database HTML, Link Database PDF

PDF settings apply to: Doc-O-Matic Professional and Doc-O-Matic Author

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