The Persistence of Vision Raytracer (POV-Ray).
This is the legacy Bug Tracking System for the POV-Ray project. Bugs listed here are being migrated to our github issue tracker. Please refer to that for new reports or updates to existing ones on this system.
Attached to Project: POV-Ray
Opened by Mike H - 2010-06-06
Last edited by Jim Holsenback - 2010-12-20
Opened by Mike H - 2010-06-06
Last edited by Jim Holsenback - 2010-12-20
FS#119 - Table of Contents in each page of the docs
There should be a table of contents on each page of the documentation, or at least on the very long pages. Scrolling through the entire page to figure out what topics are covered sucks.
Example(s) please ... if this in distribution documentation a section/page number, there may be a missing tag someplace ... that will give me a place to start looking.
What format are you using to view the documentation? If you want a book-style layout, consider using the PDF version of the documentation. At least the Windows and Mac "help" HTML versions already offer a permanent table of contents supplied by the operating system.
For instance in the HTML docs for v3.6.2, topic 3.5.11 "Patterns" has over 8000 words and 37 sub-topics. A mini-TOC on that individual page would save the aggravation of having to scroll 10 pages if you're scanning between headings.
One example is mediawiki, which automatically adds a TOC to each topic (though in their case the page needs to meet a minimum length or heading depth).
Which HTML docs, the one on the web page or the one included with any of the distributions? They are different to meet different needs. That is, some doc versions have such TOCs, others don't. Some are split on section level 3, others on level 4. I assume that if you counted words you used some other version than the one on the website? Which one?
I am referring to the compiled HTML help file included with the Windows distribution.
I'm OK with how the topics are split into individual pages. It's just that some of them are very long, for instance "Patterns".
I'm aware of (and comfortable with) the parameters outlined in Thorstens earlier post. In the case of the 'Patterns' section cited as an example ... I'll go ahead and add to my 'attention' list when scripting, and hopefully catch these anomalies.