From 472a5007316404da323e1b5193255fbda5b93611 Mon Sep 17 00:00:00 2001 From: "jocuri%softhome.net" <> Date: Mon, 8 Nov 2004 08:21:27 +0000 Subject: Documentation patch: clean-up identation after commiting patch for bug 198020: Bugzilla Guide contains no admin docs for flags. --- docs/xml/administration.xml | 244 ++++++++++++++++++++++---------------------- 1 file changed, 123 insertions(+), 121 deletions(-) (limited to 'docs') diff --git a/docs/xml/administration.xml b/docs/xml/administration.xml index 2377d8366..50c287915 100644 --- a/docs/xml/administration.xml +++ b/docs/xml/administration.xml @@ -632,8 +632,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 +664,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 +680,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 +815,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 +825,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 +904,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 -- cgit v1.2.3-24-g4f1b