Both the TechWriter comment models and Annotation editor support referencing images.  If you are adding images using the Annotation editor, it takes care of all of the details for you.  But if you are manually referencing images within your website comments, you will need to know the details on the syntax of the image reference.

Image references should have the following syntax:

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

   or

<Image Name>

where

<Image Type> is the type of image that is being referenced.  This part of the image reference is required and must have one of the following values:

• Imported+Images
• Web+Page+Screenshots
• Image+Thumbnails

<Website Name> is the friendly name given to the website containing the image that is being referenced.  This part of the image reference does not apply to Imported Images.  For all other types of images it is required. 

When the <Image Name> syntax is used, the image type defaults to Imported Images.

See the table below for example image references.

Type of Image	Example
Imported Images	Imported+Images#sample.png    or sample.png
Web Page Screenshots	Web+Page+Screenshots.Adivo#default.png
Image Thumbnails	Image+Thumbnails.Adivo#images/adivo3.jpg

The actual images referenced as type Imported Images must be imported through the Insert Image dialog.

 

 

 

---

© 2005-2009 Adivo Ltd. All rights reserved.