Re: [eigen] Re-structuring the documentation

[ Thread Index | Date Index | More Archives ]

On Fri, Jan 4, 2013 at 11: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:

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. 

+1 for having the first level under Chapters expanded by default. I don't have a strong opinion on this proposal (let's call it 5) vs. 4, but given to choose, I'd go for 5. If we expand by default the first level inside Chapters (or reference and manuals in 4), then 5 looks cleaner.

Also, how about reordering the tree as:

(Remove top-level Eigen)
- Getting started
- Chapters
- General topics (rename?)
  - Porting from Eigen2 to Eigen3 (nest inside general topics?)
- Class list



Adolfo Rodríguez Tsouroukdissian
Senior robotics engineer

c/ Pujades 77-79, 4º4ª
08005 Barcelona, Spain.
Tel. +34.93.414.53.47
Skype: adolfo.pal-robotics
Facebook - Twitter - PAL Robotics YouTube Channel

AVISO DE CONFIDENCIALIDAD: Este mensaje y sus documentos adjuntos, pueden contener información privilegiada y/o confidencial que está dirigida exclusivamente a su destinatario. Si usted recibe este mensaje y no es el destinatario indicado, o el empleado encargado de su entrega a dicha persona, por favor, notifíquelo inmediatamente y remita el mensaje original a la dirección de correo electrónico indicada. Cualquier copia, uso o distribución no autorizados de esta comunicación queda estrictamente prohibida.

CONFIDENTIALITY NOTICE: This e-mail and the accompanying document(s) may contain confidential information which is privileged and intended only for the individual or entity to whom they are addressed.  If you are not the intended recipient, you are hereby notified that any disclosure, copying, distribution or use of this e-mail and/or accompanying document(s) is strictly prohibited.  If you have received this e-mail in error, please immediately notify the sender at the above e-mail address.

Mail converted by MHonArc 2.6.19+