map-filename(filename)

map-filename-words(filename)

map-filename-lower-case(filename)

filename

name of the file

Purpose

The map filename annotations are used to create nested DITA maps. DITA allows you to physically split a map into separate files. The map file name annotations are used to pin point where a new physical DITA map should start, and what its file name should be.

Typically, this annotation is applied on elements which have also had a title annotation applied.

The variations of the map file name annotations apply different filtering logic to the file name parameter. Consider the text “vegetable recipes”:

The \* syntax is used within annotations to reference the full text of the current element. In the scenarios above, we can imagine that there is a paragraph element with content “vegetable recipes”.

The post map-filename appeared first on Stilo.

map-filename(filename)

map-filename-words(filename)

map-filename-lower-case(filename)

filename

name of the file

Purpose

The map filename annotations are used to create nested DITA maps. DITA allows you to physically split a map into separate files. The map file name annotations are used to pin point where a new physical DITA map should start, and what its file name should be.

Typically, this annotation is applied on elements which have also had a title annotation applied.

The variations of the map file name annotations apply different filtering logic to the file name parameter. Consider the text “vegetable recipes”:

The \* syntax is used within annotations to reference the full text of the current element. In the scenarios above, we can imagine that there is a paragraph element with content “vegetable recipes”.

The post map-filename-lower-case appeared first on Stilo.

map-filename(filename)

map-filename-words(filename)

map-filename-lower-case(filename)

filename

name of the file

Purpose

The map filename annotations are used to create nested DITA maps. DITA allows you to physically split a map into separate files. The map file name annotations are used to pin point where a new physical DITA map should start, and what its file name should be.

Typically, this annotation is applied on elements which have also had a title annotation applied.

The variations of the map file name annotations apply different filtering logic to the file name parameter. Consider the text “vegetable recipes”:

The \* syntax is used within annotations to reference the full text of the current element. In the scenarios above, we can imagine that there is a paragraph element with content “vegetable recipes”.

The post map-filename-words appeared first on Stilo.

p.book.approved.completed(year=year;month=month;day=day)

year

year the document was approved

month (optional)

month of the year the document was approved

day (optional)

day of the month the document was approved

Purpose

The p.book.approved.completed() annotation is used to place information in the document map about the document’s life cycle. This must include the year, and can include the month and day also.

This is an example of what the document life cycle information may look like.

The following is an example of what the annotation may look like when filled out. This example uses regular expressions; please see the patterns page for more information on how to use these. Please also see delete for how to use the p.delete annotation.Rule for p.book.approved.completed()
The following is an example of the DITA output you would get from this annotation.

<bookmeta>
  <bookchangehistory>
    <approved>
      <completed>
        <year>2003</year>
        <month>April</month>
        <day>26</day>
      </completed>
    </approved>
  </bookchangehistory>
</bookmeta>

The post p.book.approved.completed appeared first on Stilo.

p.book.othermeta((name)(value))

name

label for the metadata

value

value of the metadata

Purpose

The bookmap othermeta annotation is used to put additional data into your bookmap. There may be metadata specific to your organization or industry that you wish to capture that does not fit into the existing annotations; this metadata can be added to your bookmap as othermeta.

The following image shows you what your rule may look like.

The following shows you what the output may look like after this annotation is applied.

<bookmeta>
  <metadata>
    <othermeta content="John Smith" name="author" />
    <data>John Smith</data>
  </metadata>
</bookmeta>

The post p.book.othermeta appeared first on Stilo.

p.book.volume

Purpose

The annotation p.book.volume is used to place a paragraph of text into the volume metadata of the bookmap. There are no arguments; the paragraph to which this annotation is applied becomes the content of the volume metadata tag.

Your rule may look like this:

The following shows you what your output may look like.

<bookid>
  <volume outputclass="ID-00000008">
    Copyright © 2003 BirdsEye Limited. All rights reserved.
  </volume>
</bookid>

The post p.book.volume appeared first on Stilo.

p.map.othermeta((name)(value))

name

label for the metadata

value

value of the metadata

Purpose

The map othermeta annotation is used to put additional data into your map. There may be metadata specific to your organization or industry that you wish to capture that does not fit into the existing annotations; this metadata can be added to your map as othermeta.

The following image shows you what your rule may look like.

The following shows you what the output may look like after this annotation is applied.

<topicmeta>
  <shortdesc><draft-comment><p>John Smith</p></draft-comment></shortdesc>
  <othermeta name="author" content="John Smith"/>
</topicmeta>

The post p.map.othermeta appeared first on Stilo.

Syntax

The post Bookmap Metadata Annotations (31 annotations) appeared first on Stilo.

p.data

Purpose

The p.data annotation is used to tag an element as being a property of a topic. This tag is highly customizable and can be altered to be as specific as the topic requires. Content tagged as data is contained within a prolog. Applying this annotation will tag content as a generic data element.

A more specialized form of the <data> element should be applied if possible.

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:

<prolog>

<author>John Writer</author>

<publisher>Stilo Corporation</publisher>

<metadata>

<category>Overview</category>

</metadata>

<data>Using Migrate is a simple process, as will be explained in this document.</data>

<data>Copyright 2023</data>

</prolog>

The post p.data appeared first on Stilo.

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>

The post p.metadata appeared first on Stilo.