Download Firefox: WindowsMac OS X
logo       
Google Custom Search
    AddThis Social Bookmark Button

Re: Could Ruby-doc be better? -- Proposal for a better system.: msg#00014

Subject: Re: Could Ruby-doc be better? -- Proposal for a better system.
Douglas Livingstone wrote:
...


I like the sound of this. A local webrick server with access to a
dynamic index of the source files, nice.

In the RDoc documentation, it says "Files are parsed, and the
information they contain collected, before any output is produced.
This allows cross references between all files to be resolved."

Is there a quick way to scan for updated / added / removed files using
this index?

I do not think there is any permanent index.


On the HTML side, what is the file list in the top left frame used
for? There seems only to be path to the file on that page, at least on
http://www.ruby-doc.org/core/. On the doc pages themselves, there is
already a path for each class. Can this frame be removed?
That frame tells you what files were index fr this set of doc files. It may not be so useful.

Take a look at the files in the rdoc templates directory. The file html.rb is largely responsible for this layout.

A semi-frequent topic here and on ruby-talk is "Can we get a better page format", but so far no one (as far as I know) has offered up an actual template to improve things.

James




<Prev in Thread] Current Thread [Next in Thread>