From 065e048f952524f0fc99c98a2153373d647f2270 Mon Sep 17 00:00:00 2001
From: "lpsolit%gmail.com" <>
Date: Fri, 4 Apr 2008 11:48:03 +0000
Subject: Docs patch for bug 313020: Implement the ability to add and remove
individual bugs to/from saved searches - Patch by me, r=Colin
---
docs/en/xml/using.xml | 199 +++++++++++++++++++++++++++++---------------------
1 file changed, 116 insertions(+), 83 deletions(-)
(limited to 'docs/en/xml/using.xml')
diff --git a/docs/en/xml/using.xml b/docs/en/xml/using.xml
index abba39563..1c7ba8b33 100644
--- a/docs/en/xml/using.xml
+++ b/docs/en/xml/using.xml
@@ -545,88 +545,140 @@
-
-
- Bug Lists
+
+ Quicksearch
- If you run a search, a list of matching bugs will be returned.
-
+
+ Quicksearch is a single-text-box query tool which uses
+ metacharacters to indicate what is to be searched. For example, typing
+ "foo|bar"
+ into Quicksearch would search for "foo" or "bar" in the
+ summary and status whiteboard of a bug; adding
+ ":BazProduct" would
+ search only in that product.
+ You can use it to find a bug by its number or its alias, too.
+
- 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:
-
-
- Long Format:
+
+ You'll find the Quicksearch box in Bugzilla's footer area.
+ On Bugzilla's front page, there is an additional
+ Help
+ link which details how to use it.
+
+
- this gives you a large page with a non-editable summary of the fields
- of each bug.
+
+ Bug Lists
-
- CSV:
+ If you run a search, a list of matching bugs will be returned.
+
- get the buglist as comma-separated values, for import into e.g.
- a spreadsheet.
-
-
- RSS
+ 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:
+
+
+ Long Format:
- get the buglist as an RSS 1.0 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.
+ this gives you a large page with a non-editable summary of the fields
+ of each bug.
-
- iCalendar
+
+ CSV:
- Get the buglist as an iCalendar file. Each bug is represented as a
- to-do item in the imported calendar.
-
-
- Change Columns:
+ get the buglist as comma-separated values, for import into e.g.
+ a spreadsheet.
- change the bug attributes which appear in the list.
+
+ Feed:
-
- Change several bugs at once:
+ 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.
- If your account is sufficiently empowered, you can make the same
- change to all the bugs in the list - for example, changing their
- assignee.
+
+ iCalendar:
-
- Send mail to bug assignees:
+ Get the buglist as an iCalendar file. Each bug is represented as a
+ to-do item in the imported calendar.
- Sends mail to the assignees of all bugs on the list.
+
+ Change Columns:
-
- Edit Search:
+ change the bug attributes which appear in the list.
- 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.
-
-
- Remember Search As:
+
+ Change several bugs at once:
- 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.
-
-
-
+ 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.
-
- If you would like to access the bug list from another program
- it is often useful to have the list returned in something other
- than HTML. By adding the ctype=type parameter into the bug list URL
- you can specify several alternate formats. The supported formats
- are: Comma Separated Values (ctype=csv), iCalendar (ctype=ics),
- RDF Site Summary (RSS) 1.0 (ctype=rss), ECMAScript, also known
- as JavaScript (ctype=js), and finally Resource Description Framework
- RDF/XML (ctype=rdf).
-
+
+ Send mail to bug assignees:
+
+ 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.
+
+
+ Edit Search:
+
+ 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.
+
+
+ Remember Search As:
+
+ 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.
+
+
+
+
+
+ If you would like to access the bug list from another program
+ it is often useful to have the list returned in something other
+ than HTML. By adding the ctype=type parameter into the bug list URL
+ you can specify several alternate formats. Besides the types described
+ above, the following formats are also supported: ECMAScript, also known
+ as JavaScript (ctype=js), and Resource Description Framework RDF/XML
+ (ctype=rdf).
+
+
+
+
+ Adding/removing individual bugs from bug lists
+
+ You can at any time add and remove individual bugs to a special type
+ of saved searches, known as lists of bugs
. The distinction
+ between both types is that saved searches, as described in the previous
+ section, are stored in the form of a list of matching criteria, while
+ a list of bugs is an enumerated list of bug numbers. As it is a simple
+ list of bug numbers, you can easily edit this list by either adding or
+ removing bugs from it. To enable this feature, you have to turn on the
+ Add individual bugs to saved searches
user preference,
+ see . This feature is disabled by
+ default.
+
+
+
+ This feature is useful when you want to keep track of several bugs, but
+ for different reasons. Instead of adding yourself to the CC list of all
+ these bugs and mixing all these reasons, you can now store these bugs in
+ different lists, e.g. Bugs I want to see fixed before the next
+ release
, Interesting bugs
, or Bugs I have
+ to think about
. One big advantage of this way to manage bug lists
+ is that you can easily add or remove bugs one by one, which is not
+ possible to do with saved searches without having to edit the search
+ criteria again.
+
+
-
- Quicksearch
-
- Quicksearch is a single-text-box query tool which uses
- metacharacters to indicate what is to be searched. For example, typing
- "foo|bar"
- into Quicksearch would search for "foo" or "bar" in the
- summary and status whiteboard of a bug; adding
- ":BazProduct" would
- search only in that product.
- You can use it to find a bug by its number or its alias, too.
-
-
- You'll find the Quicksearch box in Bugzilla's footer area.
- On Bugzilla's front page, there is an additional
- Help
- link which details how to use it.
-
-