TEMPLATE_REFERENCE_reference-material.adoc

Reference material

Write a short introductory paragraph that provides an overview of the module.

A reference module provides data that users might want to look up, but do not need to remember. It has a very strict structure, often in the form of a list or a table. A well-organized reference module enables users to scan it quickly to find the details they want. AsciiDoc markup to consider for reference data:

Unordered list

• For more details on writing reference modules, see the Modular Documentation Reference Guide.

• Use a consistent system for file names, IDs, and titles. For tips, see Anchor Names and File Names in Modular Documentation Reference Guide.

Labeled list

Term 1

Definition

Term 2

Definition

Table 1. Table

Column 1	Column 2	Column 3
Row 1, column 1	Row 1, column 2	Row 1, column 3
Row 2, column 1	Row 2, column 2	Row 2, column 3

Additional resources

• A bulleted list of links to other closely-related material. These links can include link: and xref: macros.

• For more details on writing reference modules, see the Modular Documentation Reference Guide.

• Use a consistent system for file names, IDs, and titles. For tips, see Anchor Names and File Names in Modular Documentation Reference Guide.