aboutsummaryrefslogtreecommitdiffstats
path: root/docs/xml/Bugzilla-Guide.xml
blob: a76d2c09099fa460412cfc5ea2c160dce182873e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" [

<!-- 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">
<!ENTITY introduction SYSTEM "introduction.sgml">
<!ENTITY revhistory SYSTEM "revhistory.sgml">

<!-- Things to change for a stable release:
     * bz-ver to current stable
     * bz-nexver to next stable
     * bz-date to the release date
     * bz-devel to "IGNORE"
     - COMPILE DOCS AND CHECKIN -
       Also, tag and tarball at 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.17.3">
<!ENTITY bz-nextver "2.18">
<!ENTITY bz-date "2003-01-02">
<!ENTITY % bz-devel "INCLUDE">

<!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&amp;component=Documentation'>Bugzilla</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-perl-ver "5.6">
<!ENTITY min-template-ver "2.08">
<!ENTITY min-file-temp-ver "1.804">
<!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 "1.2209">
<!ENTITY min-dbi-ver "1.13">
<!ENTITY min-date-parse-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 "0.99c">
<!ENTITY min-xml-parser-ver "any">
<!ENTITY min-mime-parser-ver "any">

]>


<!-- Coding standards for this document 

*  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.tldp.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.

-->

<book id="index">

<!-- Header -->

  <bookinfo>
    <title>The Bugzilla Guide</title>

    <authorgroup>
      <author>
        <firstname>Matthew</firstname>
        <othername>P.</othername>
        <surname>Barnson</surname>
      </author>
      <author>
        <firstname>The</firstname>
        <othername>Bugzilla</othername>
        <surname>Team</surname>
      </author>
    </authorgroup>

    <pubdate>&bz-date;</pubdate>

    <abstract>
      <para>
	      This is the documentation for Bugzilla, the mozilla.org
	      bug-tracking system.
	      Bugzilla is an enterprise-class piece of software
	      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 SGML diffs, attached
        to a bug filed in
        <ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation">mozilla.org's Bugzilla</ulink>.
      </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>
      ]]>
    </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>

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

<!-- Introduction -->
&introduction;

<!-- Using Bugzilla -->
&using;

<!-- Installing Bugzilla -->
&installation;

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

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

<!-- Appendix: The Database Schema -->
&database;

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

<!-- Appendix: Major Bugzilla Variants -->
&variants;

<!-- Glossary -->
&glossary;

<!-- Index -->
&index;


</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-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
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.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->