From: Gunnar Andersson <dff180@...>
Date: 2002-02-01T05:31:33+09:00
Subject: Re: MOre RDoc HTML needed

Just want to say: Awesome work on RDoc!
Thanks Dave (and the others helping out)!

I did some validation checks to to help.

Netscape 4.78 on Solaris shows a bug when using 
the Kilmer template.
The src links end up on top of the method text.
Workaround:  Remove the "padding" line
from the .srclink style in the CSS.
** Note I have not tested if/how this affects 
   appearance in other browsers but I don't
removing it will cause trouble.


The rest here  is mostly nitpicking from HTML 4.01 
validation and might not help much for browser 
support but it's cool to be 100% valid but
maybe not the highest priority.  
Attend to this stuff when you wish.

For HTML 4.01 (transitional) validity is needed:

1. doctype and encoding:
 
 example for the frameset:

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> 
 ...
 </head>
 ...

The inner non-frame files can use transitional (could be made strict 
instead of transitional if some things are changed according to 
below...)

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> 
...
</head>
...

---

2. Diagram.rb:  Alt tags are required 

Suggestion:  put in  alt="class <name>"
example:
  <area shape="RECT" coords="51,155,123,203" 
    href="../../../classes/SM/Rule.html" alt="class Rule">

---

3. The image itself should have an alt tag too
   (I think this was in before as "Package Diagram" wasn't it?

Suggestion: put in alt="<name> module diagram" 

example:
<img src="../../../dot/f_3.png" usemap="#map" alt="SM module diagram">

---

4. standard.rb, kilmer.rb:

   <script language="JavaScript">

"language" is deprecated and should be replaced by "type" and
a MIME type.  But I'm unsure if this should be changed -- better 
validate that all browsers execute the script OK before committing.  
However type is "required" for compliance.   Using transitional, the
deprecated tag can remain, using strict it cannot.

example (if transitional, this seems like it should work):
   <script language="JavaScript" type="text/javascript">
or if strict (check the browsers...)
   <script type="text/javascript">

---

5.  standard.rb kilmer.rb, the CSS:

  --->  text_decoration: none;

  should be "text-decoration" (hyphen, not underscore)
  (2 places)

   You might choose to put a "background-color" everywhere
   that you have "color" in the CSS - it is now in some
   places and not in others. 

For strict 4.01 validity the doctype is:
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">

and this puts some more restrictions:

 <body bgcolor="white">
 bgcolor must be removed, and (I suppose) exist in the CSS
 only.

 (Framesets still can't use strict - they must be "FrameSet")


Good luck

/Gunnar


__________________________________________________
Do You Yahoo!?
Great stuff seeking new owners in Yahoo! Auctions! 
http://auctions.yahoo.com