Clean Metadata - Fluid Topics - 3.6 - Technical Notes

Enrich and Clean Metadata

Fluid Topics
Fluid Topics Version
Technical Notes
Target Audience

The following example illustrates how administrators can use the Enrich and Clean feature to clean metadata.

In a group of four DITA documents about gazelles, written in American English, all share the key animal_name. However, different authors defined different values for the key, as shown in the following table:

Document animal_name value
Gazelle Definition Gazelle
Gazelle Etymology and Name springbuck
Gazelle Species antelope
Gazelle Prehistoric Extinctions Antidorcas marsupialis

Note: The greater the number of technical writers working together, the bigger the risk of inconsistencies appearing in naming or spelling.

The following screenshot shows how these values are displayed in Fluid Topics if left uncorrected. Four different spellings generate four values in Fluid Topics.

Erroneous facet values in Fluid Topics search panel

The following screenshot shows what users expect, i.e. the Animal facet with the value Gazelle for all four documents:

Facet values in Fluid Topics search panel after corrections

In practice, administrators must define all the various values of the animal_name metadata key as synonyms of each other as follows:

  • Gazelle=(springbuck, antelope, Antidorcas marsupialis)