diff options
| -rw-r--r-- | docs/en/xml/administration.xml | 97 | ||||
| -rw-r--r-- | docs/en/xml/using.xml | 432 |
2 files changed, 344 insertions, 185 deletions
diff --git a/docs/en/xml/administration.xml b/docs/en/xml/administration.xml index 111fc8bad..844053996 100644 --- a/docs/en/xml/administration.xml +++ b/docs/en/xml/administration.xml @@ -2425,37 +2425,72 @@ ReadOnly: ENTRY, NA/NA, CANEDIT <emphasis>Type:</emphasis> The type of field to create. There are several types available: - <simplelist> - <member> - Bug ID: A field where you can enter the ID of another bug from - the same Bugzilla installation. To point to a bug in a remote - installation, use the See Also field instead. - </member> - <member> - Large Text Box: A multiple line box for entering free text. - </member> - <member> - Free Text: A single line box for entering free text. - </member> - <member> - Multiple-Selection Box: A list box where multiple options - can be selected. After creating this field, it must be edited - to add the selection options. See - <xref linkend="edit-values-list" /> for information about - editing legal values. - </member> - <member> - Drop Down: A list box where only one option can be selected. - After creating this field, it must be edited to add the - selection options. See - <xref linkend="edit-values-list" /> for information about - editing legal values. - </member> - <member> - Date/Time: A date field. This field appears with a - calendar widget for choosing the date. - </member> - </simplelist> + <variablelist> + <varlistentry> + <term>Bug ID:</term> + <listitem> + <para> + A field where you can enter the ID of another bug from + the same Bugzilla installation. To point to a bug in a remote + installation, use the See Also field instead. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Large Text Box:</term> + <listitem> + <para> + A multiple line box for entering free text. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Free Text:</term> + <listitem> + <para> + A single line box for entering free text. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Multiple-Selection Box:</term> + <listitem> + <para> + A list box where multiple options + can be selected. After creating this field, it must be edited + to add the selection options. See + <xref linkend="edit-values-list" /> for information about + editing legal values. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Drop Down:</term> + <listitem> + <para> + A list box where only one option can be selected. + After creating this field, it must be edited to add the + selection options. See + <xref linkend="edit-values-list" /> for information about + editing legal values. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Date/Time:</term> + <listitem> + <para> + A date field. This field appears with a + calendar widget for choosing the date. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </listitem> diff --git a/docs/en/xml/using.xml b/docs/en/xml/using.xml index bed776dd3..53766ef34 100644 --- a/docs/en/xml/using.xml +++ b/docs/en/xml/using.xml @@ -125,58 +125,108 @@ <orderedlist> <listitem> <para> - <emphasis>Product and Component</emphasis>: - Bugs are divided up by Product and Component, with a Product - having one or more Components in it. For example, - bugzilla.mozilla.org's "Bugzilla" Product is composed of several - Components: - <simplelist> - <member> - <emphasis>Administration:</emphasis> - Administration of a Bugzilla installation.</member> - - <member> - <emphasis>Bugzilla-General:</emphasis> - Anything that doesn't fit in the other components, or spans - multiple components.</member> - - <member> - <emphasis>Creating/Changing Bugs:</emphasis> - Creating, changing, and viewing bugs.</member> - - <member> - <emphasis>Documentation:</emphasis> - The Bugzilla documentation, including The Bugzilla Guide.</member> - - <member> - <emphasis>Email:</emphasis> - Anything to do with email sent by Bugzilla.</member> - - <member> - <emphasis>Installation:</emphasis> - The installation process of Bugzilla.</member> - - <member> - <emphasis>Query/Buglist:</emphasis> - Anything to do with searching for bugs and viewing the - buglists.</member> - - <member> - <emphasis>Reporting/Charting:</emphasis> - Getting reports from Bugzilla.</member> - - <member> - <emphasis>User Accounts:</emphasis> - Anything about managing a user account from the user's perspective. - Saved queries, creating accounts, changing passwords, logging in, - etc.</member> - - <member> - <emphasis>User Interface:</emphasis> - General issues having to do with the user interface cosmetics (not - functionality) including cosmetic issues, HTML templates, - etc.</member> - </simplelist> + <emphasis>Product and Component</emphasis>: + Bugs are divided up by Product and Component, with a Product + having one or more Components in it. For example, + bugzilla.mozilla.org's "Bugzilla" Product is composed of several + Components: + <variablelist> + <varlistentry> + <term>Administration:</term> + <listitem> + <para> + Administration of a Bugzilla installation. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Bugzilla-General:</term> + <listitem> + <para> + Anything that doesn't fit in the other components, or spans + multiple components. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Creating/Changing Bugs:</term> + <listitem> + <para> + Creating, changing, and viewing bugs. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Documentation:</term> + <listitem> + <para> + The Bugzilla documentation, including The Bugzilla Guide. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Email:</term> + <listitem> + <para> + Anything to do with email sent by Bugzilla. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Installation:</term> + <listitem> + <para> + The installation process of Bugzilla. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Query/Buglist:</term> + <listitem> + <para> + Anything to do with searching for bugs and viewing the + buglists. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Reporting/Charting:</term> + <listitem> + <para> + Getting reports from Bugzilla. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>User Accounts:</term> + <listitem> + <para> + Anything about managing a user account from the user's perspective. + Saved queries, creating accounts, changing passwords, logging in, + etc. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>User Interface:</term> + <listitem> + <para> + General issues having to do with the user interface cosmetics (not + functionality) including cosmetic issues, HTML templates, + etc. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </listitem> @@ -290,41 +340,76 @@ This form can be used for time tracking. To use this feature, you have to be blessed group membership specified by the <quote>timetrackinggroup</quote> parameter. - <simplelist> - <member> - <emphasis>Orig. Est.:</emphasis> - This field shows the original estimated time.</member> - - <member> - <emphasis>Current Est.:</emphasis> - This field shows the current estimated time. - This number is calculated from <quote>Hours Worked</quote> - and <quote>Hours Left</quote>.</member> - - <member> - <emphasis>Hours Worked:</emphasis> - This field shows the number of hours worked.</member> - - <member> - <emphasis>Hours Left:</emphasis> - This field shows the <quote>Current Est.</quote> - - <quote>Hours Worked</quote>. - This value + <quote>Hours Worked</quote> will become the - new Current Est.</member> - - <member> - <emphasis>%Complete:</emphasis> - This field shows what percentage of the task is complete.</member> - - <member> - <emphasis>Gain:</emphasis> - This field shows the number of hours that the bug is ahead of the - <quote>Orig. Est.</quote>.</member> - - <member> - <emphasis>Deadline:</emphasis> - This field shows the deadline for this bug.</member> - </simplelist> + <variablelist> + <varlistentry> + <term>Orig. Est.:</term> + <listitem> + <para> + This field shows the original estimated time. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Current Est.:</term> + <listitem> + <para> + This field shows the current estimated time. + This number is calculated from <quote>Hours Worked</quote> + and <quote>Hours Left</quote>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Hours Worked:</term> + <listitem> + <para> + This field shows the number of hours worked. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Hours Left:</term> + <listitem> + <para> + This field shows the <quote>Current Est.</quote> - + <quote>Hours Worked</quote>. + This value + <quote>Hours Worked</quote> will become the + new Current Est. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>%Complete:</term> + <listitem> + <para> + This field shows what percentage of the task is complete. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Gain:</term> + <listitem> + <para> + This field shows the number of hours that the bug is ahead of the + <quote>Orig. Est.</quote>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Deadline:</term> + <listitem> + <para> + This field shows the deadline for this bug. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </listitem> @@ -591,73 +676,112 @@ <para>The format of the list is configurable. For example, it can be sorted by clicking the column headings. Other useful features can be accessed using the links at the bottom of the list: - <simplelist> - <member> - <emphasis>Long Format:</emphasis> - - this gives you a large page with a non-editable summary of the fields - of each bug.</member> - - <member> - <emphasis>XML:</emphasis> - - get the buglist in the XML format.</member> - - <member> - <emphasis>CSV:</emphasis> - - get the buglist as comma-separated values, for import into e.g. - a spreadsheet.</member> - - <member> - <emphasis>Feed:</emphasis> - - get the buglist as an Atom feed. Copy this link into your - favorite feed reader. If you are using Firefox, you can also - save the list as a live bookmark by clicking the live bookmark - icon in the status bar. To limit the number of bugs in the feed, - add a limit=n parameter to the URL.</member> - - <member> - <emphasis>iCalendar:</emphasis> - - Get the buglist as an iCalendar file. Each bug is represented as a - to-do item in the imported calendar.</member> - - <member> - <emphasis>Change Columns:</emphasis> - - change the bug attributes which appear in the list.</member> - - <member> - <emphasis>Change several bugs at once:</emphasis> - - If your account is sufficiently empowered, and more than one bug - appear in the bug list, this link is displayed which lets you make - the same change to all the bugs in the list - for example, changing - their assignee.</member> - - <member> - <emphasis>Send mail to bug assignees:</emphasis> - - If more than one bug appear in the bug list and there are at least - two distinct bug assignees, this links is displayed which lets you - easily send a mail to the assignees of all bugs on the list.</member> - - <member> - <emphasis>Edit Search:</emphasis> - - If you didn't get exactly the results you were looking for, you can - return to the Query page through this link and make small revisions - to the query you just made so you get more accurate results.</member> - - <member> - <emphasis>Remember Search As:</emphasis> - - You can give a search a name and remember it; a link will appear - in your page footer giving you quick access to run it again later. - </member> - </simplelist> + <variablelist> + <varlistentry> + <term>Long Format:</term> + <listitem> + <para> + this gives you a large page with a non-editable summary of the fields + of each bug. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>XML:</term> + <listitem> + <para> + get the buglist in the XML format. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>CSV:</term> + <listitem> + <para> + get the buglist as comma-separated values, for import into e.g. + a spreadsheet. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Feed:</term> + <listitem> + <para> + get the buglist as an Atom feed. Copy this link into your + favorite feed reader. If you are using Firefox, you can also + save the list as a live bookmark by clicking the live bookmark + icon in the status bar. To limit the number of bugs in the feed, + add a limit=n parameter to the URL. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>iCalendar:</term> + <listitem> + <para> + Get the buglist as an iCalendar file. Each bug is represented as a + to-do item in the imported calendar. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Change Columns:</term> + <listitem> + <para> + change the bug attributes which appear in the list. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Change several bugs at once:</term> + <listitem> + <para> + If your account is sufficiently empowered, and more than one bug + appear in the bug list, this link is displayed which lets you make + the same change to all the bugs in the list - for example, changing + their assignee. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Send mail to bug assignees:</term> + <listitem> + <para> + If more than one bug appear in the bug list and there are at least + two distinct bug assignees, this links is displayed which lets you + easily send a mail to the assignees of all bugs on the list. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Edit Search:</term> + <listitem> + <para> + If you didn't get exactly the results you were looking for, you can + return to the Query page through this link and make small revisions + to the query you just made so you get more accurate results. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Remember Search As:</term> + <listitem> + <para> + You can give a search a name and remember it; a link will appear + in your page footer giving you quick access to run it again later. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </section> |