Documentation update; added docs/sgml, docs/html, docs/txt.

No text version of The Bugzilla Guide availabe yet, however.

1 files changed, 108 insertions, 0 deletions

diff --git a/docs/sgml/glossary.sgml b/docs/sgml/glossary.sgml
new file mode 100644
index 000000000..32525f737
--- /dev/null
+++ b/docs/sgml/glossary.sgml
@@ -0,0 +1,108 @@
+<!-- <!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
+
+<glossary id="glossary">
+
+  <glossdiv id="gloss_a">
+    <title>A</title>
+    <glossentry>
+      <glossterm>There are no entries for A</glossterm>
+      <glossdef>
+	<para></para>
+      </glossdef>
+    </glossentry>
+  </glossdiv>
+
+  <glossdiv id="gloss_b">
+    <title>B</title>
+    <glossentry>
+      <glossterm>Bug</glossterm>
+      <glossdef>
+	<para>A "Bug" in Bugzilla refers to an issue entered into the database which has an associated number, assignments, comments, etc.  Many also refer to a "Ticket" or "Issue"; in this context, they are synonymous.</para>
+      </glossdef>
+    </glossentry>
+
+    <glossentry>
+      <glossterm>Bug Number</glossterm>
+      <glossdef>
+	<para>Each Bugzilla Bug is assigned a number that uniquely identifies that Bug.  The Bug associated with a Bug Number can be pulled up via a query, or easily from the very front page by typing the number in the "Find" box.</para>
+      </glossdef>
+    </glossentry>
+
+    <glossentry>
+      <glossterm>Bug Life Cycle</glossterm>
+      <glossdef>
+      <para>A Bug has stages through which it must pass before becoming a "closed bug", including acceptance, resolution, and verification.  The "Bug Life Cycle" is moderately flexible according to the needs of the organization using it, though.</para>
+      </glossdef>
+    </glossentry>
+  </glossdiv>
+
+  <glossdiv id="gloss_i">
+    <title>I</title>
+    <glossentry id="gloss_infiniteloop">
+      <glossterm>Infinite Loop</glossterm>
+      <glosssee otherterm="gloss_recursion">
+    </glossentry>
+  </glossdiv>
+
+<glossdiv id="gloss_p">
+    <title>P</title>
+    <glossentry>
+      <glossterm id="gloss_product">Product</glossterm>
+      <glossdef>
+	<para>A Product is a broad category of types of bugs.  In general, there are several Components to a Product.  A Product also defines a default Group (used for Bug Security) for all bugs entered into components beneath it.</para>
+	<example>
+	  <title>A Sample Product</title>
+	  <para>A company sells a software product called "X".  They also maintain some older software called "Y", and have a secret project "Z".  An effective use of Products might be to create Products "X", "Y", and "Z", each with Components "User Interface", "Database", and "Business Logic".  They might also change group permissions so that only those people who are members of Group "Z" can see components and bugs under Product "Z".</para>
+	</example>
+      </glossdef>
+    </glossentry>
+  </glossdiv>
+
+  <glossdiv id="gloss_q">
+    <title>Q</title>
+    <glossentry>
+      <glossterm>Q/A</glossterm>
+      <glossdef>
+	<para>"Q/A" is short for "Quality Assurance".  In most large software development organizations, there is a team devoted to ensuring the product meets minimum standards before shipping.  This team will also generally want to track the progress of bugs over their life cycle, thus the need for the "Q/A Contact" field in a Bug.</para>
+      </glossdef>
+    </glossentry>
+  </glossdiv>
+
+<glossdiv id="gloss_r">
+    <title>R</title>
+    <glossentry>
+      <glossterm id="gloss_recursion">Recursion</glossterm>
+      <glosssee otherterm="gloss_infiniteloop">
+    </glossentry>
+  </glossdiv>
+
+<glossdiv id="gloss_z">
+    <title>Z</title>
+    <glossentry>
+      <glossterm>Zarro Boogs Found</glossterm>
+      <glossdef>
+	<para>This is the cryptic response sent by Bugzilla when a query returned no results.  It is just a goofy way of saying "Zero Bugs Found".</para>
+      </glossdef>
+    </glossentry>
+</glossdiv>
+
+</glossary>
+
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-namecase-general:t
+sgml-general-insert-case:lower
+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
+End:
+-->