Site Navigation:
 
 
3.2. ID Naming Conventions
Prev  Chapter 3. Fedora Documentation Guidelines  Next

3.2. ID Naming Conventions

This section explains the ID naming convention. IDs are unique identifiers that allow DocBook XML to cross-reference a section, chapter, or other element.

The following general rules apply to IDs:

  • Keep an ID as short and simple as possible.

  • Start the ID with the special short two-character label. This makes URLs and other references to this ID human readable, by self-identifying the XML container type.

Example 3.1, “Proper ID Usage” demonstrates some example ID attributes used properly. 

<chapter id="ch-unique-name-of-chapter">

<section id="sn-install-make-disks">

<figure id="fig-redhat-config-kickstart-basic">

Example 3.1. Proper ID Usage


Two-Character Naming Conventions
Tag Prefix
preface pr-
chapter ch-
section sn-
figure fig-
table tb-
appendix ap-
part pt-
example ex-

Use the title of the item as the ID. Make your titles unique within a document to prevent conflicts. For example:

<chapter id="ch-how-to-fold-laundry">
  <title>How To Fold Laundry</title>
  <section id="sn-folding-shirts">
    <title>Folding Shirts</title>
Prev  Up  Next
Chapter 3. Fedora Documentation Guidelines  Home  3.3. XML Tags