Re: [eigen] Re-structuring the documentation

[Gael Guennebaud <gael.guennebaud@xxxxxxxxx>]

Thanks for taking the time to look at the proposals. It seems the opinions are converging. Good!

Nevertheless, I made a last attempt that is in-between 3 and 4: it use the grouping mechanism of 3, but a structure more like 4 where the "-> Reference" link has been replaced by the true reference block with Modules and Classes:

http://eigen.tuxfamily.org/doc_test/5/GettingStarted.html

I also tweaked the _javascript_ to enforce the "Chapters" section to be expanded whatsoever. This is probably the most interesting thing about this variant, and the same trick can be applied the #4 one to keep the first level of the User Manual always visible.

If you are only interested by the reference pages, then 4 remains better. 

cheers,

gael

On Thu, Jan 3, 2013 at 5:39 PM, Jitse Niesen <jitse@xxxxxxxxxxxxxxxxx> wrote:

Hello,

My dilema, is whether to split each chapter into a user and reference manuals (CoM for Chapters of Manuals), or rather have a big user and a big reference manuals that are themselves organized into chapters (MoC for Manuals of Chapters).

For me personally, the MoC approach seems more in line with what I would expect. Since that seems also to cause less problems that would have my vote.

In fact, for the reference manual it's probably not as important to split it in chapters, as people are less likely to browse through it. They'll probably use the search function or the class or function index to access the reference manual.

I just had a look at the matlab help and they use Manual of Chapters.


Jitse