[OpenAFS] Documentation project

ted creedon tcreedon@easystreet.com
Fri, 10 Jun 2005 08:22:23 -0700

Sources sent to openafs-bugs@openafs.org.

Anyone else interested can respond. It's a 3.5M targz file.


Install tidy from the targz file.

To convert the IBM.htm files, cd to each directory and run ./convert.sh


rm *.dvi *.tex *.aux *.out *.log *.pdf *.tex *.tidy *.stp* *.old *.html
*.hhtm #general cleanup
for i in *.htm ;do tidy -igv $i>$i.tidy;done  # tidys the IBM htm files
for i in *.tidy ;do ./pre_cleanup.pl $i ;done # changes &lt>, etc to
standard html
for i in *.hhtm ;do ./html2latex.pl  $i ;done # converts IBM htm to tex
for i in *.tex ;do latex  $i ;done            # hit enter when it stops with
a ?
for i in *.tex ;do ./tth $i ;done	          # converts tex to html
for i in *.html;do ./post_cleanup.pl $i;done  # corrects the reserved words
in the html files
                                              # at this point in time you
should have hyper linked html files
for i in *.dvi ;do xdvi  $i ;done             # views dvi files produced by

There's one bug, ToC_1 is incorrectly parsed, should be ToC\_1. This causes
latex to interpret what's after the _ as subscripts. Not fatal.

Take a look and comment..


-----Original Message-----
From: openafs-info-admin@openafs.org [mailto:openafs-info-admin@openafs.org]
On Behalf Of Derrick J Brashear
Sent: Friday, June 10, 2005 6:40 AM
To: openafs-info@openafs.org
Subject: RE: [OpenAFS] Documentation project

On Fri, 10 Jun 2005, ted creedon wrote:

> 1. Explain "codify". If you mean "tell us what tricks we need to know"
> that's why I suggested a BOF at the conference.

Is it a small set of same or similar transforms which can be scripted?

> 2. Hand edits will be required but more importantly, trial "latex 
> foo.tex"'s will have to be run and that's where the inconsistent (and
> semi-undocumented) handling of special characters (such as # and _) 
> will require many hours of learning time by anyone attempting updates.

Ok. You might as well send a tar or zip file to openafs-bugs@openafs.org


OpenAFS-info mailing list