p.author

Purpose

The p.author annotation places the document’s author’s name in the prolog of the topic in which it appears.

The following is an example of what the rule may look like when filled out.

The following is an example of the DITA output you would get from this annotation.

<prolog>
  <author>John Smith</author>
</prolog>

The post p.author appeared first on Stilo.

p.copyright-text

Purpose

The p.copyright-text annotation places the document’s copyright text in the prolog of the topic in which it appears. The text is placed inside data tags with the attribute name=”copyright-text” applied to it.

The following is an example of what the rule may look like when filled out.

The following is an example of the DITA output you would get from this annotation.

<prolog>
  <data name="copyright-text">
    Words and logos marked with ® or ™ are registered trademarks or trademarks owned by BirdsEye Inc. Other brands and names mentioned herein may be the trademarks of their respective owners.
  </data>
  <data name="copyright-text">
    Neither the whole nor any part of the information contained in, or the product described in this document may be adapted or reproduced in any material form except with the prior written permission of the copyright holder.
  </data>
  <data name="copyright-text">
    The product described in this document is subject to continuous developments and improvements. All particulars of the product and its use contained in this document are given by BirdsEye in good faith. However, all warranties implied or expressed, including but not limited to implied warranties of merchantability, or fitness for purpose, are excluded.
  </data>
  <data name="copyright-text">
    This document is intended only to assist the reader in the use of the product. BirdsEye Inc shall not be liable for any loss or damage arising from the use of any information in this document, or any error or omission in such information, or any incorrect use of the product.
  </data>
  <data name="copyright-text">Copyright © 2003 BirdsEye Limited. All rights reserved. </data>
</prolog>

The post p.copyright-text appeared first on Stilo.

prolog.data(data((name=namevalue)(value=datavalue)))

namevalue

name of data parameter being added

datavalue

value for data parameter being added

Purpose

The prolog.data() annotation is used to add information to the prolog of a topic. This can be anything from a simple text tag and value to an href to content located elsewhere to a complex nested structure of data elements.

The following is an example of some text from your source document that you want to put into prolog.data().

The following is an example of what the annotation may look like when filled out.

The following is an example of the DITA output you would get from this annotation.

<prolog>
  <data name="Copyright" value="Copyright © 2003 BirdsEye Limited. All rights reserved. "/>
</prolog>

The post prolog.data appeared first on Stilo.

prolog.keywords(keywords)

keywords

the keyword string

Purpose

Use prolog.keywords() to indicate keywords that will appear in the keywords of a topic’s prolog. The keyword elements may be used by a search engine.

Example: Keywords

Let us use the example of a FrameMaker document that contains Index markers. Instead of creating an index with them, you decide you want to make keywords in the prolog instead.

This is what your rule may look like for this annotation.

This is what your output may look like.

<prolog>
  <metadata>
    <keywords>
      <keyword>QuickTrace</keyword>
      <keyword>BirdsEye</keyword>
    </keywords>
  </metadata>
</prolog>

The post prolog.keywords appeared first on Stilo.

prolog.meta.audience((name=value)(type=person)(othertype=other type of person)(job=type of job)(experiencelevel=level))

name

label used to associate the values of the audience attribute with the audience element

type (optional)

person reading the document; specific allowed values are: user, purchaser, administrator, programmer, executive, services, other

othertype (optional)

person reading the document; when type is set to other, this value is used as the audience. This allows values not listed for type

job (optional)

kind of job or task you are trying to accomplish. Possible values are installing, customizing, administering, programming, using, maintaining, troubleshooting, evaluating, planning, migrating, other

otherjob (optional)

kind of job or task you are trying to accomplish; used when job is set to other.

experiencelevel (optional)

level of experience attained by reader

Purpose

The prolog.meta.audience() annotation is used to indicate the intended audience for your topic. You can optionally specify the type of person you expect to read the document, the type of job you expect the reader to need to accomplish, and the experience level you expect them to have.

The following is an example of what the annotation may look like when filled out.

The following is an example of the DITA output you would get from this annotation.

<prolog>
  <metadata>
    <audience name="engineer" type="programmer" job="maintenance" experiencelevel="expert"/>
  </metadata>
</prolog>

The post prolog.meta.audience appeared first on Stilo.

prolog.meta.category(category)

category

name of category being applied

Purpose

The category element represents any category that can be used to classify a topic for navigation or retrieval. Topics may belong to multiple categories. You may apply multiple categories to a topic, but each must use a separate instance of the annotation.

As an example, you may want to apply the categories “How To” and “Task” to all level 1 task topics. Here is how your rule may look:

Here is the output you would get from the rule above using our sample document.

<task id="ID-4884-00000306">
  <title>Installing</title>
  <prolog>
    <metadata>
      <category>How To</category>
      <category>Task</category>
    </metadata>
  </prolog>

The post prolog.meta.category appeared first on Stilo.

prolog.meta.platform(value)

value

name of platform type used

Purpose

The prolog.meta.platform() annotation produces the platform element, which is part of the prodinfo element. The prodinfo element contains platform information as well as other elements. The platform is the operating system and/or hardware being used by the product in question.

The following is an example of what the annotation may look like when filled out.

The following is an example of the DITA output you would get from this annotation. This is showing only the platform elements.

<prolog>
  <metadata>
    <prodinfo>
      <platform>Windows</platform>
      <platform>UNIX</platform>
    </prodinfo>
  </metadata>
</prolog>

The post prolog.meta.platform appeared first on Stilo.

prolog.meta.prodname(value)

value

name of product used

Purpose

The prolog.meta.prodname() annotation produces the prodname element, which is part of the prodinfo element.

The following is an example of what the annotation may look like when filled out.

The following is an example of the DITA output you would get from this annotation. This is showing only the prodname element.

<prolog>
  <metadata>
    <prodinfo>
      <prodname>QuickTrace</prodname>
    </prodinfo>
  </metadata>
</prolog>

The post prolog.meta.prodname appeared first on Stilo.

prolog.meta.othermeta((name)(value))

name

name of metadata

value

value of metadata

Purpose

The p.meta.othermeta annotation is used to identify arbitrary metadata to be added to the prolog of the topic using the othermeta element.

prolog.meta.othermeta((foo)(bar))

<prolog>
  <metadata>
    <othermeta name="foo" content="bar">
  </metadata>
</prolog>

The post prolog.meta.othermeta appeared first on Stilo.

prolog.resourceid((id=IDvalue)(conref=conref value)(appname=name of application))

IDvalue

value of the resource ID

conref (optional)

a URI reference to a DITA element

appname (optional)

name of application using the resource ID

Purpose

The prolog.resourceid() annotation is used to assign an ID to a topic that will be used by an application requiring a specific format, and that cannot use the regular topic ID element. The resource ID must be unique.

This is an example of what a resource ID text string may look like in your document.

The following is an example of what the annotation may look like when filled out.

The following is an example of the DITA output you would get from this annotation.

<prolog>
  <resourceid id="QTno875351.5" conref="QuickTimeKey" appname="QuickTime"/>
</prolog>

The post prolog.resourceid appeared first on Stilo.