Details

    • Type: Sub-task
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 10.7.1.1
    • Fix Version/s: 10.8.2.2, 10.9.1.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      Many tables in the Derby documentation appear abruptly, with conceptual prose followed immediately by a table (with or without a title). Here are some examples:

      http://db.apache.org/derby/docs/dev/devguide/devguide-single.html#tdevupgradedb
      http://db.apache.org/derby/docs/dev/adminguide/adminguide-single.html#cadminappsclient
      http://db.apache.org/derby/docs/dev/ref/ref-single.html#rrefjdbc27734

      There is no specific accessibility requirement that tables be properly introduced, but many companies' technical writing style guides require or strongly recommend it. Moreover, the WCAG guidelines have the following statements (http://www.w3.org/TR/WCAG10/#context-and-orientation):

      "Content developers should make content understandable and navigable. This includes not only making the language clear and simple, but also providing understandable mechanisms for navigating within and between pages. Providing navigation tools and orientation information in pages will maximize accessibility and usability. ... The theme of making content understandable and navigable is addressed primarily in guidelines 12 to 14."

      Therefore, in the interest of accessibility, each table should be introduced with some indication that a table is coming.

      Further details will be provided in comments.

        Attachments

        1. DERBY-5184-admin.diff
          21 kB
          Kim Haase
        2. DERBY-5184-admin.stat
          0.3 kB
          Kim Haase
        3. DERBY-5184-admin.zip
          21 kB
          Kim Haase
        4. DERBY-5184-dev.diff
          28 kB
          Kim Haase
        5. DERBY-5184-dev.stat
          0.5 kB
          Kim Haase
        6. DERBY-5184-dev.zip
          34 kB
          Kim Haase
        7. DERBY-5184-gs.diff
          77 kB
          Kim Haase
        8. DERBY-5184-gs.stat
          0.6 kB
          Kim Haase
        9. DERBY-5184-gs.zip
          42 kB
          Kim Haase
        10. DERBY-5184-ref.diff
          217 kB
          Kim Haase
        11. DERBY-5184-ref.stat
          2 kB
          Kim Haase
        12. DERBY-5184-ref.zip
          145 kB
          Kim Haase
        13. DERBY-5184-tools.diff
          31 kB
          Kim Haase
        14. DERBY-5184-tools.stat
          0.3 kB
          Kim Haase
        15. DERBY-5184-tools.zip
          18 kB
          Kim Haase
        16. DERBY-5184-tun.diff
          13 kB
          Kim Haase
        17. DERBY-5184-tun.stat
          0.2 kB
          Kim Haase
        18. DERBY-5184-tun.zip
          15 kB
          Kim Haase
        19. JDBCTypePrinter.java
          3 kB
          Rick Hillegas

          Issue Links

            Activity

              People

              • Assignee:
                chaase3 Kim Haase
                Reporter:
                chaase3 Kim Haase
              • Votes:
                0 Vote for this issue
                Watchers:
                0 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: