prop

Darwin Information Typing Architecture (DITA) Version 1.2

Identifies an attribute, and usually values in the attribute, to take an action on. The attribute must be a conditional processing attribute: platform, product, audience, props. and otheprops; or a specialization of the props attribute.

A prop element may do one of the following:
  • A prop element with no @att attribute specified sets a default action for every prop element. It is an error to use more than one prop element with no attribute in a single document. Recovery from this error is implementation dependent; in such cases processors may, but need not, provide an error or warning message.
  • A prop element with an @att attribute but no @value attribute sets a default action for that specific attribute. For each specific attribute, it is an error to use more than one prop element with that attribute and no value in a single document. Recovery from this error is implementation dependent; in such cases processors may, but need not, provide an error or warning message.
  • A prop attribute with an @att attribute and a @value attribute sets an action for that value within that attribute. It is an error to use more than one prop element with the same attribute and value. Recovery from this error is implementation dependent; in such cases processors may, but need not, provide an error or warning message.

Contains

startflag (optional) then endflag (optional)

Contained by

val

Example

See the example in the <val> description.

Attributes

Name Description Data Type Default Value Required?
att The attribute to be acted upon. Must be one of props, audience, platform, product, otherprops, or a specialization of props. If the att attribute is absent, then the prop element declares a default behavior for any conditional processing attribute. CDATA #IMPLIED no
val The value to be acted upon. If the val attribute is absent, then the prop element declares a default behavior for any value in the specified attribute. CDATA #IMPLIED no
action The action to be taken. The options are:
include
Include the content in output. This is the default behavior unless otherwise set.
exclude
Exclude the content from output (if all values in the particular attribute are excluded).
passthrough
Include the content in output, and preserve the attribute value as part of the output stream for further processing by a runtime engine, for example runtime filtering based on individual user settings. The value should be preserved in whatever syntax is required by the target runtime. Values that are not explicitly passed through should be removed from the output stream, even though the content is still included.
flag
Include and flag the content on output (if the content has not been excluded).
(include | exclude | passthrough | flag) #IMPLIED yes
color If flag has been set, the color to use to flag text. Colors may be entered by name or code. Processor support is recommended for the color names listed under the heading "<color>" in http://www.w3.org/TR/2001/REC-xsl-20011015/slice5.html#section-N8794-Property-Datatypes and for the 6 digit hex code form (#rrggbb, case insensitive). If flag has not been set, this attribute is ignored. CDATA #IMPLIED no
backcolor If flag has been set, the color to use as background for flagged text. Colors may be entered by name or code. Processor support is recommended for the color names listed under the heading "<color>" in http://www.w3.org/TR/2001/REC-xsl-20011015/slice5.html#section-N8794-Property-Datatypes and for the 6 digit hex code form (#rrggbb, case insensitive). If flag has not been set, this attribute is ignored. CDATA #IMPLIED no
style If flag has been set, the text style to use for flagged text. The following values are enumerated:
  • underline
  • double-underline
  • italics
  • overline
  • bold
If flag has not been set, this attribute is ignored.
(underline | double-underline | italics | overline | bold) #IMPLIED no