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:34: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-gs.zip
                DERBY-5184-gs.stat
                DERBY-5184-gs.diff

Attaching DERBY-5184-gs.diff. DERBY-5184-gs.stat, and DERBY-5184-gs.zip, with changes to the
following Getting Started topics. Each previous version had 1 simpletable unless otherwise
stated; there are 28 total tables.Topics are listed in the order in which they appear in the
manual.

tgsruntoolsutils.dita Choosing a method to run the Derby tools and startup utilities (also
fixed instruction on setting PATH variable and conrefs phrase)
tgssetupjavaenvir.dita Setting the environment variables (2 choicetables)
rgsderbyrunjarsyntax.dita Syntax for the derbyrun.jar file 
tgsrunningsysinfo.dita Running sysinfo (made consistent with other 2)
tgsrunningij.dita Running ij (made consistent with other 2)
tgsrunningdblook.dita Running dblook (made consistent with other 2)
tgssetupverify.dita  Verifying the Derby system configuration (1 formal but with no title)
twwdactivity1_Setup.dita Creating a directory and copying scripts into the directory (4 simpletables)
twwdactivity1.dita Creating a Derby database and running SQL statements
twwdactivity2.dita Activity 2: Run SQL using the client driver (3 simpletables)
twwdactivity3_Setup.dita Activity 3: Run a JDBC program using the embedded driver 
twwdactivity4.dita Activity 4: Create and run a JDBC program using the client driver and Network
Server (4 simpletables)
rgsdocs10012.dita SQL syntax (1 formal but with no title)
rgsdocs18277.dita Typographical conventions (1 formal, with title)
rgslib46043.dita Libraries provided by Derby (5 simpletables)

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