Syntax #
s.property.description
Purpose #
The s.property.description annotation is used to tag a span element as being the description of a property. It will associate the property description with a preceding property type and/or value.
The property description acts as the definition of or other information regarding a property’s value.
Example #
The following is an example of a time when you might want to use the annotation
The following is an example of a rule that will apply the annotation
The following is the DITA XML output for the rule:
<property>
<proptype>Input </proptype>
<propvalue>None </propvalue>
<propdesc>This function does not take user input.</propdesc>
</property>
<property>
<proptype>Output </proptype>
<propvalue>None </propvalue>
<propdesc>This function does not produce output.</propdesc>
</property>
<property>
<proptype>Arguments </proptype>
<propvalue>Two </propvalue>
<propdesc>This function takes two arguments: item and range.</propdesc>
</property>
