Attributes that support both filtering and flagging include platform, product, audience, and otherprops. Attribute rev only lets you flag information that matches a run-time parameter. Attribute importance currently provides output effects only for steps (where only the values "optional" and "required" are supported).
Name | Description | Data Type | Default Value | Required? |
---|---|---|---|---|
platform | Indicates operating system and hardware. This is a property attribute which supports conditional processing for filtering or flagging. | CDATA | #IMPLIED | No |
product | Contains the name of the product to which the topic applies. This is a property attribute which supports conditional processing for filtering or flagging. | CDATA | #IMPLIED | No |
audience | Indicates the intended audience for the element. This is a property attribute which supports conditional processing for filtering or flagging. | CDATA | #IMPLIED | No |
otherprops | This attribute can be used for any other properties that might be needed to describe an audience, or to provide selection criteria for the element. | CDATA | #IMPLIED | No |
importance | A range of values that describe an importance or priority attributed to an element. For example, in steps of a task, the attribute indicates whether a step is optional or required. In other contexts or specializations, other values are possible. | obsolete | deprecated | optional | default | low | normal | high | recommended | required | urgent | #IMPLIED | No |
rev | Indicates revision level of an element. It is useful for flagging outputs based on revision. | CDATA | #IMPLIED | No |
status | The status of the current element. | new | changed | deleted | unchanged | #IMPLIED | No |
The %select-atts; parameter entity is used within the DITA dtds as a common definition for attributes available to most elements for you to enable the content for improved retrievability or for selection. Some typical examples include:
The <keyword platform="Linux">chmod</keyword> command... <ph product="WhiteknuckleHandsoap">Amalgamated Cleansers get the grime!</ph> <msgph audience="programmer administrator">Divide by -1 error.</msgph> <ph otherprops="java">When using Java, use the <apiname>com.ibm.obscureclass</apiname> to calculate the value.</ph> <p importance="recommended" rev="3.2">Update anti-virus software often.</p>Note that most of the attributes allow multiple values, for example the audience attribute in the example indicates that the message is of interest to both programmers and administrators.
OASIS DITA Language Specification v1.0 -- 09 May 2005
Copyright (c) OASIS Open 2005. All Rights Reserved.