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

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

----------------------------------------
> Date: Sat, 17 May 2008 20:05:31 -0700
> Subject: Re: [jazzplusplus-devel] Doccumentation -- a scratchpad of thoughts
> 
> DM = D.B. Moore
> DM> Call it sentimentality on my part if you like, but
> DM> I figure a copy of the original jazz.tex file should
> DM> always remain, in tact, for historical purposes...
> 
> It will because it us under version control.  On your Linux box, try the 
> following command in the jazzplusplus/trunk/jazz/src/HelpFiles directory...
> 
> $ svn log jazz.tex
> 
> This lists all of the log messages associates with jazz.tex.  Note the 
> revision numbers.  Let's say you wanted to retrieve the original version 
>   from Subversion.  That would be version...  56.  Just for fun, change 
> directory to your home directory and retrieve that version of jazz.tex 
> using...
> 
> $ cd
> $ mkdir Junk
> $ svn co -r 56 
> https://jazzplusplus.svn.sourceforge.net/svnroot/jazzplusplus/trunk/jazz/src/HelpFiles 
> Junk
> 
> That last line should all be on one line.  Know you have the original, 
> 486 and all, mentioned in tex2rtf.  I'm keeping a copy of the pdf 
> generated by Tex2RTF around for a reference.
>

Great, thanks for the brief svn tute Pete...(and for remembering
I'm new to svn....;-)

 
> DM> Anyhow, reworking jazz.tex is almost tantamount
> DM> to a rewrite. I've got no problem with that,
> DM> and for sure some passages of the old text
> DM>  may find their way into the new draft....but
> DM> ....are we happy with the formal and layout of
> DM> the old jazz.tex documentation?
> 
> Here's how I look at it.  You are doing a fabulous job with the docs. 
> Feel free to re-write as you see fit.  When it comes to Jazz++ 
> functionality, assume we are trying to recreate what the old version 
> did.  I'm sure this is documented in the old version.  I have changed a 
> few things (I want to use my new knob control instead of sliders... see 
> the Metronome dialog), but not much.
> 

okay, thanks for the pointers


> DM> A lot of the htdocs are near a point where they'll be
> DM> 'frozen' for a time - they probably won't change until
> DM> the code reaches a point closer to an  'official' release.
> 
> Exactly.
> 
> DM> The reason I concluded to just continue adding to the
> DM> web/htdocs/documentation path, was to merely make these
> DM> additions 'visible', rather than obscured in jazz.tex
> DM> right now, ....because we havn't discussed a plan here,
> DM> or how things will be done....etc etc etc..
> 
> That makes sense, but here's what I was thinking...
> 
> I simply post the HTML output of the Tex2RTF build on the web site and 
> you link to it.  It will definitely look different than the main web 
> site, but it should.

I concur....

> 
> I'll try to generate an example soon.  I'll post when I'm done.
> 
> Pete
> 

Good stuff, I'll check it out as soon as it's up...


Regards,

Donald B



_________________________________________________________________
Never miss another e-mail with Hotmail on your mobile.
http://www.livelife.ninemsn.com.au/article.aspx?id=343869