You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Kim Haase (JIRA)" <ji...@apache.org> on 2011/03/15 21:54:30 UTC
[jira] Created: (DERBY-5135) Derby documentation needs
accessibility improvements
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: 10.7.1.1
Reporter: 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
[jira] Commented: (DERBY-5135) Derby documentation needs
accessibility improvements
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ 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 fix.
Accessible tables require a summary attribute. Currently the tables in the frames HTML docs have empty summary attributes:
summary=""
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 < ANY (SELECT ...)</samp></strong></td>
<td valign="top" width="50%" headers="N100AF "><strong><samp class="codeph">c1 < (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: 10.7.1.1
> 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
[jira] [Closed] (DERBY-5135) Derby documentation needs
accessibility improvements
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-5135?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase closed DERBY-5135.
----------------------------
Closing, since all sub-tasks have been closed and no more seem to be needed.
> 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: 10.7.1.1
> Reporter: Kim Haase
> Assignee: Kim Haase
> Fix For: 10.8.2.2, 10.9.1.0
>
>
> 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.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Issue Comment Edited] (DERBY-5135) Derby documentation
needs accessibility improvements
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-5135?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13017039#comment-13017039 ]
Kim Haase edited comment on DERBY-5135 at 4/7/11 5:45 PM:
----------------------------------------------------------
Accessibility standards can be found at the following locations:
W3C Web Content Accessibility Guidelines: http://www.w3.org/TR/WCAG10/
Section 508 standards (USA only): http://www.access-board.gov/sec508/guide/
was (Author: chaase3):
Accessibility standards can be found at the following locations:
W3C Web Content Accessibility Guidelines: http://www.w3.org/WAI/intro/wcag.php
Section 508 standards (USA only): http://www.access-board.gov/sec508/guide/
> 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: 10.7.1.1
> 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
[jira] Assigned: (DERBY-5135) Derby documentation needs
accessibility improvements
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-5135?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase reassigned DERBY-5135:
--------------------------------
Assignee: Kim Haase
> 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: 10.7.1.1
> 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
[jira] [Commented] (DERBY-5135) Derby documentation needs
accessibility improvements
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-5135?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13017039#comment-13017039 ]
Kim Haase commented on DERBY-5135:
----------------------------------
Accessibility standards can be found at the following locations:
W3C Web Content Accessibility Guidelines: http://www.w3.org/WAI/intro/wcag.php
Section 508 standards (USA only): http://www.access-board.gov/sec508/guide/
> 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: 10.7.1.1
> 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
[jira] [Closed] (DERBY-5135) Derby documentation needs
accessibility improvements
Posted by "Kim Haase (Closed) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-5135?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase closed DERBY-5135.
----------------------------
> 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: 10.7.1.1
> Reporter: Kim Haase
> Assignee: Kim Haase
> Fix For: 10.8.2.2
>
>
> 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.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Resolved] (DERBY-5135) Derby documentation needs
accessibility improvements
Posted by "Kim Haase (Resolved) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-5135?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase resolved DERBY-5135.
------------------------------
Resolution: Fixed
Fix Version/s: 10.8.2.2
I am resolving this task, since the frames version of the docs meets accessibility requirements sufficiently. A new task can be created if more work is needed.
> 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: 10.7.1.1
> Reporter: Kim Haase
> Assignee: Kim Haase
> Fix For: 10.8.2.2
>
>
> 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.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Reopened] (DERBY-5135) Derby documentation needs
accessibility improvements
Posted by "Kim Haase (Reopened) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-5135?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase reopened DERBY-5135:
------------------------------
Reopening to add new accessibility task.
> 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: 10.7.1.1
> Reporter: Kim Haase
> Assignee: Kim Haase
> Fix For: 10.8.2.2
>
>
> 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.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DERBY-5135) Derby documentation needs
accessibility improvements
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-5135?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13007546#comment-13007546 ]
Kim Haase commented on DERBY-5135:
----------------------------------
API documentation accessibility is another issue. Reportedly the JDK 7 version of the javadoc tool will generate accessible documentation; previous versions do not. I don't know whether, or when, the Derby build process could switch to the JDK 7 version of the javadoc tool for generating the shipped versions of the JDBC API docs.
> 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: 10.7.1.1
> 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
[jira] [Resolved] (DERBY-5135) Derby documentation needs
accessibility improvements
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-5135?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase resolved DERBY-5135.
------------------------------
Resolution: Fixed
Fix Version/s: 10.9.1.0
All tasks have now been completed.
> 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: 10.7.1.1
> Reporter: Kim Haase
> Assignee: Kim Haase
> Fix For: 10.9.1.0, 10.8.2.2
>
>
> 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.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira