Deep Link to a DITA Topic - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

The URL of a Fluid Topics topic using the architecture of the published ZIP archive takes the following form:

/access/sources/$SOURCE_ID/topic?dita:mapPath=$DITAMAP_PATH&dita:ditavalPath=$DITAVAL_PATH&dita:topicPath=$TOPIC_PATH

Where:

  • $SOURCE_ID is the "id" parameter of the source used to upload the content.

The $SOURCE_ID parameter is case-sensitive.

  • $DITAMAP_PATH is the relative path to the map in the published ZIP archive.
  • $DITAVAL_PATH is the relative path to the applied DITAVAL in the published ZIP archive. If there is no DITAVAL applied to the DITA map, the string "ft:empty" must be used.
  • $TOPIC_PATH is the relative path to the topic in the published ZIP archive. If the topic has no content and is just a ToC entry, the string "ft:empty" must be used.

Example

Given the following DITA archive uploaded through the "dita" source:

dita.zip
├── my-map.ditamap
├── audience.ditaval
└── topics
├── topic1.dita
└── topic2.dita

To access the second topic with its audience DITAVAL, use the following path:

/access/sources/dita/topic?dita:mapPath=my-map.ditamap&dita:ditavalPath=audience.ditaval&dita:topicPath=topics/topic2.dita

It is then possible to share this topic by using the following link:

http://myfluidtopics.com/access/sources/dita/topic?dita:mapPath=my-map.ditamap&dita:ditavalPath=audience.ditaval&dita:topicPath=topics/topic2.dita

All metadata values can be used to build a link pointing to a specific topic.