html5 manual,Art of Illusion / Discussion / Open Discussion: Manual update for 3.1 -- HTML5 propo...
diminishing returns
One of the points, that I was about to get to, but something else first:
The first and to me the most obvious problem is, that the original 3-level hierarchy is lost. The 1. and 1.1 levels both are translated to
and 1.1.1 becomes
I don't know if it has affected, that in the header numbering of level 1. ends with a dot and levels 1.1 and lower end with the number (wihout a dot)? That's the standard way though.
I'd make sure, that the basic structure is kept as it is, 1. -->
, 1.1 -->
, 1.1.1 -->
. The division to the (currently) seven larger sub-categories is actually very good and I find it a key factor, not just to navigating through the manual but to building understanding on how the software works.
The one on the website is dated Dec. 2013. Is that really the latest one?
I'm not aware of anything more recent. The one on the web site is the official holy book. And just this morning I (again) discovered some badly out dated text in there. (That lights have the view camera capability built is missing. Instead it introduces a way to combine a camera with a light.)
If you point out specific issues
Some findings that mostly seem to happen due to line changes in the source text.
layout.html: The first header "1. Art of Illusion Basics" is missed.
object_types.html: "2.1 Object Types" in missed
textures.html: 2nd and 3rd level headers are missed
textures2.html: "Bind Texture Coordinates to Surface is again available for mesh objects" is not a header. This text appears twice in the file. The latter one has turned into header.
rendering.html: 3rd level missed
Sometimes there is a piece of text forced into an image caption, when one does not appear in the original text:
Typical for example on textures2.html
Could the contens list be made a collapsible sidebar already from early steps?
That's controlled by the theme. I generated these files with Alabaster
I'll get back to the themes later, there ar quite a few of them to check.... BTW, the Alabaster looks different on the list than it appears opened.... But I'll try to find candidates with the technical properties that we might want to see. Fonts an colors can (hpefully) be adjusted afterwards (Though Sphinx seems to generate tons of .css:ses and other stuf.... I cant begin to imagine how all the details are enterd in there.)