R

Last Updated : Mar 07, 2023 |

refbody

Provides the main body-level element for a Reference topic.
The <refbody> element can include the following elements in any sequence or number:
  • Simple and standard tables
  • Property lists
  • Generic sections
  • Generic examples

report-element

Use this element to tag elements in a report output, such as the report column title, the data elements in the report, etc. These elements are not for elements in the product interface that are used to generate the reports. Instead, these elements are for resulting reports that are generated.

report-name

Use this element to tag the names of reports that are generated by a product.

reference

Provides the top-level element for a reference topic, which provides necessary facts about a subject. All reference topics must include the <reference> element.
Reference topics typically provide facts that a user needs to successfully complete a task or to work with a product or interface. For example, a reference topic can include commands and field descriptions. A reference topic cannot include an explanation of concepts or procedures.
Provides links to the related information of a topic.
In the output, the related links are displayed at the end of the topic similar to the relationship table links. You must add the link to topics in related-links/link/link text element.

relcell

Identifies a cell in the Relationship table.
A <relcell> element contains <topicref> elements. These elements are related to <topicref> elements in other cells of the same row.
By default, <topicref> elements in the same cell are not related to each other. To make <topicref> elements in the same cell related to each other, you must change the collection-type attribute of the <relcell> element.

relcolspec

Defines a column in a Relationship table.
Use the <relcolspec> column definition to set the default attributes for <topicref> elements in the column. For example, set type="concept" to treat all untyped <topicref> elements in the column as concepts.

relheader

Identifies a row of column definitions in a relationship table. Each column definition is a <relcolspec> element inside the <relheader> element.
Each relationship table can have only one set of column definitions.

relrow

Identifies a row in a relationship table.
The <relrow> element creates a relationship between the cells in the row. In the output, this relationship is expressed as links among the <topicref> elements in the cells.

reltable

Identifies a relationship table, which defines the relationships between topics.
The <reltable> is based on the table model of the following elements:
  • Rows contained in <relrow> elements
  • Columns identified by <relheader> elements
  • Cells contained in <relcell> elements
The <relcell> elements can contain <topicref> elements. <topicref> elements are then related to other <topicref> elements in the same row. <topicref> elements do not have to be in the same cell.
By default, the contents of a <reltable> element are not output for navigation purposes or in the table of contents. The contents of the <reltable> element define relationships that are output as related topic links.
See Relationship tables overview for a more detailed description of relationship tables.

remedy

Use the <remedy> element within a resolution topic to provide steps to solve the issue. You can include more than one remedy in a resolution topic if there’s more than one possible solution. The elements used are the same as for steps in task topics.

resolution

Use the resolution topic type to provide information about detecting and resolving product issues, events, alarms, and errors. The resolution type can include an identifying name or number, a description, and one or more recommended resolutions.
When creating a new resolution topic, use the Resolution tag template.

resolutionbody

The <resolutionbody> element is the main body-level element of a resolution topic. The <resolutionbody> element allows the <condition>, <corrective-action>, <example>, <postreq>, and <result> elements.

required-cleanup

Provides a placeholder for cleanup that needs to be take place after a conversion.
Clean up the text or other content contained in this element and delete the element from the topic.

result

Describes the expected outcome of the current task.
Do not use the <result> element to describe the outcome of a step in the task. Do not include concept or reference information in a <result> element.
The <result> element is optional.