From 683538cdef56ca59bd7f64ff7967d367f9e3e78d Mon Sep 17 00:00:00 2001 From: Robert Sesek Date: Mon, 25 Sep 2006 00:28:34 +0000 Subject: [PATCH] r1185: List formatting --- locale/en_US/manual-xml/admin.xml | 345 ++++++++++++++++++++---------- 1 file changed, 234 insertions(+), 111 deletions(-) diff --git a/locale/en_US/manual-xml/admin.xml b/locale/en_US/manual-xml/admin.xml index 0d2eb9a..a142835 100644 --- a/locale/en_US/manual-xml/admin.xml +++ b/locale/en_US/manual-xml/admin.xml @@ -134,20 +134,37 @@ - - Title: The name of the language that is to be displayed to users (if they can select it) and in the administration panel. - - Character Set: This character set often determines what symbols can be displayed on a page. English can be iso-8859-1 or utf-8, either value will work. By default, however, we have set it to be utf-8 because it will display most characters. If you are unsure, use utf-8. - - Direction: This determines the direction of the text on a page. For instance, English is read left-to-right, while Arabic is read right-to-left. - - Path to XML: This is the most important setting as it is the path to the translated strings. The default strings file is in ./includes/strings/english-us.strings.xml. We recommend placing additional string files in the includes/strings/ folder for continuity. - - Strings are stored in this XML file, however, they can be cached in the database (see the Debug Mode setting here) to increase speed. If you make changes to the XML file and you do not have debug mode enabled, you will need to reload the language. You can reload the language by clicking [Reload Language] in the language manager. - - User Selectable: If this enabled, users will be able to select this language in their options. If it is not, then it will be a private language and only viewable in the administration panel. - - Debug Mode: Debug mode is a special setting that allows strings to be read directly from the XML file on every page load. This is very useful for translators as they can see their results without having to reload the XML every time. If this setting is disabled, which it should be in a production environment, then the strings will be cached from the XML file in the database. This cache will need to be rebuilt (by clicking [Reload Language] in the language manager) if any changes made to the XML file are to be displayed. + + + + Title + The name of the language that is to be displayed to users (if they can select it) and in the administration panel. + + + Character Set + This character set often determines what symbols can be displayed on a page. English can be iso-8859-1 or utf-8, either value will work. By default, however, we have set it to be utf-8 because it will display most characters. If you are unsure, use utf-8. + + + Direction + This determines the direction of the text on a page. For instance, English is read left-to-right, while Arabic is read right-to-left. + + + Path to XML + + This is the most important setting as it is the path to the translated strings. The default strings file is in ./includes/strings/english-us.strings.xml. We recommend placing additional string files in the includes/strings/ folder for continuity. + + Strings are stored in this XML file, however, they can be cached in the database (see the Debug Mode setting here) to increase speed. If you make changes to the XML file and you do not have debug mode enabled, you will need to reload the language. You can reload the language by clicking [Reload Language] in the language manager. + + + + User Selectable + If this enabled, users will be able to select this language in their options. If it is not, then it will be a private language and only viewable in the administration panel. + + + Debug Mode + Debug mode is a special setting that allows strings to be read directly from the XML file on every page load. This is very useful for translators as they can see their results without having to reload the XML every time. If this setting is disabled, which it should be in a production environment, then the strings will be cached from the XML file in the database. This cache will need to be rebuilt (by clicking [Reload Language] in the language manager) if any changes made to the XML file are to be displayed. + + @@ -225,17 +242,26 @@
Priorities, Resolutions, Severities, and Statuses - Priorities, resolutions, severities, and statuses all follow the same pattern when adding or editing a new one and therefore they are grouped together in this document. - -The following is an explanation of each bug field: - -Priority: This is the field that represents the celerity with witch developers should work with to resolve the bug. - -Resolution: Usually this is the reason why a certain bug has been marked "closed." For instance, if a bug is not reproducible, then it would be closed and this field would probably be set to "Works for Me." - -Severity: The user defines this field based on how critical the bug is. Be careful to not confuse this with priority. An example is if a security issue (marked "Critical" in this field) was found in an old version of the software that did not affect the new version; while the severity may be critical, because the version is old, the priority would not need to be marked "High." - -Status: The state of the bug; this is usually set when the bug is triaged--marked as "Verified" or "Assigned" and then again when it is "Closed." It is usually changed to mark a major shift in the bug's occurrence in a product and version. + Priorities, resolutions, severities, and statuses all follow the same pattern when adding or editing a new one and therefore they are grouped together in this document. The following is an explanation of each bug field: + + + + Priority + This is the field that represents the celerity with witch developers should work with to resolve the bug. + + + Resolution + Usually this is the reason why a certain bug has been marked "closed." For instance, if a bug is not reproducible, then it would be closed and this field would probably be set to "Works for Me." + + + Severity + The user defines this field based on how critical the bug is. Be careful to not confuse this with priority. An example is if a security issue (marked "Critical" in this field) was found in an old version of the software that did not affect the new version; while the severity may be critical, because the version is old, the priority would not need to be marked "High." + + + Status + The state of the bug; this is usually set when the bug is triaged--marked as "Verified" or "Assigned" and then again when it is "Closed." It is usually changed to mark a major shift in the bug's occurrence in a product and version. + + All of these fields have a title, which is the value of the field; for instance "Normal" is the title of a default priority. Each field also has a display order; this value can be used to control the appearance of a given value in the selection list. If you want to change the default value for new bug reports, see here. @@ -277,14 +303,25 @@ The following is an explanation of each bug field: - - Field Type: The type of field that you are creating (selected previously) - - Description: Describe the field and its use; this is displayed as the help text to users. - - Required: Whether or not the field is required to be specified by the user. - - Can Be Searched: Whether or not the field appears on the search form. + + + + Field Type + The type of field that you are creating (selected previously) + + + Description + Describe the field and its use; this is displayed as the help text to users. + + + Required + Whether or not the field is required to be specified by the user. + + + Can Be Searched + Whether or not the field appears on the search form. + + Additionally, each field has custom permissions that you can set on a per-usergroup level (these can also be set in the usergroup editor. You can specify No Permission, Can View, or Can View and Edit settings: @@ -296,24 +333,41 @@ The following is an explanation of each bug field: Each type of field also has a unique set of options: - Single-Line Text Field -
- Default Value: Specify a default value for the field to be entered in new reports. - - Regular Expression Match: You can use a regular expression to match against the field's contents and the value will be rejected if the match fails. - - Maximum Length: If you want to limit the amount of characters (including spaces) that can be typed in the field, you can specify it here. -
- Checkbox Flag -
- Checked By Default: Setting this to Yes will make the checkbox clicked on. -
- Drop-Down Menu -
- Selection Values: A list of values to display in the menu, separated by a new line. If you remove a value that has been set by some bugs, it will still display in the non-edit mode of the bug display. - - Make the First Option Default: If you want to make the first option in the selection values list (above) be selected by default, change this to Yes. Otherwise, the menu will have a blank option selected by default. -
+ Single-Line Text Field + + + Default Value + Specify a default value for the field to be entered in new reports. + + + Regular Expression Match + You can use a regular expression to match against the field's contents and the value will be rejected if the match fails. + + + Maximum Length + If you want to limit the amount of characters (including spaces) that can be typed in the field, you can specify it here. + + + + Checkbox Flag + + + Checked By Default + Setting this to Yes will make the checkbox clicked on. + + + + Drop-Down Menu + + + Selection Values + A list of values to display in the menu, separated by a new line. If you remove a value that has been set by some bugs, it will still display in the non-edit mode of the bug display. + + + Make the First Option Default + If you want to make the first option in the selection values list (above) be selected by default, change this to Yes. Otherwise, the menu will have a blank option selected by default. + +
@@ -325,12 +379,21 @@ The following is an explanation of each bug field: Often, the same task is performed repeatedly, such as marking a bug "closed and fixed," or "not reproducible," or "please provide more information." These common responses often involve changing multiple fields (status, resolution, etc.) and then leaving a standard comment. Automatic actions make this process significantly easier as you simply define a "macro" of sorts that sets all of the fields and enters the comment automatically. You use these "macros" when viewing a bug. You select one of the automatic actions from a list and when you commit the changes to the bug, the changes specified in the automatic action will be applied. The three required fields are: - -Name: The name of the automatic action. This is displayed on the bug display and users select an action by this name. - -Description: Remarks about what the action does. - -Add Comment: The comment to add to the bug when the action is run. If the user has specified a comment and runs the automatic action at the same time, the automatic comment will be appended to the user's. + + + + Name + The name of the automatic action. This is displayed on the bug display and users select an action by this name. + + + Description + Remarks about what the action does. + + + Add Comment + The comment to add to the bug when the action is run. If the user has specified a comment and runs the automatic action at the same time, the automatic comment will be appended to the user's. + + Below this is a list of fields and you can specify a value for each. When the automatic action is run, these will set the bug's field accordingly. If a field is left blank here, then it will have no effect on the bug. If the user specifies a value for one of the fields and runs an automatic action at the same time, the automatic action will take precedence and override the user. @@ -365,30 +428,57 @@ The following is an explanation of each bug field:
Usergroups Usergroups are at the backbone of BugStrike's permissions system. There are two textual options for usergroups: - -Usergroup Title: This is the internal name of the usergroup; it is never displayed to the users, but administrators use it to place users in groups. - -Display Title: Under a comment poster's name, this text is placed to help distinguish regular users from developers, administrators, and guests. - -The majority of the permissions on this page are similar to those of test and they are explained in-depth here. Those that are not part of the usergroup permissions system are listed here. - -Can Search Bugs: A usergroup's ability to use the search function. If this is not enabled, then searches cannot be performed by the given usergroup. - -Can Be Assigned Bugs: If this is set to Yes, all the users in this usergroup will appear in the "Assigned" field drop-down menu for bug reports. - -Can Access Control Panel: This controls whether or not users in this usergroup can login to the Admin Control Panel. - -Can Administer Bug Reports: Currently, this only controls access to the Automatic Actions feature. - -Can Administer Additional Bug Fields: If this is set to Yes, users in this group will be able to define and edit custom bug fields. - -Can Administer Products / Components / Versions: Allows users to define and edit products, versions, and components. This privilege should be sparingly given out as users can also delete products, versions, and components and thus remove all associated bugs. - -Can Administer Users: Controls access to the user manager and the ability to edit and delete users. - -Can Administer Usergroups: Setting this to Yes gives the users in this group the ability to control all aspects of usergroups--including permissions. Please be careful when defining this permission. - -Can Administer Settings / Maintenance Tools: Access to this allows control of languages and settings. + + + + Usergroup Title + This is the internal name of the usergroup; it is never displayed to the users, but administrators use it to place users in groups. + + + Display Title + + Under a comment poster's name, this text is placed to help distinguish regular users from developers, administrators, and guests. + + The majority of the permissions on this page are similar to those of test and they are explained in-depth here. Those that are not part of the usergroup permissions system are listed here. + + + + Can Search Bugs + A usergroup's ability to use the search function. If this is not enabled, then searches cannot be performed by the given usergroup. + + + Can Be Assigned Bugs + If this is set to Yes, all the users in this usergroup will appear in the "Assigned" field drop-down menu for bug reports. + + + Can Access Control Panel + This controls whether or not users in this usergroup can login to the Admin Control Panel. + + + Can Administer Bug Reports + Currently, this only controls access to the Automatic Actions feature. + + + Can Administer Additional Bug Fields + If this is set to Yes, users in this group will be able to define and edit custom bug fields. + + + Can Administer Products / Components / Versions + Allows users to define and edit products, versions, and components. This privilege should be sparingly given out as users can also delete products, versions, and components and thus remove all associated bugs. + + + Can Administer Users + Controls access to the user manager and the ability to edit and delete users. + + + Can Administer Usergroups + Setting this to Yes gives the users in this group the ability to control all aspects of usergroups--including permissions. Please be careful when defining this permission. + + + Can Administer Settings / Maintenance Tools + Access to this allows control of languages and settings. + + Additionally, the usergroup manager has the custom field permissions system, similar to the one found on the custom field editor page, the difference being that this is by field whereas the other is by usergroup. @@ -416,36 +506,69 @@ The majority of the permissions on this page are similar to those of Permissions Reference This is a list of the permissions that can be customized on the per-product level. These--plus some additional permissions that are not available on the product-level can be found in the usergroup editor. - - Can View Bugs: Permits the ability to view bugs of this product. - - Can View Hidden Bugs and Comments: Allows viewing of bugs and comments that have been marked Hidden. {{NEED LINK: HIDING}} - - Can Subscribe to Bugs: Controls the ability to add bugs of this product to the user's "favourite" list. {{NEED LINK: FAVOURITES}} - - Can Vote on Polls: The ability to vote for a bug. Voting shows the amount of interest in a bug. {{NEED LINK: VOTING}} - - Can Submit Bugs: Determines if users can submit bugs under this product. - - Can Post Comments: Controls whether or not users can post comments to bugs with this product. - - Can View Attachments: Ability to view attachments in bugs with this product. - - Can Upload/Edit Own Attachments: Whether or not the user can edit and upload his or her own attachments to bugs with this product. - - Can Manage All Attachments: Ability to edit other users' attachments. - - Can Edit Own Bugs: Can edit the basic fields of bugs submitted by the user herself. The basic fields are: hidden, summary, product/component/version, severity, duplicates, and dependencies. - - Can Edit Others' Bugs: The same as Can Edit Own Bugs except it applies to bugs that the user did not submit. - - Can Edit Own Comments: Ability to edit comments submitted by the user herself to bugs with this product. - - Can Edit Others' Comments: The same as Can Edit Own Comments but it applies to comments submitted by everybody who is not the current logged in user. - - Can Assign Bugs: The ability to control the "Assigned To" field. - - Can Change Status: Controls the ability to edit the status, resolution, and priority fields. + + + + Can View Bugs + Permits the ability to view bugs of this product. + + + Can View Hidden Bugs and Comments + Allows viewing of bugs and comments that have been marked Hidden. {{NEED LINK: HIDING}} + + + Can Subscribe to Bugs + Controls the ability to add bugs of this product to the user's "favourite" list. {{NEED LINK: FAVOURITES}} + + + Can Vote on Polls + The ability to vote for a bug. Voting shows the amount of interest in a bug. {{NEED LINK: VOTING}} + + + Can Submit Bugs + Determines if users can submit bugs under this product. + + + Can Post Comments + Controls whether or not users can post comments to bugs with this product. + + + Can View Attachments + Ability to view attachments in bugs with this product. + + + Can Upload/Edit Own Attachments + Whether or not the user can edit and upload his or her own attachments to bugs with this product. + + + Can Manage All Attachments + Ability to edit other users' attachments. + + + Can Edit Own Bugs + Can edit the basic fields of bugs submitted by the user herself. The basic fields are: hidden, summary, product/component/version, severity, duplicates, and dependencies. + + + Can Edit Others' Bugs + The same as Can Edit Own Bugs except it applies to bugs that the user did not submit. + + + Can Edit Own Comments + Ability to edit comments submitted by the user herself to bugs with this product. + + + Can Edit Others' Comments + The same as Can Edit Own Comments but it applies to comments submitted by everybody who is not the current logged in user. + + + Can Assign Bugs + The ability to control the "Assigned To" field. + + + Can Change Status + Controls the ability to edit the status, resolution, and priority fields. + +
-- 2.22.5