Users can use the FluidTopicsControlFile.xml file to define metadata for each topic file present in the archive by following the instructions described in Define topic metadata.
To define a topic's ft:originId, Fluid Topics normalizes its title as follows:
- All characters are in lower case.
- Spaces become dashes (-).
- All special characters are removed, with the exception of dashes (-), underscores (_), and periods (.).
- All characters before the first letter are removed.
- If a topic title is used multiple times through a document, it becomes numbered (title, title-1, title-2, etc.).
- In the case of a possessive "'s", the apostrophe is removed entirely. For example, "Define a topic's metadata" becomes
define-a-topics-metadata.
To define and update a topic's metadata it is necessary to use a synchronous control file.
Example
The following FluidTopicsControlFile.xml shows an example of defining metadata for a topic:
<?xml version="1.0" encoding="UTF-8"?>
<controlFile>
<resources>
<resource lang="en-GB">
<filePath>path/to/document_id.docx</filePath>
<topics>
<topic>
<selector>
<originId>original-topic-id</originId>
</selector>
<originId>new_origin_id</originId>
<clusterId>new_cluster_id</clusterId>
<title>new_title</title>
<originUrl>new_origin_url</originUrl>
<description>new_description</description>
<lastEdition>new_last_edition</lastEdition>
<metas>
<meta key="product">
<value>new_product_name</value>
</meta>
</metas>
</topic>
</topics>
</resource>
</resources>
</controlFile>
| Element | Required? | Description |
|---|---|---|
selector/originId |
Yes | The originId of the targeted topic |
originId |
No | New value for ft:originId metadata |
clusterId |
No | New value for ft:clusterId metadata |
title |
No | New value for ft:title metadata |
description |
No | New value for ft:description metadata |
lastEdition |
No | New value for ft:lastEdition metadata |
originUrl |
No | New value for ft:originUrl metadata |
metas |
No | Contains all <meta> nodes |
meta |
No | New custom metadata with <key> attribute as <key>, and <value> nodes as values. |