| Re: [eigen] Re-structuring the documentation |
[ Thread Index |
Date Index
| More lists.tuxfamily.org/eigen Archives
]
- To: eigen@xxxxxxxxxxxxxxxxxxx
- Subject: Re: [eigen] Re-structuring the documentation
- From: Billy Araujo <billyaraujo@xxxxxxxxx>
- Date: Fri, 4 Jan 2013 11:01:50 +0000
- Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type; bh=YdPCDOxz4JZsXsiN0zdk0rD2SF+x8sCAHkOpYrUwXRs=; b=AEm7L4T9IrwK26y4BP0M41T2L+HVTAhxdn5X6LIoFjQStp3dkRjXPqfo37sidXTNa5 pnSnnAOKjc1ES+4I7hgLpyX86HxotFdUILkSW4/dwYi1LasPTG2Hm0pi6vX882IwroI7 q2vovrVvroStPG9/Nx43Hj/pJEQKxndyw63kEUXcn/WoKsg6h0If2RXCU6F1Qf3zYtkX kPoES70FAhWI1Xv0rVzHBiG+ENACFs3F5+4l21H6vc/GPlyBHgmJxbuYw6Qb6Ij7T6y0 mIZWY7qocXJpdDJUCpD1PToGGm7hOFlNm7LWGKZSTxcqqNKYWc+itWVOoNe9wB3jucYu gngw==
I like proposal 5. Search feature is nice.
I am using chrome. When I click on:
http://eigen.tuxfamily.org/doc_test/5/Eigen2ToEigen3.html
2 table of contents appear. One on the right as well as the fixed
docked on the left. Getting started also. On other pages this doesn't
seem to happen.
Billy.
On Fri, Jan 4, 2013 at 10:21 AM, Gael Guennebaud
<gael.guennebaud@xxxxxxxxx> wrote:
>
> 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
>>
>>
>