Tables in documentation need introductions and formatting fixes
---------------------------------------------------------------
Key: DERBY-5184
URL: https://issues.apache.org/jira/browse/DERBY-5184
Project: Derby
Issue Type: Sub-task
Components: Documentation
Affects Versions: 10.7.1.1
Reporter: Kim Haase
Assignee: Kim Haase
Priority: Minor
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.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira
|