Attach a URL to an Ftmap - Fluid Topics - 3.9 - Technical Notes

Manage Map Attachments in Fluid Topics

Product
Fluid Topics
FT_Version
3.9
Category
Technical Notes
language
English
audience
public

To attach a URL to an Ftmap, add the following lines to the FluidTopicsControlFile.xml file:

<?xml version='1.0' encoding='utf-8'?>
<controlFile>
<resources>
<resource>
<originId>$FTMAP_ID</originId>
<attachments>
<attachment>
<originUrl>$URL_TO_ATTACH</originUrl>
<originId>my_attachment</originId>
<displayName>My link</displayName>
<mimeType>$MIMETYPE_OF_THE_URL_TARGET</mimeType>
</attachment>
</attachments>
</resource>
</resources>
</controlFile>

Where:

  • In the <resources> sub node, the originId expects the ft:originID defined for the Ftmap in the Ftmap file.
  • The <attachment> sub node expects all information related to the attachment as follows:

Tag

Description

Mandatory?

Default value

originURL

The URL to attach.

Yes

originId

The identifier of the attachment. Should be unique among all content uploaded through the DITA source.

No

originURL

displayName

The name displayed in the Reader page.

No

Extracted from originURL.

mimeType

The MIME type indicating the nature and format of the content.

No

Extracted from originURL.

While not mandatory, defining an originId for the map attachment is recommended.

Be careful not to confuse the originId metadata associated with a map attachment and the originId metadata associated with a map. The first is defined at the attachment level within the <ft:attachment> node of an Ftmap file, whereas the second can be retrieved in the Metadata journal.

Example

To attach the Is Time Travel Possible? online article to the Time Machine User Guide Ftmap:

<?xml version='1.0' encoding='utf-8'?>
<controlFile>
<resources>
<resource>
<originId>time_machine_user_guide</originId>
<attachments>
<attachment>
<originId>time_travel_article</originId>
<displayName>Is Time Travel Possible?</displayName>
<originUrl>http://www.physics.org/article-questions.asp?id=131</originUrl>
<mimeType>text/html</mimeType>
</attachment>
</attachments>
</resource>
</resources>
</controlFile>

Once published to Fluid Topics, the Is Time Travel Possible? external link is available in the Attachments tab of the Reader page when users view the the Time Machine User Guide.