[
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-tools.zip
DERBY-5184-tools.stat
DERBY-5184-tools.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 5 formal and 3 simple tables. Topics are listed in the
order in which they appear in the manual.
rtoolsdrvrnmeurl.dita The ij Driver name and connection URL (1 formal) (has
intro with xref)
rtoolsijpropref97949.dita derby.ui.codeset property (1 formal, properly
introduced and with xref above)
rtoolsijlocale.dita derby.ui.locale property (2 formal)
ttoolsimporting.dita Importing data using the built-in procedures (1 simple)
In the 3rd row, changed references to the insertColumns and columnIndex
parameters to INSERTCOLUMNS and COLUMNINDEXES.
ttoolsexporting.dita Exporting data using the built-in procedures (1 simple)
rtoolsimportcodeset.dita CODESET values for import and export procedures (1
formal, properly introduced; has desc element) (table is identical to the one
in rtoolsijpropref97949.dita -- has been removed and replaced by an xref to it)
rtoolsplanexpxmlformat.dita PlanExporter XML format (1 simple)
Another problem: This topic used preformatted text to render ASCII art (the
tree structure), which is frowned upon by the accessibility standards. In the
absence of an actual graphic I converted this to a bullet list.
> 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, 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
