[Babase] Easy generation of documentation output (diagrams, PDF)
Karl O. Pinc
babase@www.eco.princeton.edu
Wed, 06 Apr 2005 05:20:47 +0000
Hi,
I've automated the generation of the documentation in
the babase/doc/ directory. While in that directory
you can type
make usage
to find out how to use the make command there.
Or, type
make
to produce the various documentation output formats.
Right now the only documentation that's produced is
PDF. It's easy to make html too, but I want to
get some more website infrastructure in place
before we do that.
Leah has produced diagrams of the new babase and they show up in
the generated output.
Warning: the documentation's text is not in the output much
at all yet. I hope to get more from Anne in a couple
of weeks. And then parts will be done but parts
will need serious ripping out and there will need
to be some new stuff. There is text that's getting
updated as we futz with database design but it does
not yet show in the generated output.
---
Leah,
Some of the diagram text is different from the rest and
is not scaling. It comes out tiny. Tiny tiny. Work with
me to figure out what's going on.
Also, ant2.gif is missing from the master archive.
And you should confirm we've license to use it
and re-distribute it to the Net for re-use.
---
Anne, Leah,
These changes are in the master archive. You will need to
bring your trees up to date.
Be sure to look for files ending in .rej or .orig, particularly
the babase_system.xml.XXXX sort of thing after using tla
to get the latest stuff from the master archive. .rej files indicate
that the change tracking system is confused by both of us editing
the document at the same time. .orig files show you that changes
have been made to something that you changed too. I think.
And your pre-update from the master file is the .orig file.
If I'm right you can use
diff -u babase_system.xml.orig babase_system.xml
to see what changes were made to the babase_system.xml file
by somebody else. And then you can delete babase_system.xml.orig
because you don't need it.
And the .rej files would be changes of yours that conflict with
changes made to the master copy.
That's if you work in a tree that's from the master archive
and do
tla update
to bring your tree up to date with the master and
tla commit
to put your changes into the master.
I'm not sure Anne is working this way so her .orig and .rej files
could be different. What I've described is a
'master archive changes are the good ones by default'
way of things happing. It's also possible to use
tla so that 'my changes are the good ones if there's
a conflict with the master' way of working, in which
case the .rej files would hold changes made in the master.
Please confirm things are working as expected. Thanks.
Karl <kop@meme.com>
Free Software: "You don't pay back, you pay forward."
-- Robert A. Heinlein