jazzplusplus-devel

[jazzplusplus-devel] online help build system update

[Pete S. <pst...@ve...>]

Donald or anyone else wishing to help with documentation,

If you update your subversion source tree, I have modified the jazz/doc 
directory.  If you have checked out the entire subversion repository so 
you can create patches for the web content, the path to the 
documentation directory is jazzplusplus/trunk/jazz/doc.  On my x86_64 
Fedora 8 box, if I run "make" in the referenced directory, it will 
generate HTML help files you can view with your favorite web browser and 
a jazz.pdf file.

You will need certain tools available to make this work.  For the HTML 
help you will need the tex2rtf code that is provided with wxWidgets.

For PDF generation, you will need a LaTeX installation and the pdflatex 
converter.

If you have trouble with either of these build, you can perform them 
separately by using

make html

for HTML help generation or

make pdf

for PDF file generation.

Keep in mind I'm discussing and working on the build process, not the 
content of the help.  The screen shots used in the docs are from an old 
Jazz++ build and it looks like the Motif Window manager (mwm) was used. 
  They should be replaced.  I'm hoping the image format (Portable 
Network Graphics or PNG - http://www.libpng.org/pub/png/) will stick.

I'll be counting on you to fix up the content;-)  Before I help you with 
that, let's see if you can build the docs in either of the formats 
described above.  Let me know and I enjoyed your "biography post".

BTW, It appears my service provider (verizon.net) is blocking email from 
the Jazz++ lists, so I may end up replying using some other email 
account... What a pain.

Pete

Re: [jazzplusplus-devel] online help build system update

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

Greetings,


----------------------------------------
> Date: Sat, 10 May 2008 20:56:49 -0700


Apologies for not observing 'PCYMTNQREAIYR' previously..fixed..


> Donald or anyone else wishing to help with documentation,
> 
> If you update your subversion source tree, I have modified the jazz/doc 
> directory.  If you have checked out the entire subversion repository so 
> you can create patches for the web content, the path to the 
> documentation directory is jazzplusplus/trunk/jazz/doc.  On my x86_64 
> Fedora 8 box, if I run "make" in the referenced directory, it will 
> generate HTML help files you can view with your favorite web browser and 
> a jazz.pdf file.
> 
> You will need certain tools available to make this work.  For the HTML 
> help you will need the tex2rtf code that is provided with wxWidgets.
> 
> For PDF generation, you will need a LaTeX installation and the pdflatex 
> converter.
> 
> If you have trouble with either of these build, you can perform them 
> separately by using
> 
> make html
> 
> for HTML help generation or
> 
> make pdf
> 
> for PDF file generation.
> 
> Keep in mind I'm discussing and working on the build process, not the 
> content of the help.  The screen shots used in the docs are from an old 
> Jazz++ build and it looks like the Motif Window manager (mwm) was used.

....and possibly Lesstif widgets were used for linux builds IIRC
 
>   They should be replaced.  I'm hoping the image format (Portable 
> Network Graphics or PNG - http://www.libpng.org/pub/png/) will stick.
> 
> I'll be counting on you to fix up the content;-)  Before I help you with 
> that, let's see if you can build the docs in either of the formats 
> described above.  Let me know and I enjoyed your "biography post".
>

Manual (separate) generation of HTML docs works fine. I'll need grab &
install 'pdflatex' to checkout the PDF build. I'll do a full 'inline' build
of the tree a bit later and check all is working as expected. 

Glad my bio-post wasn't too far off topic ;-)
 

> BTW, It appears my service provider (verizon.net) is blocking email from 
> the Jazz++ lists, so I may end up replying using some other email 
> account... What a pain.

Indeed...why on earth would they do that?


Regards,

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

Re: [jazzplusplus-devel] online help build system update

[Pete S. <pst...@gm...>]

D.B. Moore wrote:
DM> Apologies for not observing 'PCYMTNQREAIYR'
DM> previously..fixed..

No problem.  Happens all of the time.  Thanks for fixing it.

