View Categories

p.message-number

< 1 min read

Table of Contents

Syntax #

p.message-number

Purpose #

The p.message-number annotation is used to tag an element as being the identifier of a message generated by a piece of software. This is the format in which it may appear in logs or internal operations, but not necessarily what the user sees through the software interface.

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:

<p>When the user attempts to create a new file, they will see the following outputs on their GOS interface:</p>

<msgnum>cn:start</msgnum>

<msgnum>cn:name</msgnum>

<msgnum>cn:end</msgnum>