Tagging system-outputted text

Last Updated : Dec 02, 2014 |
Prolog information
Metadata
Keywords:
There are different types of information that might be output from Avaya products:
  • System messages (often have a message number or ID associated with them)
  • Information from the system in response to a command or system query
There are different DITA tags to use for each type of information a system displays.

System messages

Use the following DITA elements for content related to system messages:
  • For the text of system messages, use the msgph element.
  • If you’re listing a multiline system message or a group of system messages, you can use the msgblock element.
  • If you include the message identifier, tag the message number with the msgnum element.
If you are unsure of whether the system output is a recognized system message or general system output, contact your product team.

System output in response to commands, actions, or queries

Use the <systemoutput> element for content related to outputs from the system such as responses to commands, actions, or queries.