category

We do not currently use this element.

cause

Use the <cause> element in a resolution topic to describe a possible cause of the issue. A resolution topic can include more than one cause.

caution

As defined in the Avaya Style Guide, use the <caution> element to call attention to situations that can result in harm to software, loss of data, or an interruption of service.

chdesc

Describes a choice presented in a Choice table. Choice tables are part of a task topic.

Use the <chdesc> element in the second column of the Choice table. You must include a <chdesc> element for each <choption> you define.

The text in each <chdesc> element explains why the user would choose that option. The text can also explain the result of the choice when it is not immediately obvious.

chdeschd

Specifies a heading for the Description column in a Choice table. Choice tables are part of a task topic.

If you do not specify a <chdeschd> element, the Description column will display the default heading Description.

Use the <cheschd> element with the <choptionhd> element. Both elements must be inside a <chhead> container element.

chhead

Specifies the header row for a Choice table.

The <chhead> element is a container element inside the Choice table. The <chhead> element must contain the two header elements: <choptionhead> and <chdeschd>.

To specify a header row for a Choice table:

1. Use the <chhead> element .

2. Define the <choptionhd> and <chdeschd> elements inside the <chhead> element.

choice

Describes one way that a user can accomplish a current step.

You must define more than one <choice> element. Every <choice> element must included in a <choices> element.

choices

Contains a list of <choice> elements.

Use the <choices> element when a user must choose one of several actions within the steps of a task.

If you are presenting a series of possible actions, use the phrase Perform one of the following actions in the step.

choicetable

Contains a series of optional choices available within a step of a task.

Use the <choicetable> element when a user must choose one of several actions within the steps of a task and you want to provide additional information. For example, use the <choicetable> element if you need to explain why the user would choose that option or the result of the choice.

choption

Indicates the name of an option in a Choice table. Choice tables are part of a task topic.

Use the <choption> element in the first column of a Choice table. You must include a <chdesc> element for each <choption> you define.

Each <choption> in a Choice table contains a choice that a user can make to accomplish a step of a task.

choptionhd

Specifies a heading for the Option column of a Choice table. Choice tables are part of a task topic.

If you do not specify a <chdeschd> element, the Option column will display the default heading Option.

Use the <choptionhd> element with the <cheschd> element. Both elements must be inside a <chhead> container element.

chrow

Identifies a row inside a Choice table. Choice tables are part of a task topic.

The <chrow> element contains the two row elements: <choption> and <chdesc>.

cite

Use the <cite> element to refer to the title of a book or article. For references to other topics, our best practice is to use a reltable link and no reference. You can still use an xref if it meets one of the criteria.

cmd

Provides the required first element inside a <step>.

The <cmd> element provides the active voice instruction that the user needs to complete a step in a task topic. The text should not be longer than one sentence.

If appropriate, provide context for the action at the beginning of the command, such as On the Add User page,....

If the step requires additional explanation, include that information in an <info> element after the <cmd>.

cmdname

Indicates the name of a command used in an application.

When the <cmdname> is part of a command string or a block of code, the entire string should be wrapped by a container element. If the string is something you're instructing the user to enter, use <userinput> as the container for the string, and then tag the actual name of the command with <cmdname> and any variables with <varname>. If you're presenting a string or block of code, the appropriate container element is <codeph> or <codeblock>, depending on the size.

codeblock

Use <codeblock> for code samples. If you are presenting a block of code as an example, and the semantics of each element within the block of code is not critical in the particular context, you do not have to tag each individual element within the block of code.

In the output, all text you enter in the <codeblock> element has preserved line endings and is displayed in a monospaced font.

If you're using <codeblock> within a step, note that you cannot insert it directly within a <cmd>, but you can insert it in an <info> element after the <cmd> within the step.

If you are directing the user to enter some code, use the <userinput> element instead.

condition

Use the <condition> element to describe the problem, alarm, event, error in a resolution topic if the title doesn’t provide enough information

codeph

Use codeph element for snippets of code within the main flow of text. The code phrase is displayed in a monospaced font for emphasis.

component

We do not currently use this element.

conbody

Provides the main body-level element for a Concept topic.

The <conbody> element can include paragraphs, lists, and other elements. If you use the <conbody> element for a section or an example, you can only follow that element with other sections or examples.

concept

Provides the top-level element for a concept topic that answers the question "what is?" All concept topics must include the <concept> element.

Concepts provide background information that users must know before they can successfully work with a product or interface. A concept can also include an example or a graphic.

condition

Use the condition element to provide a description of the problem or condition within a resolution topic. You can provide one or more recommended corrective actions for each condition.

context

Provides background information for the task. This information helps users understand what the purpose of the task is, when to perform the task, and what they will gain by completing the task. This element should be brief and does not replace or re-create a concept topic on the same subject, although the context might include some conceptual information.

This element is optional and should only be included when a context provides value to the user. If the <abstract> element for the task includes some context information, you can use <context> to elaborate further on that information.