Deep link to an FTML 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 forms:

/access/sources/{sourceId}/topic?ft:baseId=$FTML_TOPIC_BASEID
/access/sources/{sourceId}/topic?ft:title=$TOPIC_FT_TITLE
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
$FTML_TOPIC_BASEID String Yes the ID of the topic in Fluid Topics. It takes the value of the ft:originId attribute of the map, as defined in the FTML map. It can be retrieved in Fluid Topics by viewing a structured document's metadata.
$FTMAP_FT_TITLE String Yes Takes the value of the ft:title attribute of the topic, as defined in the FTML map. It can be retrieved in Fluid Topics by viewing a structured document's metadata.

Example

Given the following FTML archive uploaded through the ftml source:

ftml.zip
├── la-fontaine-fables.ftmap
└── topics
      ├── hare-tortoise.html
      └── grasshopper-ant.html

When the "The Hare and the Tortoise" map is opened in the Reader page, by viewing a structured document's metadata, we can see that the map ft:baseId is hare_and_tortoise.

alt text_to_do

To access the second topic, use either one of the following paths:

/access/sources/ftml/topic?ft:baseId=hare_and_tortoise
/access/sources/ftml/topic?ft:title=The Hare and the Tortoise

It is then possible to share this topic by using either one of the following links:

https://myfluidtopics.com/access/sources/ftml/topic?ft:baseId=hare_and_tortoise
https://myfluidtopics.com/access/sources/ftml/topic?ft:title=The Hare and the Tortoise
  • Updating the table of contents of a document will break deep links using the ft:baseId metadata.
  • Updating the title of a topic will break a deep link using the ft:title metadata.