mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-02 07:05:24 +00:00
79f7610351
single large HTML and TXT files, and updated README.docs with compiling instructions for the Guide.
68 lines
2.9 KiB
Plaintext
68 lines
2.9 KiB
Plaintext
Welcome to the Bugzilla documentation project!
|
|
You'll find these directories and files here:
|
|
|
|
README.docs # This README file
|
|
html/ # The compiled HTML docs from SGML sources (do not edit)
|
|
sgml/ # The original SGML doc sources (edit these)
|
|
txt/ # The compiled text docs from SGML sources
|
|
ps/ # The compiled PostScript docs from SGML sources
|
|
pdf/ # The compiled Adobe PDF docs from SGML sources
|
|
|
|
A note about SGML:
|
|
The documentation is written in DocBook 3.1/4.1 SGML, and attempts to adhere
|
|
to the LinuxDoc standards everywhere applicable (http://www.linuxdoc.org).
|
|
Please consult "The LDP Author Guide" at linuxdoc.org for details on how
|
|
to set up your personal environment for compiling SGML files.
|
|
If you need to make corrections to typographical errors, or other minor
|
|
editing duties, feel free to use any text editor to make the changes. SGML
|
|
is not rocket science -- simply make sure your text appears between
|
|
appropriate tags (like <para>This is a paragraph</para>) and we'll be fine.
|
|
If you are making more extensive changes, please ensure you at least validate
|
|
your SGML before checking it in with something like:
|
|
nsgmls -s Bugzilla-Guide.sgml
|
|
|
|
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:
|
|
|
|
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 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, 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"
|
|
barnboy@trilobyte.net
|