application

To tag application names.

Always reference from the common Applications.dita topic.

Do not add the Application element directly.

Y

Y

cite

To refer the title of a document or article.

To refer a topic from the same document, create the relationship table link.

Y

N

choices

Use in table rows and step elements to describe more than one way a user can accomplish a current step.

Y

Y

cmdname

To represent the name of a command used in an application.

When the cmdname is part of a command string or a block of code, wrap the entire string in a container element.

If the string is:

• what the user must enter, use <userinput> as the container, and then tag the command with <cmdname> and variables with <varname>.

• a code phrase or block of code, use <codeph> or <codeblock> depending on the string size.

Y

N

codeblock

To present a block of code as an example.

N

N

codeph

To add code snippets within the main flow of text.

Y

N

feature

To tag a product feature

Y

Y

ph

Use to organize content for reuse or conditional processing. For example, when part of a paragraph applies to a particular audience.

Y

N

filepath

Use for:

• A file, directory, or a directory path.

• URL that is not part of an xref.

msgph

Use for the system message, usually, associated with an ID.

Y

Y

msgblock

Use for multiline system message or a group of system messages.

Y

Y

menucascade

To represent a path or cascade of menus. Usually used as a container for two or more uicontrol elements. For example: <menucascade><uicontrol>File</uicontrol><uicontrol>Print</uicontrol></menucascade>.

Y

Y

systemoutput

Use for system output in response to commands, actions, or queries.

If the text must be translated, use msgph or msgblock.

Y

N

uicontrol

To specify the names of elements in a user interface.

For example, buttons, field labels, menu items, or any object that allows the user to control the interface.

You also use <uicontrol> inside <menucascade>.

Y

Y

userinput

To tell users that they must enter the text. Use <varname> if the text has a variable.

Y

Y

wintitle

To specify the name of a window, dialog box, or the static title on a page.

For example, wizard title, wizard page title, section title on a page, and window pane title.

Y

Y

Tip

Additional information to help users better understand the benefits and capabilities of the product or technology.

Y

Product

To tag Avaya or third-party product names.

Always reference from the common Product names.dita topic.

Do not add the Product element directly.

Y

N

Info

To provide additional information about a step. Add the element inside step.

N

Y

xref (cross reference)

To create a link to:

• Another topic within the same deliverable.

• A different location within the current topic.

  Note:

  Avoid linking to the content in the same topic to prevent circular references issue that might result in Publication Manager crash.

xref (web link)

To create a link to an external source such as a web page.