Uploaded image for project: 'Technical Advisory Board'
  1. Technical Advisory Board
  2. TAB-1272

Inconsistent sub-section numbering

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: New
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: Darwin Information Typing Architecture (DITA) Version 1.3 CSPRD01
    • Fix Version/s: None
    • Component/s: Public reviews
    • Labels:
      None
    • Environment:

      Style

    • Proposal:
      Hide

      Numbering of heading should be consistent across the document. It sets the expectation of the reader and allows ease of reference to particular parts. Consider going to fifth level heading numberings.

      Show
      Numbering of heading should be consistent across the document. It sets the expectation of the reader and allows ease of reference to particular parts. Consider going to fifth level heading numberings.

      Description

      The use of sub-section numbering appears to be inconsistent.

      For example, 1.5 Formating conventions in the XHTML version of the specification is followed by what appear to be unnumbered subsections, Link previews and navigation links.

      Compare that to 2.1 Introduction to DITA, which is followed by 2.1.1 DITA terminology and notation

      Further compare 2.1.1 DITA terminology and notation which is followed by an unnumbered Notation and Basic DITA terminology, Specialized terminology, DITA modules, Linking and addressing terms, Terminology related to keys, and map terms,

      with:

      2.2.1 DITA topics, which is followed by 2.2.1.1 The topic is the basic unit of information

      Why 2 levels, followed by three levels and then by four levels of numbered headings? Scanning the document I am aware that four levels seems to be as deep as you go, although you might want to consider five levels for ease of reference.

      Update: I stand corrected! You do have five levels of heading, sometimes, see: 2.3.4.10.7 Example: References to scoped keys. So, why is the fifth level of headings erratic?

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              patrick Patrick Durusau
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: