From fe1c6cfb9344690617b4d24b34cc9e861881b7ff Mon Sep 17 00:00:00 2001 From: "jocuri%softhome.net" <> Date: Fri, 4 Apr 2008 11:47:31 +0000 Subject: Documentation patch for bug 268613 - Update paragraph related to email prefs tab; patch by Shane H. W. Travis , r=vladd. --- docs/en/xml/administration.xml | 288 ++++++++++++++-------------- docs/en/xml/using.xml | 424 +---------------------------------------- 2 files changed, 159 insertions(+), 553 deletions(-) (limited to 'docs') diff --git a/docs/en/xml/administration.xml b/docs/en/xml/administration.xml index 2377d8366..0a9387a05 100644 --- a/docs/en/xml/administration.xml +++ b/docs/en/xml/administration.xml @@ -313,25 +313,35 @@ - Disable Text: - If you type anything in this box, including just a space, the - user is prevented from logging in, or making any changes to - bugs via the web interface. - The HTML you type in this box is presented to the user when - they attempt to perform these actions, and should explain - why the account was disabled. - - Don't disable all the administrator accounts! - - + Disable Text: + If you type anything in this box, including just a space, the + user is prevented from logging in, or making any changes to + bugs via the web interface. + The HTML you type in this box is presented to the user when + they attempt to perform these actions, and should explain + why the account was disabled. + + + Users with disabled accounts will continue to receive + mail from Bugzilla; furthermore, they will not be able + to log in themselves to change their own preferences and + stop it. If you want an account (disabled or active) to + stop receiving mail, add the account name (one account + per line) to the file data/nomail. + - The user can still submit bugs via - the e-mail gateway, if you set it up, even if the disabled text - field is filled in. The e-mail gateway should - not - be enabled for secure installations of Bugzilla. + + Even users whose accounts have been disabled can still + submit bugs via the e-mail gateway, if one exists. + The e-mail gateway should not be + enabled for secure installations of Bugzilla. + - + + + Don't disable all the administrator accounts! + + @@ -632,8 +642,8 @@ If the manager thinks the feature should go into the product - before version 2.0 can be released, he sets the flag to - +. Otherwise, he sets it to -. + before version 2.0 can be released, he sets the flag to + +. Otherwise, he sets it to -. @@ -664,14 +674,15 @@ - - The status has been set negatively. (The question has been answered no.) + The status has been set negatively. (The question has been answered no.) + - The status has been set positively. (The question has been answered yes.) - + The status has been set positively. + (The question has been answered yes.) + @@ -679,7 +690,7 @@ Actually, there's a fourth value a flag can have -- unset -- which shows up as a blank space. This just means that nobody has expressed an opinion (or asked - someone else to express an opinion) about this bug or attachment. + someone else to express an opinion) about this bug or attachment. @@ -814,7 +825,7 @@ This describes the flag in more detail. At present, this doesn't whos up anywhere helpful; ideally, it would be nice to have - it show up as a tooltip. This field + it show up as a tooltip. This field can be as long as you like, and can contain any character you want. @@ -824,58 +835,58 @@ Default behaviour for a newly-created flag is to appear on - products and all components, which is why __Any__:__Any__ - is already entered in the Inclusions box. - If this is not your desired behaviour, you must either set some - exclusions (for products on which you don't want the flag to appear), - or you must remove __Any__:__Any__ from the Inclusions box - and define products/components specifically for this flag. + products and all components, which is why __Any__:__Any__ + is already entered in the Inclusions box. + If this is not your desired behaviour, you must either set some + exclusions (for products on which you don't want the flag to appear), + or you must remove __Any__:__Any__ from the Inclusions box + and define products/components specifically for this flag. To create an Inclusion, select a Product from the top drop-down box. - You may also select a specific component from the bottom drop-down box. - (Setting __Any__ for Product translates to, - all the products in this Bugzilla. - Selecting __Any__ in the Component field means + You may also select a specific component from the bottom drop-down box. + (Setting __Any__ for Product translates to, + all the products in this Bugzilla. + Selecting __Any__ in the Component field means all components in the selected product.) - Selections made, press Include, and your - Product/Component pairing will show up in the Inclusions box on the right. - + Selections made, press Include, and your + Product/Component pairing will show up in the Inclusions box on the right. + To create an Exclusion, the process is the same; select a Product from the - top drop-down box, select a specific component if you want one, and press - Exclude. The Product/Component pairing will show up in the - Exclusions box on the right. - + top drop-down box, select a specific component if you want one, and press + Exclude. The Product/Component pairing will show up in the + Exclusions box on the right. + - This flag will and can be set for any - products/components that appearing in the Inclusions box - (or which fall under the appropriate __Any__). - This flag will not appear (and therefore cannot be set) on - any products appearing in the Exclusions box. - IMPORTANT: Exclusions override inclusions. + This flag will and can be set for any + products/components that appearing in the Inclusions box + (or which fall under the appropriate __Any__). + This flag will not appear (and therefore cannot be set) on + any products appearing in the Exclusions box. + IMPORTANT: Exclusions override inclusions. - - You may select a Product without selecting a specific Component, - but it is illegal to select a Component without a Product, or to select a - Component that does not belong to the named Product. Doing so as of - this writing (2.18rc3) will raise an error... even if all your products - have a component by that name. + + You may select a Product without selecting a specific Component, + but it is illegal to select a Component without a Product, or to select a + Component that does not belong to the named Product. Doing so as of + this writing (2.18rc3) will raise an error... even if all your products + have a component by that name. Example: Let's say you have a product called Jet Plane that has thousands of components. You want - to be able to ask if a problem should be fixed in the next model of - plane you release. We'll call the flag fixInNext. - But, there's one component in Jet Plane, - called Pilot. It doesn't make sense to release a - new pilot, so you don't want to have the flag show up in that component. - So, you include Jet Plane:__Any__ and you exclude - Jet Plane:Pilot. + to be able to ask if a problem should be fixed in the next model of + plane you release. We'll call the flag fixInNext. + But, there's one component in Jet Plane, + called Pilot. It doesn't make sense to release a + new pilot, so you don't want to have the flag show up in that component. + So, you include Jet Plane:__Any__ and you exclude + Jet Plane:Pilot. @@ -903,94 +914,95 @@ Bugzilla database, but stop users from setting any new flags of this type. To do this, uncheck active. Deactivated flags will still show up in the UI if they are ?, +, or -, but they - may only be cleared (unset), and cannot be changed to a new value. + may only be cleared (unset), and cannot be changed to a new value. Once a deactivated flag is cleared, it will completely disappear from a bug/attachment, and cannot be set again. -
- Requestable - - New flags are, by default, requestable, meaning that they - offer users the ? option, as well as + and -. - To remove the ? option, uncheck requestable. - -
- -
- CC List - - - If you want certain users to be notified every time this flag is - set to ?, -, +, or unset, add them here. This is a comma-separated - list of email addresses that need not be restricted to Bugzilla usernames.. - -
- -
- Specifically Requestable - - By default this box is checked for new flags, meaning that users may make - flag requests of specific individuals. Unchecking this box will remove the - text box next to a flag; if it is still requestable, then requests may - only be made to the wind. Removing this after specific - requests have been made will not remove those requests; that data will - stay in the database (though it will no longer appear to the user). - -
- -
- Multiplicable - - Any flag with Multiplicable set (default for new flags is 'on') - may be set more than once. After being set once, an unset flag - of the same type will appear below it with addl. (short for - additional) before the name. There is no limit to the number of - times a Multiplicable flags may be set on the same bug/attachment. - -
- - - -
- Deleting a Flag +
+ Requestable + + New flags are, by default, requestable, meaning that they + offer users the ? option, as well as + + and -. + To remove the ? option, uncheck requestable. + +
- - When you are at the Administer Flag Types screen, - you will be presented with a list of Bug flags and a list of Attachment - Flags. - - - To delete a flag, click on the Delete link next to - the flag description. - - - - Once you delete a flag, it is gone from - your Bugzilla. All the data for that flag will be deleted. - Everywhere that flag was set, it will disappear, - and you cannot get that data back. If you want to keep flag data, - but don't want anybody to set any new flags or change current flags, - unset active in the flag Edit form. - - -
+
+ CC List -
- Editing a Flag - - To edit a flag's properties, just click on the Edit - link next to the flag's description. That will take you to the same - form described in the Creating a Flag section. - -
+ + If you want certain users to be notified every time this flag is + set to ?, -, +, or unset, add them here. This is a comma-separated + list of email addresses that need not be restricted to Bugzilla usernames.. + +
+ +
+ Specifically Requestable + + By default this box is checked for new flags, meaning that users may make + flag requests of specific individuals. Unchecking this box will remove the + text box next to a flag; if it is still requestable, then requests may + only be made to the wind. Removing this after specific + requests have been made will not remove those requests; that data will + stay in the database (though it will no longer appear to the user). + +
+ +
+ Multiplicable + + Any flag with Multiplicable set (default for new flags is 'on') + may be set more than once. After being set once, an unset flag + of the same type will appear below it with addl. (short for + additional) before the name. There is no limit to the number of + times a Multiplicable flags may be set on the same bug/attachment. + +
+ + + +
+ Deleting a Flag + + + When you are at the Administer Flag Types screen, + you will be presented with a list of Bug flags and a list of Attachment + Flags. + + + To delete a flag, click on the Delete link next to + the flag description. + + + + Once you delete a flag, it is gone from + your Bugzilla. All the data for that flag will be deleted. + Everywhere that flag was set, it will disappear, + and you cannot get that data back. If you want to keep flag data, + but don't want anybody to set any new flags or change current flags, + unset active in the flag Edit form. + + +
+ +
+ Editing a Flag + + To edit a flag's properties, just click on the Edit + link next to the flag's description. That will take you to the same + form described in the Creating a Flag section. + +
- + - + - +
Voting diff --git a/docs/en/xml/using.xml b/docs/en/xml/using.xml index 720f461e9..e00ab2bd7 100644 --- a/docs/en/xml/using.xml +++ b/docs/en/xml/using.xml @@ -234,12 +234,8 @@ Attachments: - You can attach files (e.g. testcases or patches) to bugs. If there - are any attachments, they are listed in this section. Attachments are - normally stored in the Bugzilla database, unless they are marked as - Big Files, which are stored directly on disk and (unlike attachments - kept in the database) may be deleted at some future time. - + You can attach files (e.g. testcases or patches) to bugs. If there + are any attachments, they are listed in this section. @@ -265,28 +261,6 @@
-
- Life Cycle of a Bug - - - The life cycle, also known as work flow, of a bug is currently hardcoded - into Bugzilla. contains a graphical - repsentation of this life cycle. If you wish to customize this image for - your site, the diagram file - is available in Dia's - native XML format. - - -
- Lifecycle of a Bugzilla Bug - - - - - -
-
-
Searching for Bugs @@ -304,144 +278,8 @@ Once you've run a search, you can save it as a Saved Search, which appears in the page footer. -
- Boolean Charts - - Highly advanced querying is done using Boolean Charts. - - - The boolean charts further restrict the set of results - returned by a query. It is possible to search for bugs - based on elaborate combinations of critera. - - - The simplest boolean searches have only one term. These searches - permit the selected left field - to be compared using a - selectable operator to a - specified value. - Using the "And," "Or," and "Add Another Boolean Chart" buttons, - additonal terms can be included in the query, further - altering the list of bugs returned by the query. - - - There are three fields in each row of a boolean search. - - - - - Field: - the items being searched - - - - - Operator: - the comparison operator - - - - - Value: - the value to which the field is being compared - - - -
- Pronoun Substitution - - Sometimes, a query needs to compare a field containing - a user's ID (such as ReportedBy) with - a user's ID (such as the user running the query or the user - to whom each bug is assigned). When the operator is either - "equals" or "notequals", the value can be "%reporter%", - "%assignee%", "%qacontact%", or "%user%." The user pronoun - referes to the user who is executing the query or, in the case - of whining reports, the user who will be the recipient - of the report. The reporter, assignee, and qacontact - pronouns refer to the corresponding fields in the bug. - -
-
- Negation - - At first glance, negation seems redundant. Rather than - searching for -
- - NOT("summary" "contains the string" "foo"), - -
- one could search for -
- - ("summary" "does not contain the string" "foo"). - -
- However, the search -
- - ("CC" "does not contain the string" "@mozilla.org") - -
- would find every bug where anyone on the CC list did not contain - "@mozilla.org" while -
- - NOT("CC" "contains the string" "@mozilla.org") - -
- would find every bug where there was nobody on the CC list who - did contain the string. Similarly, the use of negation also permits - complex expressions to be built using terms OR'd together and then - negated. Negation permits queries such as -
- - NOT(("product" "equals" "update") OR - ("component" "equals" "Documentation")) - -
- to find bugs that are neither - in the update product or in the documentation component or -
- - NOT(("commenter" "equals" "%assignee%") OR - ("component" "equals" "Documentation")) - -
- to find non-documentation - bugs on which the assignee has never commented. - -
-
- Multiple Charts - - The terms within a single row of a boolean chart are all - constraints on a single piece of data. If you are looking for - a bug that has two different people cc'd on it, then you need - to use two boolean charts. A search for -
- - ("cc" "contains the string" "foo@") AND - ("cc" "contains the string" "@mozilla.org") - -
- would return only bugs with "foo@mozilla.org" on the cc list. - If you wanted bugs where there is someone on the cc list - containing "foo@" and someone else containing "@mozilla.org", - then you would need two boolean charts. -
- - First chart: ("cc" "contains the string" "foo@") - - - Second chart: ("cc" "contains the string" "@mozilla.org") - -
- The bugs listed will be only the bugs where ALL the charts are true. - -
-
+ Highly advanced querying is done using Boolean Charts. See the + Boolean Charts help link on the Search page for more information.
@@ -465,22 +303,7 @@ get the buglist as comma-separated values, for import into e.g. a spreadsheet. - - - RSS - - 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. - - - iCalendar - - Get the buglist as an iCalendar file. Each bug is represented as a - to-do item in the imported calendar. - + Change Columns: @@ -491,12 +314,12 @@ If your account is sufficiently empowered, you can make the same change to all the bugs in the list - for example, changing their - assignee. + owner. - Send mail to bug assignees: + Send mail to bug owners: - Sends mail to the assignees of all bugs on the list. + Sends mail to the owners of all bugs on the list. Edit Search: @@ -513,17 +336,6 @@ - - - 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). -
@@ -778,17 +590,7 @@ Content-Type (e.g. application/xhtml+xml), you can override this using a 'content-type' parameter on the URL, e.g. &content-type=text/plain. - - - - If you have a really large attachment, something that does not need to - be recorded forever (as most attachments are), you can mark your - attachment as a Big File, Assuming the administrator of the - installation has enabled this feature. Big Files are stored directly on - disk instead of in the database, and can be deleted when it is no longer - needed. The maximum size of a Big File is normally larger than the - maximum size of a regular attachment. - +
@@ -1174,214 +976,6 @@ -
- Whining - - - Whining is a feature in Bugzilla that can regularly annoy users at - specified times. Using this feature, users can execute saved searches - at specific times (i.e. the 15th of the month at midnight) or at - regular intervals (i.e. every 15 minutes on Sundays). The results of the - searches are sent to the user, either as a single email or as one email - per bug, along with some descriptive text. - - - - - Throughout this section it will be assumed that all users are members - of the bz_canusewhines group, membership in which is required in order - to use the Whining system. You can easily make all users members of - the bz_canusewhines group by setting the User RegExp to ".*" (without - the quotes). - - - - Also worth noting is the bz_canusewhineatothers group. Members of this - group can create whines for any user or group in Bugzilla using a - extended form of the whining interface. Features only available to - members of the bz_canusewhineatothers group will be noted in the - appropriate places. - - - - - - For whining to work, a special Perl script must be executed at regular - intervals. More information on this is available in - . - - - - - - This section does not cover the whineatnews.pl script. See - for more information on - The Whining Cron. - - - -
- The Event - - - The whining system defines an "Event" as one or more queries being - executed at regular intervals, with the results of said queries (if - there are any) being emailed to the user. Events are created by - clicking on the "Add new event" button. - - - - Once a new event is created, the first thing to set is the "Email - subject line". The contents of this field will be used in the subject - line of every email generated by this event. In addition to setting a - subject, space is provided to enter some descriptive text that will be - included at the top of each message (to help you in understanding why - you received the email in the first place). - - - - The next step is to specify when the Event is to be run (the Schedule) - and what searches are to be performed (the Queries). - - -
- -
- Whining Schedule - - - Each whining event is associated with zero or more schedules. A - schedule is used to specify when the query (specified below) is to be - run. A new event starts out with no schedules (which means it will - never run, as it is not scheduled to run). To add a schedule, press - the "Add a new schedule" button. - - - - Each schedule includes an interval, which you use to tell Bugzilla - when the event should be run. An event can be run on certain days of - the week, certain days of the month, during weekdays (defined as - Monday through Friday), or every day. - - - - - Be careful if you set your event to run on the 29th, 30th, or 31st of - the month, as your event may not run exactly when expected. If you - want your event to run on the last day of the month, select "Last day - of the month" as the interval. - - - - - Once you have specified the day(s) on which the event is to be run, you - should now specify the time at which the event is to be run. You can - have the event run at a certain hour on the specified day(s), or - every hour, half-hour, or quarter-hour on the specified day(s). - - - - If a single schedule does not execute an event as many times as you - would want, you can create another schedule for the same event. For - example, if you want to run an event on days whose numbers are - divisible by seven, you would need to add four schedules to the event, - setting the schedules to run on the 7th, 14th, 21st, and 28th (one day - per schedule) at whatever time (or times) you choose. - - - - - If you are a member of the bz_canusewhineatothers group, then you - will be presented with another option: "Mail to". Using this you - can control who will receive the emails generated by this event. You - can choose to send the emails to a single user (identified by email - address) or a single group (identified by group name). To send to - multiple users or groups, create a new schedule for each additional - user/group. - - -
- -
- Whining Queries - - - Each whining event is associated with zero or more queries. A query is - a saved search that is executed on the schedule specified (see above). - You start out with zero queries attached to the event (which means that - the event will not run, as there will never be any results to return). - To add a query, press the "Add a new query" button. - - - - The first field to examine in your new query is the Sort field. Queries - are executed, and results returned, in the order specified by the Sort - field. Queries with lower Sort values will run before queries with - higher Sort values. - - - - The next field to examine is the Search field. This is where you - choose the actual search that is to be run. Instead of defining search - parameters here, you are asked to choose from the list of saved - searches (the same list that appears at the bottom of every Bugzilla - page). You are only allowed to choose from searches that you have - saved yourself (the default saved search, "My Bugs", is not a valid - choice). If you do not have any saved searches, you can take this - opportunity to create one (see ). - - - - - When running queries, the whining system acts as if you are the user - executing the query. This means that the whining system will ignore - bugs that match your query, but that you can not access. - - - - - Once you have chosen the saved search to be executed, give the query a - descriptive title. This title will appear in the email, above the - results of the query. If you choose "One message per bug", the query - title will appear at the top of each email that contains a bug matching - your query. - - - - Finally, decide if the results of the query should be sent in a single - email, or if each bug should appear in its own email. - - - - - Think carefully before checking the "One message per bug" box. If - you create a query that matches thousands of bugs, you will receive - thousands of emails! - - -
- -
- Saving Your Changes - - - Once you have defined at least one schedule, and created at least one - query, go ahead and "Update/Commit". This will save your Event and make - it available for immediate execution. - - - - - If you ever feel like deleting your event, you may do so using the - "Remove Event" button in the upper-right corner of each Event. You - can also modify an existing event, so long as you "Update/Commit" - after completing your modifications. - - -
- -
-