Table of Contents

Syntax #


Purpose #

The p.step.info annotation is used to tag an element as being additional information contained within a procedural step. This provides additional supporting information relevant to the step, but is not required to be able to perform the procedure. This annotation is similar to p.step.example, but this annotation does not provide a specific example of the procedure. It instead provides information to help the reader understand, without providing any demonstration.

Examples #

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

The following is an example of a rule that will apply p.step.info:


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



<cmd>On a new line, enter def [function name](arg1,arg2&#x2026;):</cmd>

<info><p>You do not need to include arguments when creating a function. If the function would not use any arguments, you can leave them empty.</p><p>Here is an example of a function declaration that does not use any arguments:</p><codeblock>def [function name]():</codeblock></info>