Set a description for FTML content - Fluid Topics - 4.0

Fluid Topics Configuration and Administration Guide

Category
Reference Guides
Audience
public
Version
4.0

Use the ft:description attribute or the ft:description metadata element to define a description in the map and node elements of FTML maps.

The following behavior can be expected:

  • If only the ft:description attribute is defined, crawlers take it into account.
  • If both the ft:description attribute and the ft:description metadata element are defined, crawlers take the metadata element into account instead of the attribute.

The control file has priority over the ftmap. If the ftmap and the control file both define a description, Fluid Topics only takes the control file description into account.

The ft:description attribute

It is possible to set the description with the ft:description attribute.

The following lines show an Ftmap with a description set with the ft:description attribute:

<ft:map xmlns:ft="http://ref.fluidtopics.com/v3/ft#"
ft:lang="en-US" ft:title="Time Machine Price List"
ft:description="This document lists prices for our ready-for-sale time machine models.">
<ft:toc>...</ft:toc>
</ft:map>

The following lines show an Ftmap in which a topic is given a description with the ft:description attribute:

<ft:map xmlns:ft="http://ref.fluidtopics.com/v3/ft#"
ft:lang="en-US" ft:title="Time Machine Price List">
<ft:toc>
<ft:node ft:originId="price_time_machine_1_0" href="topics/price_time_machine_1_0.html" ft:title="Time Machine v1.0 - Pricing Information"
type="topic" ft:description="This section gives pricing information for our v1.0 time machine."/>
</ft:toc>
</ft:map>

The ft:description metadata element

It is possible to set a description for the map or topic in an ft:description metadata element.

The following lines show an Ftmap with a description set in the map metadata:

<ft:map xmlns:ft="http://ref.fluidtopics.com/v3/ft#" ft:lang="en-US" ft:originId="ftmap_id" ft:title="Time Machine Price List" ft:editorialType="book">
<ft:metas>
<ft:meta key="ft:description" type="string">This document lists prices for our ready-for-sale time machine models.</ft:meta>
</ft:metas>
<ft:toc>...</ft:toc>
</ft:map>

The following lines show an Ftmap in which a topic is given a description in its metadata:

<ft:map xmlns:ft="http://ref.fluidtopics.com/v3/ft#"
ft:lang="en-US" ft:title="Time Machine Price List">
<ft:toc>
<ft:node ft:originId="price_time_machine_1_0" href="topics/price_time_machine_1_0.html" ft:title="Time Machine v1.0 - Pricing Information"
type="topic">
<ft:metas>
<ft:meta key="ft:description">This section gives pricing information for our v1.0 time machine.</ft:meta>
</ft:metas>
</ft:node>
</ft:toc>
</ft:map>

The description property in a control file

The control file also supports the description property.

The following lines show a control file with the description property set for the "Time Machine Price List" Ftmap:

<controlFile>
<resources>
<resource lang="en-US">
<title>Time Machine Price List</title>
<description>This document lists prices for our ready-for-sale time machine models.</description>
</resource>
</resources>
</controlFile>

The Fluid Topics PaF transforms these properties into the ft:description metadata element.