Clean metadata - Fluid Topics - Latest

Enrich and Clean Metadata

Category
Technical Notes
Audience
public
Version
Latest

Administrators can use the Enrich and Clean feature to clean metadata.

Example

In a group of DITA documents about gazelles written in American English, all share the metadata 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

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 Fluid Topics displays these values if left uncorrected:

A list of check boxes under the heading 'ANIMAL'. The options include 'antelope', 'Antidorcas marsupialis', 'Gazelle', and 'springbuck', each with an accompanying unchecked check box.

There are four different occurrences of the same concept, expressed in different ways.

The following screenshot shows what users expect, that is, the Animal facet with the value Gazelle for all four documents:

A single check box under the heading 'ANIMAL'. It is labelled 'Gazelle', with an accompanying unchecked check box.

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)