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-5136) Simple accessibility fixes to frames HTML doc output
Date Wed, 16 Mar 2011 17:17:29 GMT

     [ https://issues.apache.org/jira/browse/DERBY-5136?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel

Kim Haase updated DERBY-5136:

    Attachment: rrefcopyright.html

Attaching DERBY-5135.diff, DERBY-5135.stat, and two files that show the changes: out/ref/index.html
and out/ref/rrefcopyright.html. 

The patch involves adding two modified files to the lib directory to be copied into the DITA-OT1.1.2.1

A changed index.html file is copied from lib into DITA-OT1.1.2.1/resource. This file differs
from the previous version as follows:

< <html>
> <html lang="en">
<   <frameset cols="40%,*">
<     <frame name="navwin" src="toc.html" />
<     <frame name="contentwin" src="about:blank" scrolling="auto" />
>   <frameset title="Web Sample" cols="40%,*">
>     <noframes>
>       <body>
>         <p><a href="SAMPLE-single.html">Go to a non-frames version of
>         this content.</a></p>
>       </body>
>     </noframes>
>     <frame title="Table of Contents" name="navwin" src="toc.html" />
>     <frame title="Pages" name="contentwin" src="about:blank" scrolling="auto" />

A changed dita2htmlImpl.xsl is copied from lib into DITA-OT1.1.2.1/xsl/xslhtml. This file
differs from the previous version as follows:

<         <h4 class="sectiontitle"><xsl:value-of select="@spectitle"/></h4>
>         <h2 class="sectiontitle"><xsl:value-of select="@spectitle"/></h2>
<       <h4 class="sectiontitle"><xsl:value-of select="$defaulttitle"/></h4>
>       <h2 class="sectiontitle"><xsl:value-of select="$defaulttitle"/></h2>
<     <h4 class="sectiontitle">
>     <h2 class="sectiontitle">
<     </h4>
>     </h2>

(Note: @spectitle is an attribute of the section element that is not used in documents but
can be used by "architects of specialized types.")

The patch also makes three small changes to build.xml: two to copy these files to the appropriate
locations, and one to edit index.html to provide the correct name for the one-page HTML book.

> Simple accessibility fixes to frames HTML doc output
> ----------------------------------------------------
>                 Key: DERBY-5136
>                 URL: https://issues.apache.org/jira/browse/DERBY-5136
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions:
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5135.diff, DERBY-5135.stat, index.html, rrefcopyright.html
> The frames versions of the HTML manuals have some accessibility errors that are quite
easy to fix, involving the index.html file and section heads.
> The index.html file for the frames version has several errors:
> 1) The <html> element lacks a lang attribute (lang="en" in this case).
> 2) The <frameset> element lacks a <noframes> element telling people with
browsers that don't support frames where to find an alternative version of the documentation.
We can point them to the single-file HTML manual.
> 3) The <frameset> and <frame> elements require title attributes.
> It is possible to fix these issues fairly easily by providing a modified version of the
DITA-OT1.1.2.1/resource/index.html file and then by making some additional edits to the init
and html.dita tasks in the build.xml file.
> The documentation also violates the rule that heads must appear in order. The topics
in the Derby documentation generate only two HTML head tags, <h1> for the topic title
and <h4> for sections. Sections cannot be nested in DITA. 
> It is possible to fix this problem by providing a modified version of the DITA-OT1.1.2.1/xsl/xslhtml/dita2htmlImpl.xsl
file that specifies the use of <h2> tags instead of <h4>. Section heads are always
generated with the "sectiontitle" class, which is specified in the .css files, so the output
seems to look the same with either head in a browser that supports stylesheets.
> I plan to file a patch for this task tomorrow.

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

View raw message