Table of Contents

Syntax #

p.metadata

 

Purpose #

The p.metadata annotation is used to tag an element as being “behind the scenes” keywords, information, or other filters that can be used in indexing and navigation. This information does not appear in the topic itself. Applying metadata tags allows for easier single sourcing and propagation across multiple documents.

 

This annotation is used to place content in the metadata for the topic. This element will be properly included alongside other prolog elements if it is adjacent to those other elements in the document.

 

This annotation will assign its content as a <category>.

Examples #

The following is an example of a time when you might want to use the annotation:

 

The following is an example of a time when you might want to use the annotation:

 

 

The following is the DITA XML output for the rule:

 

<title>Introduction to Migrate Rule Writing</title>

<prolog>

<author>John Writer</author>

<publisher>Stilo Corporation</publisher>

<metadata>

<category>Overview</category>

</metadata>

</prolog>