PS>> Donald or anyone else wishing to help with
PS>> documentation,
PS>>
PS>> If you update your subversion source tree, I have
PS>> modified the jazz/doc directory.  If you have
PS>> checked out the entire subversion repository so
PS>> you can create patches for the web content, the path
PS>> to the documentation directory is
PS>> jazzplusplus/trunk/jazz/doc.  On my x86_64 Fedora 8
PS>> box, if I run "make" in the referenced directory, it
PS>> will generate HTML help files you can view with your
PS>> favorite web browser and a jazz.pdf file.
PS>>
PS>> You will need certain tools available to make this
PS>> work.  For the HTML help you will need the tex2rtf
PS>> code that is provided with wxWidgets.
PS>>
PS>> For PDF generation, you will need a LaTeX
PS>> installation and the pdflatex converter.
PS>>
PS>> If you have trouble with either of these build, you
PS>> can perform them separately by using
PS>>
PS>> make html
PS>>
PS>> for HTML help generation or
PS>>
PS>> make pdf
PS>>
PS>> for PDF file generation.
PS>>
PS>> Keep in mind I'm discussing and working on the build
PS>> process, not the content of the help.  The screen
PS>> shots used in the docs are from an old Jazz++ build
PS>> and it looks like the Motif Window manager (mwm) was
PS>> used.

DM> ....and possibly Lesstif widgets were used for linux
DM> builds IIRC

Yes, LessTif is the "open source" Motif (http://www.lesstif.org/).

PS>> They should be replaced.  I'm hoping the image format
PS>> (Portable Network Graphics or PNG -
PS>> http://www.libpng.org/pub/png/) will stick.
PS>>
PS>> I'll be counting on you to fix up the content;-)
PS>> Before I help you with that, let's see if you can
PS>> build the docs in either of the formats described
PS>> above.  Let me know and I enjoyed your "biography post".

DM> Manual (separate) generation of HTML docs works fine.

Excellent!  Then you have a working tex2rtf!

DM> I'll need grab & install 'pdflatex' to checkout the
DM> PDF build.  I'll do a full 'inline' build
DM> of the tree a bit later and check all is
DM> working as expected.

Would you like me to send you the current PDF file in a private email?

DM> Glad my bio-post wasn't too far off topic ;-)

Considering the amount of traffic on these lists (almost none) any post 
related to Jazz++ is welcome.

PS>> BTW, It appears my service provider (verizon.net)
PS>> is blocking email from the Jazz++ lists, so I may
PS>> end up replying using some other email account...
PS>> What a pain.

DM> Indeed...why on earth would they do that?

I don't know, but thank goodness for gmail.

Since you can build the HTML help using "make html" feel free to start 
editing jazz.tex and send me patches.  Replacement screen shots are 
welcome too.  We may end up with different sets of screen shots for each 
platform and I can change the Makefile to build the docs for different 
platforms.  I'm going to make one commit to jazz.tex before I go to bed, 
but after that it's "open season" for you.

I would prefer many smaller patches than one big patch, and please 
include a note summarizing the changes you made.  I'll use this in 
commit message and give you credit.  The first change you should make is 
make yourself a coauthor.  I changed the original author names because 
they have been out of the picture for over 8 years.  The commit messages 
will look like...

"Applied a patch provided by Donald B. Moore.
Your description here.
A description of anything I changed here."

I see you signed up for the jazzplusplus-updates list.  Excellent!

Looking forward to your web content and documentation patches.

TIA,
Pete

Re: [jazzplusplus-devel] online help build system update

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

Greetings,

----------------------------------------
> Date: Sat, 10 May 2008 22:26:58 -0700
> From: pst...@gm...

> PS>> jazzplusplus/trunk/jazz/doc.  On my x86_64 Fedora 8
> PS>> box, if I run "make" in the referenced directory, it
> PS>> will generate HTML help files you can view with your
> PS>> favorite web browser and a jazz.pdf file.
> PS>>
> PS>> You will need certain tools available to make this
> PS>> work.  For the HTML help you will need the tex2rtf
> PS>> code that is provided with wxWidgets.

I did forget to mention that 'tex2rtf' doesn't seem to get built
here as part of the wx-2.8.7 build instructions. I have no idea
if that's an expected result (it may well be)....

> PS>>
> PS>> For PDF generation, you will need a LaTeX
> PS>> installation and the pdflatex converter.
> PS>>

Using tetex under linux (which supplies the tool 'pdftex'),
jazz.pdf generation also works fine. The tool 'pdftex' is
also maintained separately (http://www.pdftex.org) and
seems more current than the version shipping with tetex.

Both versions work.

> 
> Would you like me to send you the current PDF file in a private email?
> 

A kind offer, however I'm eager to checkout as much of source
build process as is possible here - test, test and test again... 

> 
> Since you can build the HTML help using "make html" feel free to start 
> editing jazz.tex and send me patches.  Replacement screen shots are 
> welcome too.  We may end up with different sets of screen shots for each 
> platform and I can change the Makefile to build the docs for different 
> platforms.  I'm going to make one commit to jazz.tex before I go to bed, 
> but after that it's "open season" for you.
>

....now, where did I put my hunting cap?...  (;
 
> I would prefer many smaller patches than one big patch, and please 
> include a note summarizing the changes you made.  I'll use this in 
> commit message and give you credit.  The first change you should make is 
> make yourself a coauthor.  I changed the original author names because 
> they have been out of the picture for over 8 years.  The commit messages 
> will look like...
> 
> "Applied a patch provided by Donald B. Moore.
> Your description here.
> A description of anything I changed here."

All understood, I'll keep my submissions small and descriptive ...

> 
> I see you signed up for the jazzplusplus-updates list.  Excellent!
> 

I try to please.


I just need to clarify something here -- when you say;

'in your svn working'

I construe this as ;

'in your svn working directory'

Is that correct? Or does the paraphrase ' in your svn working'
refer to some subversion terminology that is unknown to me?

    Regards,

Donald B



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

Re: [jazzplusplus-devel] online help build system update

[Pete S. <pst...@gm...>]

DM = D.B. Moore
PS>> jazzplusplus/trunk/jazz/doc.  On my x86_64 Fedora 8
PS>> box, if I run "make" in the referenced directory, it
PS>> will generate HTML help files you can view with your
PS>> favorite web browser and a jazz.pdf file.
PS>>
PS>> You will need certain tools available to make this
PS>> work.  For the HTML help you will need the tex2rtf
PS>> code that is provided with wxWidgets.

DM> I did forget to mention that 'tex2rtf' doesn't
DM> seem to get built here as part of the wx-2.8.7
DM> build instructions. I have no idea if that's an
DM> expected result (it may well be)....

If you don't have tex2rtf, how did you build the HTML help?

tex2rtf will probably be the topic of a separate thread, but it can be 
generated from the wxWidgets distribution.  Unfortunately, due to the 
way wxWidgets is built for Jazz++, there are some potential problems.

PS>> For PDF generation, you will need a LaTeX
PS>> installation and the pdflatex converter.

DM> Using tetex under linux (which supplies the tool
DM> 'pdftex'), jazz.pdf generation also works fine.
DM> The tool 'pdftex' is also maintained separately
DM> (http://www.pdftex.org) and seems more current
DM> than the version shipping with tetex.
DM>
DM> Both versions work.

Maybe I can check for existence of pdflatex of pdftex in the build system.

PS>> Would you like me to send you the current PDF
PS>> file in a private email?

DM> A kind offer, however I'm eager to checkout
DM> as much of source build process as is possible
DM> here - test, test and test again...

PS>> Since you can build the HTML help using
PS>> "make html" feel free to start editing jazz.tex
PS>> and send me patches.  Replacement screen shots
PS>> are welcome too.  We may end up with different
PS>> sets of screen shots for each platform and I
PS>> can change the Makefile to build the docs for
PS>> different platforms.  I'm going to make one
PS>> commit to jazz.tex before I go to bed, but
PS>> after that it's "open season" for you.

DM> ....now, where did I put my hunting cap?...  (;

PS>> I would prefer many smaller patches than one
PS>> big patch, and please include a note
PS>> summarizing the changes you made.  I'll use
PS>> this in commit message and give you credit.
PS>> The first change you should make is make
PS>> yourself a coauthor.  I changed the original
PS>> author names because they have been out of
PS>> the picture for over 8 years.  The commit
PS>> messages will look like...
PS>>
PS>> "Applied a patch provided by Donald B. Moore.
PS>> Your description here.
PS>> A description of anything I changed here."

DM> All understood, I'll keep my submissions
DM> small and descriptive ...

Thanks.

PS>> I see you signed up for the
PS>> jazzplusplus-updates list.  Excellent!

DM> I try to please.

DM> I just need to clarify something here -- when you say;
DM>
DM> 'in your svn working'
DM>
DM> I construe this as ;
DM>
DM> 'in your svn working directory'
DM>
DM> Is that correct?

Yes.  Sorry about the missing noun an the related confusion.  I just 
committed a fix for this one.  You update your web source tree (i.e. 
your svn web working directory) and svn will merge the changes with any 
you have made.

Pete