summaryrefslogtreecommitdiffstats
path: root/docs/README.docs
diff options
context:
space:
mode:
authorbarnboy%trilobyte.net <>2001-03-08 15:35:25 +0100
committerbarnboy%trilobyte.net <>2001-03-08 15:35:25 +0100
commit46a97b76ff0362e05ad75df1785271ccc506928e (patch)
treed3fb8f9ea584a11776a9ef6f75c444cbf3b39374 /docs/README.docs
parenta5cac9db689e81129bfb07b0968f8cd2f00b56f2 (diff)
downloadbugzilla-46a97b76ff0362e05ad75df1785271ccc506928e.tar.gz
bugzilla-46a97b76ff0362e05ad75df1785271ccc506928e.tar.xz
Last transfer bombed on me. Added Bugzilla Guide as
single large HTML and TXT files, and updated README.docs with compiling instructions for the Guide.
Diffstat (limited to 'docs/README.docs')
-rw-r--r--docs/README.docs31
1 files changed, 28 insertions, 3 deletions
diff --git a/docs/README.docs b/docs/README.docs
index 08f6e8935..6b5d6ed61 100644
--- a/docs/README.docs
+++ b/docs/README.docs
@@ -23,19 +23,44 @@ your SGML before checking it in with something like:
When you validate, please validate the master document (Bugzilla-Guide.sgml)
as well as the document you edited to ensure there are no critical errors.
-The following errors are considered "normal" when validating with nsgmls
+The following errors are considered "normal" when validating with nsgmls:
+
DTDDECL catalog entries are not supported
"DOCTYPE" declaration not allowed in instance
+
The reason these occur is that free sgml validators do not yet support
-the DTDDECL catalog entries, and we've included DOCTYPE declarations in
+the DTDDECL catalog entries, and I've included DOCTYPE declarations in
entities referenced from Bugzilla-Guide.sgml so these entities can compile
individually, if necessary. I suppose I ought to comment them out at some
-point...
+point, but for now they are convenient and don't hurt anything.
Thanks for taking the time to read these notes and consulting the
documentation. Please address comments and questions to the newsgroup:
news://news.mozilla.org/netscape/public/mozilla/webtools .
+NOTES:
+
+ Here are the commands I use to maintain this documentation.
+ You MUST have DocBook 4.1 set up correctly in order for this to work,
+ but there's only a single REMARK tag that's incompatible with 3.1.
+ Maybe I'll downgrade to DocBook 3.1 to make your life easier...
+ Substitute your own path to "ldp.dsl" for "$LDP_HOME".
+
+
+To create HTML documentation:
+bash$ cd html
+bash$ jade -t sgml -i html -d $LDP_HOME/ldp.dsl\#html \
+../sgml/Bugzilla-Guide.sgml
+
+To create HTML documentation as a single big HTML file:
+bash$ cd html
+bash$ jade -V nochunks -t sgml -i html -d $LDP_HOME/ldp.dsl\#html \
+../sgml/Bugzilla-Guide.sgml >Bugzilla-Guide.html
+
+To create TXT documentation as a single big TXT file:
+bash$ cd txt
+bash$ lynx -dump -nolist ../html/Bugzilla-Guide.html >Bugzilla-Guide.txt
+
Sincerely,
Matthew P. Barnson
The Bugzilla "Doc Knight"