db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (DERBY-5184) Tables in documentation need introductions and formatting fixes
Date Fri, 22 Apr 2011 20:42:05 GMT

     [ 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-admin.zip
                DERBY-5184-admin.stat
                DERBY-5184-admin.diff

Attaching DERBY-5184-admin.diff, DERBY-5184-admin.stat, and DERBY-5184-admin.zip, with changes
to the following Admin Guide topics. The previous version had 8 formal and 3 simple tables.
Topics are listed in the order in which they appear in the manual.

tadmincbdjhhfd.dita Starting the Network Server (3 simple)
cadminappsclient.dita Accessing the Network Server by using the network client driver (3 formal)
cadminappsclientsecurity.dita Network client security (1 formal, introduced by xref)
cadminappsclienttracing.dita Network client tracing (1 formal)
radminappsresultsetdiffs.dita Updatable Result Sets (1 formal, properly introduced) (cleaned
up the first sentence, redid table)
cadminreplicsecurity.dita Replication and security (1 formal, properly introduced)
cadminreplicfailures.dita Replication failure handling (1 formal, properly introduced)

> 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, 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

Mime
View raw message