[Box Backup-dev] DocProject editing setup
E.W. Peter Jalajas
boxbackup-dev@fluffy.co.uk
Sat, 12 Aug 2006 06:05:42 -0700 (PDT)
Thanks, Per.
Maybe these are bugs:
1) No rule to make target `../../ExceptionCodes.txt
2) Error: no ID for constraint linkend:
3) Missing box-html images.
4) Low priority: no index.html in man-pages dir.
5) Low priority: .there file in man-page dirs.
Slightly edited screen swipes as follows:
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
date
Sat Aug 12 08:12:22 EDT 2006
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
pwd
/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
ls
adminguide.xml bb-book.xsl bbstoreaccounts.xml
generate_except_xml.pl instguide.xml~
bbackupctl.xml bb-man.xsl bbstored-certs.xml html
Makefile
bbackupquery.xml bb-nochunk-book.xsl bbstored-config.xml
instguide.xml raidfile-config.xml
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
make
make: *** No rule to make target `../../ExceptionCodes.txt', needed by
`ExceptionCodes.xml'. Stop.
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
grep -i except Makefile
$(HTMLPREFIX)/adminguide/index.html: adminguide.xml ExceptionCodes.xml
$(BOOKXSL)
ExceptionCodes.xml: ../../ExceptionCodes.txt
perl ./generate_except_xml.pl
if [ -f ExceptionCodes.xml ]; then rm ExceptionCodes.xml; fi
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
grep ExceptionCodes ./generate_except_xml.pl
open (EXCEPT, "<../../ExceptionCodes.txt") or die "Can't open
../../ExceptionCodes.txt: $!\n";
open (DOCBOOK, ">ExceptionCodes.xml") or die "Can't open
Exceptioncodes.xml for writing: $!\n";
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
find ../../../ | grep -i except | wc -l
95
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
find ../../../ | grep -i exceptioncode |
wc -l
0
I happened to have a random version of ExceptionCodes.txt available so
I did:
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
cp /home/petjal/doc/teb/bu/boxbackup-0.10/ExceptionCodes.txt ../../
Then I ran make and saw these errors:
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
make
perl ./generate_except_xml.pl
# docname=`echo box-html/adminguide/index.html | sed -e
's/\/index.html//'`
/usr/bin/xsltproc -o box-html/adminguide/ bb-book.xsl adminguide.xml
Writing pr01.html for preface
Error: no ID for constraint linkend: instguide.xml.
Error: no ID for constraint linkend: instguide.sgml.
Writing ch01.html for chapter
Error: no ID for constraint linkend: bbackupquery.xml.
Writing ch02.html for chapter
Writing apa.html for appendix
Writing apb.html for appendix
Writing index.html for book
/usr/bin/xsltproc -o box-html/instguide/ bb-book.xsl instguide.xml
Writing pr01.html for preface
Writing ch01.html for chapter
Writing ch02.html for chapter
Writing apa.html for appendix
Writing apb.html for appendix
Writing apc.html for appendix
Writing index.html for book
if [ ! -d man-pages ]; then mkdir man-pages; touch man-pages/.there; fi
if [ ! -d man-html ]; then mkdir -p box-html/man-html; touch
box-html/man-html/.there; fi
/usr/bin/xsltproc -o bbackupquery.1 bb-man.xsl bbackupquery.xml
Writing bbackupquery.1 for refentry
mv bbackupquery.1 man-pages/.
gzip -f -9 man-pages/bbackupquery.1
/usr/bin/xsltproc -o bbackupctl.1 bb-man.xsl bbackupctl.xml
Writing bbackupctl.1 for refentry
mv bbackupctl.1 man-pages/.
gzip -f -9 man-pages/bbackupctl.1
/usr/bin/xsltproc -o bbstoreaccounts.1 bb-man.xsl bbstoreaccounts.xml
Writing bbstoreaccounts.1 for refentry
mv bbstoreaccounts.1 man-pages/.
gzip -f -9 man-pages/bbstoreaccounts.1
/usr/bin/xsltproc -o bbstored-config.1 bb-man.xsl bbstored-config.xml
Writing bbstored-config.1 for refentry
mv bbstored-config.1 man-pages/.
gzip -f -9 man-pages/bbstored-config.1
/usr/bin/xsltproc -o raidfile-config.1 bb-man.xsl raidfile-config.xml
Writing raidfile-config.1 for refentry
mv raidfile-config.1 man-pages/.
gzip -f -9 man-pages/raidfile-config.1
/usr/bin/xsltproc -o bbstored-certs.1 bb-man.xsl bbstored-certs.xml
Writing bbstored-certs.1 for refentry
mv bbstored-certs.1 man-pages/.
gzip -f -9 man-pages/bbstored-certs.1
/usr/bin/xsltproc -o bbackupquery.html bb-nochunk-book.xsl
bbackupquery.xml
mv bbackupquery.html box-html/man-html/.
/usr/bin/xsltproc -o bbackupctl.html bb-nochunk-book.xsl bbackupctl.xml
mv bbackupctl.html box-html/man-html/.
/usr/bin/xsltproc -o bbstoreaccounts.html bb-nochunk-book.xsl
bbstoreaccounts.xml
mv bbstoreaccounts.html box-html/man-html/.
/usr/bin/xsltproc -o bbstored-config.html bb-nochunk-book.xsl
bbstored-config.xml
mv bbstored-config.html box-html/man-html/.
/usr/bin/xsltproc -o raidfile-config.html bb-nochunk-book.xsl
raidfile-config.xml
mv raidfile-config.html box-html/man-html/.
/usr/bin/xsltproc -o bbstored-certs.html bb-nochunk-book.xsl
bbstored-certs.xml
mv bbstored-certs.html box-html/man-html/.
I then did cd to the xxe bin directory, ran ./xxe, opened the
adminguide.xml, got an ignorable, I think, Information window about
ExceptionCodes needing to be edited separately if desired, and then the
adminguide.xml opened fine.
Next, I tried to open the just-created adminguide.html in a browser,
file:///home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup/box-html/adminguide/index.html
but it was missing images and wasn't much better than the one I made
from inside xxe.
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
find | grep png$
./html/images/stepahead.png
./html/images/bblogo.png
./html/images/arrow.png
Then man pages in ./box-html/man-html/bbstored-config.html
seemed fine, but maybe with an extra carriage return after every line.
Would be nice to have: an index.html in the man-pages directory.
Otherwise, opening
file:///home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup/box-html/man-html/
provides the man-pages folder listing; ugly but useable (clickable,
with back-button available for navigation between man pages).
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
find . | grep there
./box-html/man-html/.there
./man-pages/.there
For the record:
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
grep xsltproc Makefile
DBPROC=/usr/bin/xsltproc
kids@brick:/home/public/pete/teb/cli/bu/doc/boxbackup/documentation/boxbackup$
which xsltproc
/usr/bin/xsltproc
--- Per Thomsen <pthomsen@reedtz.com> wrote:
> On 8/11/06 9:57 PM, E.W. Peter Jalajas wrote:
> Sure. Type 'make' in the boxbackup/documentation/boxbackup directory.
> That creates the ExceptionCodes.xml file, and you can then open
> adminguide.xml. This also generates the nicer looking HTML pages for
> you, as well as the man-pages.
> 'make' is your friend... Look at the Makefile, to see what I'm doing.