[DERBY-5184] Tables in documentation need introductions and formatting fixes

• 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
• Assignee: Camilla Haase
• Reporter: Camilla Haase
• Created: 08/Apr/11 17:26
• Updated: 25/Oct/11 17:09
• Resolved: 29/Apr/11 17:59

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.

Issue Links

• relates to: DERBY-2623 SEVERE error involving column-number property
• relates to: DERBY-2625 SEVERE error involving column-width property