Bugzilla-Guide.xml 7.07 KB
Newer Older
1
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" [
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

<!-- Include macros -->
<!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">
19
<!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml">
20 21 22 23 24 25
<!ENTITY revhistory SYSTEM "revhistory.sgml">

<!ENTITY bz "http://www.mozilla.org/projects/bugzilla">
<!ENTITY bz-ver "2.14">
<!ENTITY bz-cvs-ver "2.15">
<!ENTITY bzg-date "August 10, 2001">
26
<!ENTITY bzg-ver "2.14">
27 28
<!ENTITY bzg-cvs-ver "2.15.0">
<!ENTITY bzg-auth "Matthew P. Barnson">
29
<!ENTITY bzg-auth-email "<email>barnboy@trilobyte.net</email>">
30 31
<!ENTITY mysql "http://www.mysql.com/">
<!ENTITY perl-ver "5.6.1">
32 33 34 35

]>


36
<!-- Coding standards for this document 
37

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
*  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.sgml.
*  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.linuxdoc.org, and
check out the KDE guidelines (they are nice, too)
http://i18n.kde.org/doc/markup.html
*  All tags should be lowercase (needsfix)
*  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.
53 54 55

-->

56
<book id="index">
57 58 59

<!-- Header -->

60 61 62 63 64 65 66 67 68 69 70 71 72
  <bookinfo>
    <title>The Bugzilla Guide</title>
    <pubdate>2001-04-25</pubdate>
    <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>
73 74 75 76

      <revision>
	<revnumber>2.11.1</revnumber>
	<date>06 March 2001</date>
77
	<authorinitials>MPB</authorinitials>
78
	<revremark>
79 80 81 82 83 84 85
	  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.
86 87
	</revremark>
      </revision>
88
      
89 90 91 92 93
      <revision>
	<revnumber>2.12.0</revnumber>
	<date>24 April 2001</date>
	<authorinitials>MPB</authorinitials>
	<revremark>
94 95 96 97 98 99 100 101 102
	  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.
103 104
	</revremark>
      </revision>
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
      
      <revision>
	<revnumber>2.14.0</revnumber>
	<date>07 August 2001</date>
	<authorinitials>MPB</authorinitials>
	<revremark>
	  Attempted to integrate relevant portions of the UNIX and
	  Windows installation instructions, moved some data from FAQ
	  to Install, removed references to README from text, added
	  Mac OS X install instructions, fixed a bunch
	  of tpyos (Mark Harig), linked text that referenced other
	  parts of the Guide, and nuked the old MySQL permissions
	  section.
	</revremark>
      </revision>
    </revhistory>

    <authorgroup>

      <author>
	<firstname>Matthew</firstname>
	<othername>P.</othername>
	<surname>Barnson</surname>
	<affiliation>
129
	  <address><email>barnboy@trilobyte.net</email></address>
130 131 132 133 134 135
	</affiliation>
      </author>

      <collab>
	<collabname>Zach Lipton</collabname>
	<affiliation>
136
	  <address><email>zach AT zachlipton DOT com</email></address>
137 138 139 140 141 142 143 144 145 146 147 148 149 150
	</affiliation>
      </collab>

    </authorgroup>

    <abstract>
      <para>
	This is the documentation for Bugzilla, the Mozilla
	bug-tracking system.
      </para>
      <para>
	Bugzilla is an enterprise-class set of software utilities
	that, when used together, power issue-tracking for hundreds of
	organizations around the world, tracking millions of bugs.
151
	While it is easy to use and quite flexible, it is
152 153 154 155
	difficult for a novice to install and maintain.  Although we
	have provided step-by-step directions, Bugzilla is not always
	easy to get working.  Please be sure the person responsible
	for installing and maintaining this software is a qualified
156
	professional for the operating system upon which you install
157 158
	Bugzilla.
      </para>
159
      <para>
160
	THIS DOCUMENTATION IS MAINTAINED IN DOCBOOK 4.1.2 XML FORMAT.
161 162 163 164
	IF YOU WISH TO MAKE CORRECTIONS, PLEASE MAKE THEM IN PLAIN
	TEXT OR SGML DIFFS AGAINST THE SOURCE.  I CANNOT ACCEPT
	ADDITIONS TO THE GUIDE WRITTEN IN HTML!
      </para>
165 166
    </abstract>

167

168 169 170 171 172 173 174 175 176 177 178 179
    <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>
180 181 182 183

<!-- About This Guide -->
&about;

184 185 186
<!-- Using Bugzilla -->
&using;

187 188 189 190 191 192 193 194 195 196 197 198
<!-- Installing Bugzilla -->
&installation;

<!-- Administering Bugzilla -->
&administration;

<!-- Integrating Bugzilla with Third-Party Tools -->
&integration;

<!-- The Future of Bugzilla -->
&future;

199 200 201
<!-- Major Bugzilla Variants -->
&variants;

202 203 204
<!-- Appendix: The Frequently Asked Questions -->
&faq;

205
<!-- Appendix: Required Bugzilla Software Links -->
206
&requiredsoftware;
207

208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
<!-- Appendix: The Database Schema -->
&database;

<!-- Appendix: Custom Patches -->
&patches;

<!-- Appendix: The GNU Free Documentation License -->
&gfdl;

<!-- Glossary -->
&glossary;

<!-- Index -->
&index;

223 224

</book>
225 226 227 228 229

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
230 231
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
232
sgml-exposed-tags:nil
233 234 235
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
236 237
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
238 239 240 241 242 243
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
244 245
End:
-->