[
https://issues.apache.org/jira/browse/DERBY-5184?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Kim Haase updated DERBY-5184:
-----------------------------
Attachment: DERBY-5184-tun.zip
DERBY-5184-tun.stat
DERBY-5184-tun.diff
Attaching DERBY-5184-tools.diff, DERBY-5184-tools.stat, and
DERBY-5184-tools.zip, with changes to the following Tools Guide topics. The
previous version had 9 formal tables, but 3 were layout tables, used for
appearance. Topics are listed in the order in which they appear in the manual.
ctunperf98197.dita Use the appropriate getXXX and setXXX methods for the type
(1 formal, properly introduced)
ctundepth14326.dita Shielding users from Derby class-loading events (2 layout
tables, removed)
ctunoptimz42065.dita Transaction-based lock escalation (3 formal, but with no
titles)
ctunstats52657.dita Selectivity from hard-wired assumptions (1 formal,
introduced by xref)
ctuntransform13966.dita Internal language transformations (1 layout table,
removed)
ctuntransform867201.dita IN/ANY subquery transformation (1 formal, introduced
by xref)
> 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
> 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
