Re: [jazzplusplus-devel] Doccumentation -- a scratchpad of thoughts

[D.B. M. <db...@ho...>]

Greets,

----------------------------------------
> Date: Sat, 17 May 2008 21:59:18 -0700
> Subject: Re: [jazzplusplus-devel] Doccumentation -- a scratchpad of thoughts
> 
> PS = Pete Stieber
> PS>> I'll try to generate an example soon.
> PS>> I'll post when I'm done.
> 
> DM = Donald B. Moore.
> DM> Good stuff, I'll check it out as soon as it's up...
> 
> Refresh the documentation page in your web browser...
> 
> http://jazzplusplus.sourceforge.net/documentation/
> 
> Scroll to the very bottom and click con the link in the line...
> 
> Check out an ancient version of the Jazz++ online docs by visiting the 
> manual page.
> 
> That's the same content as you would see using the online help...
> 
> Make sense?
> 

......yes actually....it does...however, just to be sure, here's
how I understand it right now...

quintessentially. jazz.tex contains -all- the documentation

users can access these docs via a>jazz builtin help context
or b> anything else they wish to view the docs generated in
the jazz++ build process, whatever format that might be...
(and we supply the various doc formats in the binary packages)
(which end up in /usr/share/doc/jazz++ or similar)

folks building from release tarballs get all the various doc
formats built/converted at compile time. (if they don't want, 
say, the pdf generation, we could have configure switches like
--disable-pdf etc....but my thinking is why bother? the doc
generation takes next to no build time, we're not talking about
saving oodles of drivespace to justify doc generation exclusions,
so it builds the lot and users should be glad and that's that ;-)

the HTML docs generated from jazz.tex form the online (web)
documentation as well...

the document currently at /web/htdocs/documentation/index.php
gets revamped, and actually acts as a contents/navigation page
which refers back to (link to) various sections of the HTML docs
generated from jazz.tex....

..and in this way, content of website documentation is (hopefully)
always in-sync with the current *release* versions of Jazz++ as
they become available....



Did I get it right?  (^B 



Regards,


Donald B



_________________________________________________________________
Be part of history. Take part in Australia's first e-mail archive with Email Australia.
http://emailaustralia.ninemsn.com.au