Syntax #
s.message-number
Purpose #
The s.message-number annotation is used to tag a span 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>In this output, <msgnum>cn:start</msgnum> means that the cn command has been initiated.</p>
<p>The output <msgnum>cn:name</msgnum> means that the file has been created and assigned an autogenerated filename. In such a case, the user will see a popup that reads <msgph>Filename generated successfully</msgph>.</p>
<p>The output <msgnum>cn:end</msgnum> means that the file has been created successfully. The user will see a popup that reads <msgph>File created successfully</msgph>.</p>
<p>If at any time the output <msgnum>cn:fail</msgnum> appears, that means that the file has not been successfully created. The software has failed and must be restarted. This will create a popup that reads <msgph>Error: File not created</msgph>.</p>
