Latex class documentation (was: RE: [ROOT] Table output)

From: Axel Naumann (a.naumann@worldnet.att.net)
Date: Tue Oct 23 2001 - 19:58:55 MEST


Hi,

> -----Original Message-----
> From: owner-roottalk@pcroot.cern.ch
> [mailto:owner-roottalk@pcroot.cern.ch]On Behalf Of Christian Holm
> Christensen
> Subject: Re: [ROOT] Table output
[...]
> This sort of brings up another thing:  It'd be nice if ROOT had
> something parallel to THtml that could write
> LaTeX/SGML/DocBook/etc. formatted files

I agree. The only problem is that THtml is... well... not really forseen to
be output format independent. Content and output format are not decoupled.

Obviously this approach is not really nice. Not only does it make context
dependent HTML formatting difficult (e.g. if one want to specify how the
documentation output of inline functions should look like), but it also
blocks the implementation of other output formats.

The most natural thing to do is to more or less completely re-write THtml,
split it up into a parser which stores the documentation content-wise (say,
TClassDoc) and output classes (say TClassDocLaTeX, TClassDocHtml, ...).
(Sometimes methods of the output classes need to be called, e.g. to put a
link around some text, but all that could be implemented completely format
independent). This would also allow the HTML code generated by the
documentation to be fully configurable, one could specify the layout for
each part of the documentation separately.

Suppose I'd volunteer to rewrite THtml - would someone volunteer to
implement "TClassDocLaTeX"? I won't be able to finish re-writing THtml
before mid next year; if someone else could do this job earlier I'm happy to
get rid of it :-)

Cheers, Axel.

> [Ok, I'm throwing out a lot of suggestions today which I
> unfortunately do not have the time to do something about myself -
> sorry about that - anyway, it's suggestions to put (far down) on the
> TODO list if you feel like it.]
>
> Yours,
>
> Christian Holm Christensen -------------------------------------------
> Address: Sankt Hansgade 23, 1. th.           Phone:  (+45) 35 35 96 91
>          DK-2200 Copenhagen N                Cell:   (+45) 28 82 16 23
>          Denmark                             Office: (+45) 353  25 305
> Email:   cholm@nbi.dk                        Web:    www.nbi.dk/~cholm
>



This archive was generated by hypermail 2b29 : Tue Jan 01 2002 - 17:51:04 MET