diff options
Diffstat (limited to 'docs/en/xml/Bugzilla-Guide.xml')
| -rw-r--r-- | docs/en/xml/Bugzilla-Guide.xml | 272 |
1 files changed, 145 insertions, 127 deletions
diff --git a/docs/en/xml/Bugzilla-Guide.xml b/docs/en/xml/Bugzilla-Guide.xml index e9650c7cb..9334472af 100644 --- a/docs/en/xml/Bugzilla-Guide.xml +++ b/docs/en/xml/Bugzilla-Guide.xml @@ -1,120 +1,128 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ - <!ENTITY % myents SYSTEM "bugzilla.ent"> - %myents; +<!DOCTYPE BOOK PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ <!-- Include macros --> -<!ENTITY about SYSTEM "about.xml"> -<!ENTITY conventions SYSTEM "conventions.xml"> -<!ENTITY doc-index SYSTEM "index.xml"> -<!ENTITY gfdl SYSTEM "gfdl.xml"> -<!ENTITY glossary SYSTEM "glossary.xml"> -<!ENTITY installation SYSTEM "installation.xml"> -<!ENTITY administration SYSTEM "administration.xml"> -<!ENTITY security SYSTEM "security.xml"> -<!ENTITY using SYSTEM "using.xml"> -<!ENTITY integration SYSTEM "integration.xml"> -<!ENTITY index SYSTEM "index.xml"> -<!ENTITY customization SYSTEM "customization.xml"> -<!ENTITY troubleshooting SYSTEM "troubleshooting.xml"> -<!ENTITY patches SYSTEM "patches.xml"> -<!ENTITY introduction SYSTEM "introduction.xml"> -<!ENTITY modules SYSTEM "modules.xml"> - -<!-- Things to change for a stable release: - * bz-ver to current stable - * bz-nexver to next stable - * bz-date to the release date - * landfillbase to the branch install - * Remove the BZ-DEVEL comments - - COMPILE DOCS AND CHECKIN - - Also, tag and tarball before completing - * bz-ver to devel version - - For a devel release, simple bump bz-ver and bz-date ---> +<!ENTITY about SYSTEM "about.sgml"> +<!ENTITY conventions SYSTEM "conventions.sgml"> +<!ENTITY doc-index SYSTEM "index.sgml"> +<!ENTITY faq SYSTEM "faq.sgml"> +<!ENTITY gfdl SYSTEM "gfdl.sgml"> +<!ENTITY glossary SYSTEM "glossary.sgml"> +<!ENTITY installation SYSTEM "installation.sgml"> +<!ENTITY administration SYSTEM "administration.sgml"> +<!ENTITY using SYSTEM "using.sgml"> +<!ENTITY integration SYSTEM "integration.sgml"> +<!ENTITY future SYSTEM "future.sgml"> +<!ENTITY index SYSTEM "index.sgml"> +<!ENTITY database SYSTEM "database.sgml"> +<!ENTITY patches SYSTEM "patches.sgml"> +<!ENTITY variants SYSTEM "variants.sgml"> +<!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml"> -<!ENTITY bz-ver "3.1.3"> -<!ENTITY bz-nextver "3.2"> -<!ENTITY bz-date "2008-02-01"> -<!ENTITY current-year "2008"> +]> -<!ENTITY landfillbase "http://landfill.bugzilla.org/bugzilla-tip/"> -<!ENTITY bz "http://www.bugzilla.org/"> -<!ENTITY bzg-bugs "<ulink url='https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation'>Bugzilla Documentation</ulink>"> -<!ENTITY mysql "http://www.mysql.com/"> +<!-- Coding standards for this document -<!ENTITY min-perl-ver "5.8.1"> -]> +1. Preface new or modified sections with a comment stating who + modified it and when; please also use the "authorinitials" tag. +2. There is no "two". -<!-- Coding standards for this document +3. Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc. + +4. Use Entities to include files for new chapters in Bugzilla-Guide.sgml. + +5. Ensure all documents compile cleanly to HTML after modification. + The errors "DTD Declaration not allowed here" and "DTDDECL catalog types not supported" + are normal errors to be expected when compiling the whole guide. + +6. Try to index important terms wherever possible. + +7. Follow coding standards at http://www.linuxdoc.org. + +8. All tags should be lowercase (needsfix) -* Other than the GFDL, please use the "section" tag instead of "sect1", - "sect2", etc. -* Use Entities to include files for new chapters in Bugzilla-Guide.xml. -* Try to use Entities for frequently-used passages of text as well. -* Ensure all documents compile cleanly to HTML after modification. - The warning, "DTDDECL catalog types not supported" is normal. -* Try to index important terms wherever possible. -* Use "glossterm" whenever you introduce a new term. -* Follow coding standards at http://www.tldp.org, and - check out the KDE guidelines (they are nice, too) - http://i18n.kde.org/doc/markup.html -* All tags should be lowercase. -* Please use sensible spacing. The comments at the very end of each - file define reasonable defaults for PSGML mode in EMACS. -* Double-indent tags, use double spacing whenever possible, and - try to avoid clutter and feel free to waste space in the code to make it - more readable. +9. Code being submitted for review should use the +"review" tag. Documentation on this is available at +http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html + under section 4.9.4, "Making notes on the text while it's being written". + +10. Please use sensible spacing. The comments at the very end of each Guide + file define reasonable defaults for PSGML mode in EMACS. + Double-indent tags, use double spacing whenever possible, + try to avoid clutter and feel free to waste space in the code to make it more readable. --> -<book id="index"> +<BOOK ID="index"> <!-- Header --> - <bookinfo> - <title>The Bugzilla Guide - &bz-ver; - <!-- BZ-DEVEL -->Development <!-- /BZ-DEVEL --> - Release</title> - - <authorgroup> - <corpauthor>The Bugzilla Team</corpauthor> - </authorgroup> - - <pubdate>&bz-date;</pubdate> - - <abstract> - <para> - This is the documentation for Bugzilla, a - bug-tracking system from mozilla.org. - Bugzilla is an enterprise-class piece of software - that tracks millions of bugs and issues for hundreds of - organizations around the world. - </para> - - <para> - The most current version of this document can always be found on the - <ulink url="http://www.bugzilla.org/docs/">Bugzilla - Documentation Page</ulink>. - </para> - - </abstract> - - <keywordset> - <keyword>Bugzilla</keyword> - <keyword>Guide</keyword> - <keyword>installation</keyword> - <keyword>FAQ</keyword> - <keyword>administration</keyword> - <keyword>integration</keyword> - <keyword>MySQL</keyword> - <keyword>Mozilla</keyword> - <keyword>webtools</keyword> - </keywordset> - </bookinfo> + <BOOKINFO> + <TITLE>The Bugzilla Guide</TITLE> + <PUBDATE>v2.12.0, 24 April 2001</PUBDATE> + <AUTHOR> + <FIRSTNAME>Matthew</FIRSTNAME> + <OTHERNAME>P.</OTHERNAME> + <SURNAME>Barnson</SURNAME> + <affiliation> + <address><email>barnboy@trilobyte.net</email></address> + </affiliation> + </AUTHOR> + + <ABSTRACT> + <PARA>This is the documentation for Bugzilla, the Mozilla bug-tracking system.</PARA> + </ABSTRACT> + + <REVHISTORY> + <REVISION> + <REVNUMBER>v2.11</REVNUMBER> + <DATE>20 December 2000</DATE> + <AUTHORINITIALS>MPB</AUTHORINITIALS> + <REVREMARK>Converted the README, FAQ, and DATABASE information into SGML + docbook format.</REVREMARK> + </REVISION> + + <revision> + <revnumber>2.11.1</revnumber> + <date>06 March 2001</date> + <authorinitials>MPB</authorinitials> + <revremark> + Took way too long to revise this for 2.12 release. + Updated FAQ to use qandaset tags instead of literallayout, + cleaned up administration section, added User Guide section, + miscellaneous FAQ updates and third-party integration information. + From this point on all new tags are lowercase in preparation for the + 2.13 release of the Guide in XML format instead of SGML. + </revremark> + </revision> + + <revision> + <revnumber>2.12.0</revnumber> + <date>24 April 2001</date> + <authorinitials>MPB</authorinitials> + <revremark> + Things fixed this release: Elaborated on queryhelp interface, added FAQ regarding + moving bugs from one keyword to another, clarified possible problems with the Landfill + tutorial, fixed a boatload of typos and unclear sentence structures. Incorporated the + README into the UNIX installation section, and changed the README to indicate the deprecated + status. Things I know need work: Used "simplelist" a lot, where I should have used + "procedure" to tag things. Need to lowercase all tags to be XML compliant. + </revremark> + </revision> + </REVHISTORY> + + <KEYWORDSET> + <KEYWORD>Bugzilla</KEYWORD> + <KEYWORD>Guide</KEYWORD> + <KEYWORD>installation</KEYWORD> + <KEYWORD>FAQ</KEYWORD> + <KEYWORD>administration</KEYWORD> + <KEYWORD>integration</KEYWORD> + <KEYWORD>MySQL</KEYWORD> + <KEYWORD>Mozilla</KEYWORD> + <KEYWORD>webtools</KEYWORD> + </KEYWORDSET> + </BOOKINFO> <!-- About This Guide --> &about; @@ -125,25 +133,31 @@ <!-- Administering Bugzilla --> &administration; -<!-- Securing Bugzilla --> -&security; - <!-- Using Bugzilla --> &using; -<!-- Customizing Bugzilla --> -&customization; +<!-- Integrating Bugzilla with Third-Party Tools --> +&integration; + +<!-- The Future of Bugzilla --> +&future; + +<!-- Appendix: The Frequently Asked Questions --> +&faq; + +<!-- Appendix: Required Bugzilla Software Links --> +&requiredsoftware -<!-- Appendix: Troubleshooting --> -&troubleshooting; +<!-- Appendix: The Database Schema --> +&database; + +<!-- Appendix: Major Bugzilla Variants --> +&variants; <!-- Appendix: Custom Patches --> &patches; -<!-- Appendix: Manually Installing Perl Modules --> -&modules; - -<!-- Appendix: GNU Free Documentation License --> +<!-- Appendix: The GNU Free Documentation License --> &gfdl; <!-- Glossary --> @@ -152,27 +166,31 @@ <!-- Index --> &index; - -</book> +</BOOK> <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-always-quote-attributes:t -sgml-auto-insert-required-elements:t -sgml-balanced-tag-edit:t -sgml-exposed-tags:nil +sgml-omittag:t +sgml-shorttag:t +sgml-namecase-general:t sgml-general-insert-case:lower -sgml-indent-data:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t sgml-indent-step:2 +sgml-indent-data:t +sgml-parent-document:nil +sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil -sgml-minimize-attributes:nil -sgml-namecase-general:t -sgml-omittag:t -sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") -sgml-shorttag:t -sgml-tag-region-if-active:t End: --> + + + + + + + + |