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

Knut Anders Hatlen commented on DERBY-4408:
-------------------------------------------

I took a look at the patch, and noticed some small issues with the generated 
HTML files. I'm not sure if fixing all of these is within the scope of this bug 
report, but here goes.

- I think the <?xml ...?> line needs to be the first line in the file (both 
index.html and toc.html) in order to be well-formed XML.

- The doctype for index.html should be XHTML 1.0 Frameset, not XHTML 1.0 
Transitional, since the <frameset> element isn't defined in the transitional 
DTD.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd";>

- The patch makes the doctype of toc.html XHTML 1.0 Transitional. However, the 
XHTML DTDs require the tags to be in lower case, whereas the document uses 
upper case <UL>..</UL> and <LI>..</LI>. We should either use a doctype that 
allows upper case tags (for example HTML 4.01 Transitional), or change the case 
of those tags to match the doctype. I think I prefer the latter.

- The html element needs the attribute xmlns="http://www.w3.org/1999/xhtml"; in 
order to pass as valid XHTML on http://validator.w3.org/ (assuming the above 
issues are fixed first).

> missing DOCTYPE and META tags in toc.html and index.html pages
> --------------------------------------------------------------
>
>                 Key: DERBY-4408
>                 URL: https://issues.apache.org/jira/browse/DERBY-4408
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.3.3.0
>            Reporter: Myrna van Lunteren
>            Assignee: Kim Haase
>         Attachments: DERBY-4408.diff, DERBY-4408.diff, index.html, toc.html
>
>
> I found a tool that analyzes the documentation for possible accessibility 
> issues, and it found that the index.html and toc.html files from all 6 books 
> have issues:
>   INDEX.HTML
>      977   Missing DOCTYPE tag.  Required to define version of XHTML being 
> used.           
>      833   Missing META tag.  Required CHARSET value must be defined in this 
> file.         
>  TOC.HTML                                        
>      831   Missing DOCTYPE tag.  Required to define version of HTML being 
> used.  Line: 1    

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

        

Reply via email to