Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Won't Fix
    • Component/s: EDXL-TEP
    • Labels:
      None
    • Environment:

      Style

    • Proposal:
      Hide

      Insert sections with element name headers in 4.2 through 4.12 (inclusive) as indicated.

      Show
      Insert sections with element name headers in 4.2 through 4.12 (inclusive) as indicated.
    • Resolution:
      Hide

      Leave sectioning as is, but fix document hyperlinks for the facilitation of document navigation. This structure of the data dictionary is consistent across the suite of EDXL standards. The sectioning matches the elements in the data model. Each section begins with a table the defines the overall structure (i.e., subelements) for the section along with hyperlinks for fast and easy navigation.

      Show
      Leave sectioning as is, but fix document hyperlinks for the facilitation of document navigation. This structure of the data dictionary is consistent across the suite of EDXL standards. The sectioning matches the elements in the data model. Each section begins with a table the defines the overall structure (i.e., subelements) for the section along with hyperlinks for fast and easy navigation.

      Description

      Sections 4.2 (4 possible sections), 4.3 (27 possible sections), 4.4 (10 possible sections), 4.5 (11 possible sections), 4.6 (5 possible sections), 4.7 (7 possible sections), 4.8 (30 possible sections), 4.9 (5 possible sections), 4.10 (3 possible sections), 4.11 (5 possible sections), 4.12 (5 possible sections).

      By my count, the number of potential sections in the listed parts of section 4 range from 4 to 30.

      You are well familiar with the text and have no difficulty in finding the material you need. However, consider someone writing an implementation guide who wants to point to a particular element in 4.8. Do they simply point at 4.8 and let the reader wander along until they encounter the element in question?

      The better course would be to create sections, with headers (may I suggest the element name?) for each of the potential sections.

      That will enable implementers and people writing guidance for implementers to point directly to elements of concern for their implementations and to use as documentation.

      More effort on your part but think how that will be multiplied by all the implementers and others whose time you will save by making more precise references available.

        Attachments

          Activity

            People

            • Assignee:
              pattiaymond Dr. Patti Aymond (Inactive)
              Reporter:
              pattiaymond Dr. Patti Aymond (Inactive)
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: