Re: [docbook-apps] Best way to structure a source code tree

["Mike Broschinsky" <mbroschi@utah.gov>]

Hi Sheldon!

I realized I had never said thank you for your response. Maybe it's
because I really am just beginning; I keep thinking that there *must* be
a consistent best practice *somewhere* about how to structure these
things.

And so I looked around a little bit. You made a good suggestion. Norm's
source tree is structured one way for DocBook TDG for V5 and another way
for the older book. Karl Fogel, who wrote "Producing Open Source
Software" has structure *his* tree a little bit differently. So maybe
there *isn't* one monolithic best practice. Although, it did seem as if,
generally, like files were grouped. So images were in one folder, the
XML source in another, build scripts in another. *Everything* is under
source control though, as you suggested. I'm using Subversion, which
works well for me.

Using Make is a step a wee bit down the road. I'm on a Windows box; so
I'm taking some small steps with batch files for now.

Thanks for your help!

Mike

----------------------------
Mike Broschinsky
Administrative Code Editor
Utah State Division of Administrative Rules
801-538-3003
mbroschi@utah.gov

>>> Sheldon Plankton <sheldonplankton@yahoo.com> 02/28/06 1:09 PM >>>
Sounds like you could just keep everything in one directory where you
check your files out from CVS.  I keep my source files in CVS also but
keep them in subject related directories like: HAclusters, workstations,
LDAP, SSH, usermaint etc ...
   
  In keep these directories in $HOME/MYNOTES and I have a Makefile in
each
  of these directories so I do things like ...
   
  $ cd
  $ cd MYNOTES
  $ make pdfs
   
  ... to generate all of my source into PDF docs.  Or ...
   
  $ cd MYNOTES
  $ make
  $ make install
   
  ... which generates all my source xml into PDF, html, chunk, text,
and rtf
  and have all on that put on to my web server (make install).
   
  You should look into make it is a great tool.

Mike Broschinsky <mbroschi@utah.gov> wrote:
  While not directly related to any docbook app, this is a question I'm
struggling with as a beginner: how do I structure the source code tree
for my article/book/etc.?

For example, we publish a manual with five chapters, eight appendices,
and a sprinkling of images.

Is there a best practice for structuring the source? I mean, I could
just mirror the way that TDG is structured, but I would really like to
understand *why* it's structured that way. And also to understand why
there are subtle differences between the structure of the current TDG
and TDG5:

http://cvs.sourceforge.net/viewcvs.py/docbook/defguide/ 
http://cvs.sourceforge.net/viewcvs.py/docbook/defguide5/ 

Does my question make any sense at all? Any pointers would be *greatly*
appreciated.

Thanks,

Mike


---------------------------------------------------------------------
To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis-open.org 
For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org




		
---------------------------------
 Yahoo! Mail
 Use Photomail to share photos without annoying attachments.