diff options
Diffstat (limited to 'docs/README.docs')
-rw-r--r-- | docs/README.docs | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/README.docs b/docs/README.docs new file mode 100644 index 000000000..08f6e8935 --- /dev/null +++ b/docs/README.docs @@ -0,0 +1,42 @@ +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 we'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... + + 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 . + +Sincerely, + Matthew P. Barnson + The Bugzilla "Doc Knight" + barnboy@trilobyte.net |