You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Kim Haase (JIRA)" <ji...@apache.org> on 2011/04/29 20:01:03 UTC
[jira] [Resolved] (DERBY-5184) Tables in documentation need
introductions and formatting fixes
[ https://issues.apache.org/jira/browse/DERBY-5184?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase resolved DERBY-5184.
------------------------------
Resolution: Fixed
Fix Version/s: 10.9.0.0
10.8.1.3
Issue & fix info: (was: [Patch Available])
Committed patch DERBY-5184-ref.diff to documentation trunk at revision 1097897.
Merged to 10.8 doc branch at revision 1097901.
Previously committed patches to Admin Guide, Developer's Guide, Getting Started, Tools Guide, and Tuning Guide.
> 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
> Fix For: 10.8.1.3, 10.9.0.0
>
> Attachments: DERBY-5184-admin.diff, DERBY-5184-admin.stat, DERBY-5184-admin.zip, DERBY-5184-dev.diff, DERBY-5184-dev.stat, DERBY-5184-dev.zip, DERBY-5184-gs.diff, DERBY-5184-gs.stat, DERBY-5184-gs.zip, DERBY-5184-ref.diff, DERBY-5184-ref.stat, DERBY-5184-ref.zip, DERBY-5184-tools.diff, DERBY-5184-tools.stat, DERBY-5184-tools.zip, DERBY-5184-tun.diff, DERBY-5184-tun.stat, DERBY-5184-tun.zip, JDBCTypePrinter.java
>
>
> 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