Deep link to a DITA topic - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

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

/access/sources/{sourceId}/topic?dita:mapPath=$DITAMAP_PATH&dita:ditavalPath=$DITAVAL_PATH&dita:topicPath=$TOPIC_PATH
Path parameter Type Description
{sourceId} String The id parameter of the source used to upload the content.

The {sourceId} parameter is case-sensitive.

Query parameter Type Required? Description
$DITAMAP_PATH String Yes The relative path to the map in the published ZIP archive.
$DITAVAL_PATH String Yes 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 String Yes 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 map with its audience DITAVAL, use the following path:

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

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

https://myfluidtopics.com/access/sources/dita/map?dita:mapPath=my-map.ditamap&dita:ditavalPath=audience.ditaval

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