|
mediaLink |
This element is used to insert an image within a conceptual topic. This is a block element and the image appears by itself out of line.
Usage
To use a media link, insert the element within the topic at the location that the image should appear.
The nested image element is used to define the image link. The xlink:href attribute should refer to the unique ID of an image in the project's media content file. An optional placement attribute can be used to specify the placement of the image (near (the default), center, or far).
The nested caption element is optional. If specified, a caption will appear with the image. An optional placement attribute can be used to specify the placement of the caption (before (the default) or after). In addition, an optional lead attribute can be specified to define lead-in text that will prefix the caption (i.e. "Figure 1").
Example
<!-- No caption, default image placement --> <mediaLink> <image xlink:href="6be7079d-a9d8-4189-9021-0f72d1642beb"/> </mediaLink> <!-- Caption before, centered image --> <mediaLink> <caption>Caption Before</caption> <image placement="center" xlink:href="6be7079d-a9d8-4189-9021-0f72d1642beb"/> </mediaLink> <!-- Caption after with lead-in text, far image alignment --> <mediaLink> <caption placement="after" lead="Figure 1">Caption after with lead-in</caption> <image placement="far" xlink:href="6be7079d-a9d8-4189-9021-0f72d1642beb"/> </mediaLink>
Example Output
See Also