RDoc questions and nits

The following set of notes is far too random to submit as
a bug report.  I will be happy to submit specific bug
reports to specified sites, however, upon request.


First, some questions.

  *  Is there a tutorial page on using RDoc's HTML pages?

  *  Is there any documentation on RDoc's "ri" output?

  *  Is there a way to cause RDoc's HTML to display a full,
     marked-up source code file?

  *  The page .../doc/app/classes/ApplicationController.html
     links to .../doc/app/classes/ActionController/Base.html,
     which does not exist on my machine.  I suspect that RDoc
     is assuming that all referenced superclasses will have
     pages, but this is not a valid assumption.  Wazzup?

  *  Why does the option "--fmt xml" generate the nastygram:

       Generating XML...
       Could not find HTML template
         'rdoc/generators/template/xml/html'


Next, a few nits...


This RDoc summary page (mentioned on the Wikipedia page):

  RDoc summary page on ruby-doc.org
  http://www.ruby-doc.org/core/files/lib/rdoc/usage_rb.htm/

gets an error:

  There seems to have been an error with your request
                                                     ^
Aside from the missing period at the end of the message,
there is the question of why the error is occurring.


The page http://www.ruby-doc.org/core/classes/RDoc.html
is formatted a bit oddly:

  *  The description for DOT_DOC_FILENAME occupies 7 or 8
     lines (depending on the window width) at the right-
     hand edge of the window.

  *  The options in the "Usage" section are printed in a
     way that makes the leading '--' look like an endash.

-r
-- 
http://www.cfcl.com/rdm            Rich Morin
http://www.cfcl.com/rdm/resume     [email protected]
http://www.cfcl.com/rdm/weblog     +1 650-873-7841

Technical editing and writing, programming, and web development