Both the TechWriter comment models and Annotation editor support creating topic links that allow the readers of your documentation to navigate from one topic through a reference to another topic.  If you are creating topic links using the Annotation editor, it takes care of all of the details for you.  But if you are manually creating the links directly within your website comments, you will need to know the details on the syntax of the target of your link.

While JavaDoc, XHTML and XML Comments all use different tags for formatting links, the syntax of the link target is independent of the comment model.  Link targets that start with http: or https: are considered external link targets and should represent a URL to a web page.  Link targets that do not start with http: or https: are considered topic link targets and should have the following syntax:

<Item Type>.<Website Name>[#<Item Name>]

where

<Item Type> is type of item that is being linked to.  This part of the link target is required and must have one of the following values:

• Websites
• Pages
• Images
• Embedded+Media
• Style+Sheets
• Scripts

<Website Name> is the friendly name given to the website containing the topic that is being linked to.  This part of the link target is required.

<Item Name> is the name of the item whose topic is being linked to.  If this part of the link target is omitted, the link target will reference the summary topic for the specified item type.

 

Link targets must not contain any spaces.  If any of the names used to create the link target do have spaces, they should be replaced with plus sign (+) characters.

See the table below for example topic links.

Type of Topic Link	Example
Website Summary Topic	Websites.Adivo
Page Summary Topic	Pages.Adivo
Page Topic	Pages.Adivo#home.aspx
Image Topic	Images.Adivo#images/adivo3.jpg
Style Sheet Topic	Style+Sheets.Adivo#skin.css

 

 

 

 

---

© 2005-2009 Adivo Ltd. All rights reserved.