Metadata in deep links - Fluid Topics - Latest

Manage Links in Fluid Topics
Category
Technical Notes
Audience
public
Version
Latest

It is possible to use both built-in and custom metadata to create a deep link.

The following built-in metadata keys are particularly well-suited for building deep links:

  • ft:publication_title: the title of the publication.
  • ft:originId: the document's initial identifier.
  • dita:mapPath for DITA content: the relative path to the map in the published ZIP archive.
  • dita:ditavalPath for DITA content: the relative path to the applied DITAVAL in the published ZIP archive. If there is no DITAVAL applied to the DITA map, it is mandatory to use the ft:empty string.
  • ait:code for Author-it content: the "object code" of the book as generated by Author-it.

It is possible to use the Metadata journal, or the List maps web service to retrieve all relevant metadata.

  • Updating the table of contents of a document breaks deep links using the ft:baseId metadata.
  • Updating the title of a topic or document breaks deep links using the ft:title or ft:publication_title metadata.