4.3.��Links to Other Pages

A How-To Recipe

Jeff Elpern


You need to link to another component within the DocSet. For example, you want to reference a figure in another chapter of a book with the hyper link displaying the figure number and description. In addition, if the description is modified you want all the references to reflect the change .


Stuff goes here.


The olink is used to reference a ID in another component with the DocSet. The specific ID is determined by reference to the target component and the target ID within that component.

  • targetdoc. This identifies the component, within the DocSet, that contains the target ID. This can be the ID of the top level tag, or the default witch is the full path name for the page - relative to the DocSet - with underscores replacing the slashes.

  • targetptr. This is the ID of the target tag.

The Olink is especially powerful because any change to the text of the target element will be propagated back to all reference to the element. For example, if you use on olink to a figure the hyper link created will have the text describing the figure. If you late change the description of the figure all olink references to the figure will have the hyper link text update.


Fixup needed on Path Names: If the target page has a path, and not a direct page name, then the slashes in the path have to be converted to underscores. For example "rootPage/chapTest" has to be converted to "rootPage_chapTest"


Stuff goes here

Reference Material

Stuff goes here

Univ/CIE/KA/StrucDoc/HowToBookProto/ChapLinks/olink (last edited 2015-03-06 18:11:26 by localhost)