> Author: engelsman
> Date: 2008-10-08 09:53:41 -0700 (Wed, 08 Oct 2008)
> New Revision: 6397
> Log:
> started simplification of HTML in drawing.dox to allow LaTeX generation
>
> This is very much a work in progress, with some wierd formatting of H3,
> H4 and A tags until they are replaced by doxygen or reworked in html.
> The two big questions to come out of this simplification are:
> 1. if the function descriptions are moved to the source code and the
>    reference pages, how much does the tutorial page need to be reworked
>    and how much information should be duplicated;
> 2. how do we distinguish between the doxygen Fl_Widget::draw() links
>    to the reference page, and the in-page links in the tutorial
>    <A href="subclassing.html#draw"><tt>Fl_Widget::draw()</tt></A>
>    This second point is illustrated by the first two bullet points
>   which are identical text but the links point to different places.

OK, managed to get something together in less than 12 hours :-)

If you generate the doxygen/HTML and go to the 'Drawing Things in FLTK'
chapter, you can see that the Fl_Widget::draw() links in the first two
bullets look different, and they point to different places.

I propose that we start to add in \section, \subsection and \ref calls
instead of the H3 and H4 with named Anchors. I also suggest that we
reserve the Fl_Widget::draw() type links for doxygen, and put in \ref
calls to the \section and \subsection names. In other words, in-page
links will be words or phrases and not code entities.

I was also toying with the idea of using \par with a paragraph tag
matching the function signature and indented explanations, but I had
not got that far with my experimentation yet so I don't know what it
will look like or how much work it will be.

D.
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev

Reply via email to