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:40: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-dev.zip
                DERBY-5184-dev.stat
                DERBY-5184-dev.diff

Attaching DERBY-5184-dev.diff, DERBY-5184-dev.stat, and DERBY-5184-dev.zip, with changes to
the following Developer's Guide topics. The previous version had 13 formal and 1 choice table.
Topics are listed in the order in which they appear in the manual.

tdevupgradedb.dita Upgrading a database (1 choice)
cdevdvlp40724.dita The database directory (1 formal, properly introduced, with xref)
cdevsetprop24843.dita Setting properties in a client/server environment (1 formal)
cdevspecialtfgetxxx.dita Preferred getXXX() methods for Derby-style table functions (1 formal,
properly introduced)
cdevconcepts29416.dita Using auto-commit (1 formal)
cdevconcepts15366.dita Isolation levels and concurrency (3 formal, introduced by xrefs)
rdevconcepts2462.dita Lock compatibility (1 formal, properly introduced)
rdevconcepts8424.dita Scope of locks (1 formal)
rdevconcepts713.dita Deployment options and threading and connection modes (1 formal, introduced
by xref)
rdevcsecure557.dita List of user authentication properties (1 formal)
rdevcsecure190.dita Read-only and full access permissions (1 formal, properly introduced)
cdevcollation.dita Character-based collation in Derby (1 formal)


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