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] Commented: (DERBY-5135) Derby documentation needs accessibility improvements
Date Tue, 15 Mar 2011 21:10:29 GMT

    [ https://issues.apache.org/jira/browse/DERBY-5135?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13007191#comment-13007191

Kim Haase commented on DERBY-5135:

Tables in the Derby documentation have some accessibility problems that don't seem easy to

Accessible tables require a summary attribute. Currently the tables in the frames HTML docs
have empty summary attributes:


DITA, even in its more recent versions, does not have an attribute to specify a table summary.
Providing a meaningful summary for each table would require some complicated processing, maybe
of a comment in the topic source. 

Also, accessibility requires that table headers and table cells be linked by an id value.
Table headers specify an id for each column:

<th valign="top" width="50%" id="N100A8">Before Transformation</th>
<th valign="top" width="50%" id="N100AF">After Transformation</th>

Table cells then reference this id in their headers attribute -- except that in formal tables,
our DITA toolkit puts an extra space in the id that makes it invalid:

<td valign="top" width="50%" headers="N100A8 "><strong><samp class="codeph">c1
&lt; ANY (SELECT ...)</samp></strong></td>
<td valign="top" width="50%" headers="N100AF "><strong><samp class="codeph">c1
&lt; (SELECT ...)</samp></strong></td>

The simpletable and choicetable elements are generated correctly, but formal tables aren't.
I have not been able to figure out what's wrong with the formal table generation.

> Derby documentation needs accessibility improvements
> ----------------------------------------------------
>                 Key: DERBY-5135
>                 URL: https://issues.apache.org/jira/browse/DERBY-5135
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions:
>            Reporter: Kim Haase
>            Assignee: Kim Haase
> Accessibility is increasingly important for documentation. The Derby HTML documentation
currently fails accessibility requirements, although the frames versions of the manuals seem
closer to accessibility than the single-file HTML versions.
> I will file a sub-task for some fairly easy fixes to the documentation and will describe
some of the harder problems in a comment later.

This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

View raw message