diff options
-rw-r--r-- | docs/en/xml/Bugzilla-Guide.xml | 117 |
1 files changed, 63 insertions, 54 deletions
diff --git a/docs/en/xml/Bugzilla-Guide.xml b/docs/en/xml/Bugzilla-Guide.xml index 686bdb462..5ff9555a4 100644 --- a/docs/en/xml/Bugzilla-Guide.xml +++ b/docs/en/xml/Bugzilla-Guide.xml @@ -1,4 +1,4 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" [ <!-- Include macros --> <!ENTITY about SYSTEM "about.xml"> @@ -9,87 +9,82 @@ <!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 future SYSTEM "future.xml"> <!ENTITY index SYSTEM "index.xml"> -<!ENTITY customization SYSTEM "customization.xml"> -<!ENTITY troubleshooting SYSTEM "troubleshooting.xml"> +<!ENTITY database SYSTEM "database.xml"> <!ENTITY patches SYSTEM "patches.xml"> +<!ENTITY variants SYSTEM "variants.xml"> <!ENTITY introduction SYSTEM "introduction.xml"> -<!ENTITY modules SYSTEM "modules.xml"> +<!ENTITY revhistory SYSTEM "revhistory.xml"> <!-- Things to change for a stable release: * bz-ver to current stable * bz-nexver to next stable * bz-date to the release date - * Remove the BZ-DEVEL comments + * bz-devel to "IGNORE" - COMPILE DOCS AND CHECKIN - Also, tag and tarball before completing * bz-ver to devel version + * bz-devel to "INCLUDE" For a devel release, simple bump bz-ver and bz-date --> -<!ENTITY bz-ver "2.21"> -<!ENTITY bz-nextver "2.22"> -<!ENTITY bz-date "2005-07-07"> -<!ENTITY current-year "2005"> +<!ENTITY bz-ver "2.17.5"> +<!ENTITY bz-nextver "2.18"> +<!ENTITY bz-date "2003-11-01"> +<!ENTITY % bz-devel "INCLUDE"> -<!ENTITY landfillbase "http://landfill.bugzilla.org/bugzilla-tip/"> <!ENTITY bz "http://www.bugzilla.org/"> +<!ENTITY bzg-auth "The Bugzilla Team"> <!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation'>Bugzilla Documentation</ulink>"> <!ENTITY mysql "http://www.mysql.com/"> +<!ENTITY newest-perl-ver "5.8"> <!-- For minimum versions --> <!ENTITY min-mysql-ver "3.23.41"> -<!ENTITY min-pg-ver "7.3.x"> -<!ENTITY min-perl-ver "5.6.1"> -<!ENTITY min-perl-ver-win "5.8.1"> +<!ENTITY min-perl-ver "5.6"> <!ENTITY min-template-ver "2.08"> <!ENTITY min-file-temp-ver "any"> <!ENTITY min-appconfig-ver "1.52"> <!ENTITY min-text-wrap-ver "2001.0131"> <!ENTITY min-file-spec-ver "0.82"> <!ENTITY min-data-dumper-ver "any"> -<!ENTITY min-dbd-mysql-ver "2.9003"> -<!ENTITY min-dbd-pg-ver "1.31"> -<!ENTITY min-dbi-ver "1.38"> +<!ENTITY min-dbd-mysql-ver "2.1010"> +<!ENTITY min-dbi-ver "1.32"> <!ENTITY min-date-format-ver "2.21"> -<!ENTITY min-cgi-ver "2.93"> -<!ENTITY min-mail-mailer-ver "1.65"> -<!ENTITY min-storable-ver "any"> +<!ENTITY min-cgi-ver "2.88"> <!-- Optional modules --> <!ENTITY min-gd-ver "1.20"> <!ENTITY min-gd-graph-ver "any"> <!ENTITY min-gd-text-align-ver "any"> -<!ENTITY min-chart-base-ver "1.0"> +<!ENTITY min-chart-base-ver "0.99c"> <!ENTITY min-xml-parser-ver "any"> <!ENTITY min-mime-parser-ver "any"> -<!ENTITY min-patchreader-ver "0.9.4"> +<!ENTITY min-patchreader-ver "0.9.1"> ]> <!-- Coding standards for this document -* Other than the GFDL, please use the "section" tag instead of "sect1", - "sect2", etc. +* 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. +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 +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. +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. --> @@ -98,11 +93,18 @@ <!-- Header --> <bookinfo> - <title>The Bugzilla Guide - &bz-ver; - <!-- BZ-DEVEL -->Development <!-- /BZ-DEVEL --> - Release</title> + <title>The Bugzilla Guide - &bz-ver; <![%bz-devel;[Development ]]>Release</title> <authorgroup> + <author> + <firstname>Matthew</firstname> + <othername>P.</othername> + <surname>Barnson</surname> + </author> + <author> + <firstname>Jacob</firstname> + <surname>Steenhagen</surname> + </author> <corpauthor>The Bugzilla Team</corpauthor> </authorgroup> @@ -110,17 +112,28 @@ <abstract> <para> - This is the documentation for Bugzilla, a - bug-tracking system from mozilla.org. + This is the documentation for Bugzilla, the mozilla.org + bug-tracking system. Bugzilla is an enterprise-class piece of software - that tracks millions of bugs and issues for hundreds of - organizations around the world. + that powers issue-tracking for hundreds of + organizations around the world, tracking millions of bugs. </para> + <para> + This documentation is maintained in DocBook 4.1.2 XML format. + Changes are best submitted as plain text or XML diffs, attached + to a bug filed in the &bzg-bugs; component. + </para> + <![%bz-devel;[ + <para>This is a development version of this guide. Information in it + is subject to change before the &bz-nextver; release of this guide + (which will correspond with the &bz-nextver; release of Bugzilla). + </para> + ]]> + <para> The most current version of this document can always be found on the - <ulink url="http://www.bugzilla.org/documentation.html">Bugzilla - Documentation Page</ulink>. + <ulink url="http://www.bugzilla.org/documentation.html">Bugzilla Documentation Page</ulink>. </para> </abstract> @@ -141,32 +154,29 @@ <!-- About This Guide --> &about; +<!-- Introduction --> +&introduction; + +<!-- Using Bugzilla --> +&using; + <!-- Installing Bugzilla --> &installation; <!-- Administering Bugzilla --> &administration; -<!-- Securing Bugzilla --> -&security; - -<!-- Customizing Bugzilla --> -&customization; - -<!-- Using Bugzilla --> -&using; - <!-- Appendix: The Frequently Asked Questions --> &faq; -<!-- Appendix: Troubleshooting --> -&troubleshooting; +<!-- Appendix: The Database Schema --> +&database; <!-- Appendix: Custom Patches --> &patches; -<!-- Appendix: Manually Installing Perl Modules --> -&modules; +<!-- Appendix: Major Bugzilla Variants --> +&variants; <!-- Appendix: GNU Free Documentation License --> &gfdl; @@ -200,4 +210,3 @@ sgml-shorttag:t sgml-tag-region-if-active:t End: --> - |