p.reference.syntax

< 1 min read

Table of Contents

Syntax #

p.reference.syntax

 

Purpose #

The p.reference.syntax annotation is used to tag an element as being an example of code syntax. This will be a generic form of the code, function, or other programming component.

Examples #

The following is an example of a time where you might want to use the p.reference.syntax annotation:

Note: the relevant paragraph has been marked in bold for this example. The paragraph is not bold in the source document.

The following is an example of a rule that will apply p.reference.syntax:

Note: the p.code annotation is also applied to this paragraph. See p.code for more information.

 

The following is the DITA XML output for the previous rule:

 

<refsyn><codeblock>for item in range:</codeblock></refsyn>