From 0b090c8071e89a1a3035f70aeee4203588fb87eb Mon Sep 17 00:00:00 2001 From: Robert Sesek Date: Mon, 25 Sep 2006 00:06:12 +0000 Subject: [PATCH] r1182: Tons of formatting --- locale/en_US/manual-xml/admin.xml | 235 +++++++++++++----------------- 1 file changed, 104 insertions(+), 131 deletions(-) diff --git a/locale/en_US/manual-xml/admin.xml b/locale/en_US/manual-xml/admin.xml index c6c51fc..5c7e9e4 100644 --- a/locale/en_US/manual-xml/admin.xml +++ b/locale/en_US/manual-xml/admin.xml @@ -49,37 +49,58 @@
General Options - Most of the general settings are explained by their descriptions, however a few of the options are explicated here. - - Tracker Title: This is the name of the entire bug tracking system. The value of this setting will appear at the top of the bug tracker and in most emails sent out to users. - - Tracker Base URL: Set this to the root URL of your tracker--the initial location of the tracker in your web browser. Make sure that there is no trailing slash ("/") at the end of the URL as it could possibly break links that the URL is used in. - - Date Format: For most users, this option will not need to change as the default is perfectly fine. However, if you wish to change the way in which dates appear in your bug tracker, you will need to use PHP's date formatting characters. Follow the table here for the formatting characters. + Most of the general settings are explained by their descriptions, however a few of the options are explicated here. + + + + Tracker Title + This is the name of the entire bug tracking system. The value of this setting will appear at the top of the bug tracker and in most emails sent out to users. + + + Tracker Base URL + Set this to the root URL of your tracker--the initial location of the tracker in your web browser. Make sure that there is no trailing slash ("/") at the end of the URL as it could possibly break links that the URL is used in. + + + Date Format + For most users, this option will not need to change as the default is perfectly fine. However, if you wish to change the way in which dates appear in your bug tracker, you will need to use PHP's date formatting characters. Follow the table here for the formatting characters. + +
Bug Reporting Options - Allow HTML in Bug Reports: This is an option that should be set to No unless there is good reason to change it. By allowing HTML in bug reports, users would be able to post malicious code that could break the display of the tracker and exploit the system via JavaScript. Only enable this option if you are confident in the users of the system, generally only in private bug trackers. - - The rest of the options in Bug Reporting Options are defaults. What that means is that in the new report screen, these values will be entered in by default. If a user has permissions to change the field, he or she can; however, if the user does not, this value will be inserted. + + + Allow HTML in Bug Reports + This is an option that should be set to No unless there is good reason to change it. By allowing HTML in bug reports, users would be able to post malicious code that could break the display of the tracker and exploit the system via JavaScript. Only enable this option if you are confident in the users of the system, generally only in private bug trackers. + + + + The rest of the options in Bug Reporting Options are defaults. What that means is that in the new report screen, these values will be entered in by default. If a user has permissions to change the field, he or she can; however, if the user does not, this value will be inserted.
Pagination Options - The pagination options are advanced features. If you are a novice user and do not have to worry about server load with BugStrike, these settings do not need changing. - - These settings control the number of bugs that appear in a listing and how many page navigation links are displayed. - - Default Per-Page Amount: The default number of items to be displayed on a single page. - - Maximum Per-Page Value: If a user manually enters a per-page amount, it cannot exceed this value; if it does, the system will use this value instead. If server load is a concern for your system, this setting may need to be lowered. - - Number of Page Links: This controls how many page navigator links appear on either side of the current page. Settings this to 0 will display all pages, which is highly not recommended. A setting greater than 5 is also not recommended. + The pagination options are advanced features. If you are a novice user and do not have to worry about server load with BugStrike, these settings do not need changing. These settings control the number of bugs that appear in a listing and how many page navigation links are displayed. + + + + Default Per-Page Amount + The default number of items to be displayed on a single page. + + + Maximum Per-Page Value + If a user manually enters a per-page amount, it cannot exceed this value; if it does, the system will use this value instead. If server load is a concern for your system, this setting may need to be lowered. + + + Number of Page Links + This controls how many page navigator links appear on either side of the current page. Settings this to 0 will display all pages, which is highly not recommended. A setting greater than 5 is also not recommended. + +
@@ -88,23 +109,19 @@
Manage Languages - In the Manage Languages section, you are presented with the language manager: + In the Manage Languages section, you are presented with the language manager: - - - - -In Bugdar, localization is a complicated process which is explained in the ISSO manual. What you need to know, however, is that the actual English text is embedded in templates and files. When a new language is added, this English text is looked up against a table of the language's translated text; if there's an entry for a given phrase (called a string), it displays that instead. + In Bugdar, localization is a complicated process which is explained in the ISSO manual. What you need to know, however, is that the actual English text is embedded in templates and files. When a new language is added, this English text is looked up against a table of the language's translated text; if there's an entry for a given phrase (called a string), it displays that instead. -What this means is that the default language ("English (US)") doesn't need to exist. However, we have left it in place because if an administrator wants to change a string, all he or she has to do is edit a translation and then reload the XML file. All of this will be explained later in the manual. + What this means is that the default language ("English (US)") doesn't need to exist. However, we have left it in place because if an administrator wants to change a string, all he or she has to do is edit a translation and then reload the XML file. All of this will be explained later in the manual. -The language manager has an important link next to each language: [Reload XML]. When a language is reloaded, the cache of strings is flushed and recreated from the XML file. This needs to be done if changes made to a language XML file are to be displayed. You will learn about this in the next section. + The language manager has an important link next to each language: [Reload XML]. When a language is reloaded, the cache of strings is flushed and recreated from the XML file. This needs to be done if changes made to a language XML file are to be displayed. You will learn about this in the next section. @@ -113,14 +130,10 @@ The language manager has an important link next to each language: [Reloa When you add or edit a language, you are presented with this screen: - - - - - - - - + + + + Title: The name of the language that is to be displayed to users (if they can select it) and in the administration panel. @@ -141,29 +154,29 @@ The language manager has an important link next to each language: [Reloa
Translating a Language - Translating strings for BugStrike follows the same rules as translating strings for any other ISSO-based application. + Translating strings for BugStrike follows the same rules as translating strings for any other ISSO-based application. - This page will give you the information that is BugStrike-specific to translating. However, for the general practice of translating in ISSO, please refer to the ISSO translation manual. + This page will give you the information that is BugStrike-specific to translating. However, for the general practice of translating in ISSO, please refer to the ISSO translation manual. - The "master strings file" (as it is called in the ISSO translation manual) is located at includes/strings/english-us.strings.xml. When you are translating, you will need to: + The "master strings file" (as it is called in the ISSO translation manual) is located at includes/strings/english-us.strings.xml. When you are translating, you will need to: a) Duplicate the file, if you are editing the XML strings directly, or b) Download the XML file to your computer (if you have not already) and then specify that file as the master in the translation tool. - For further instructions, please consult the ISSO manual. + For further instructions, please consult the ISSO manual.
Languages and Upgrades - When a new version of Bugdar is released, a small strings file will be placed in install/strings/. This smaller file is a localization-delta file (localization changes). You can read more about the format of the file in the ISSO manual. + When a new version of Bugdar is released, a small strings file will be placed in install/strings/. This smaller file is a localization-delta file (localization changes). You can read more about the format of the file in the ISSO manual. - The files in the install/strings/ folder are labeled by version number. If you upgraded from 1.0.0 to 1.0.1, you would look for the 1-0-1.strings.xml file and then merge it into your strings file. + The files in the install/strings/ folder are labeled by version number. If you upgraded from 1.0.0 to 1.0.1, you would look for the 1-0-1.strings.xml file and then merge it into your strings file. - If you were to upgrade to a version more than one version above, then you will need to use all the string files. For example, if you were running 1.3.2 and you wanted to upgrade to 1.3.5 (and versions 1.3.3 and 1.3.4 existed), you would need to repeat the merging process for all those string files. + If you were to upgrade to a version more than one version above, then you will need to use all the string files. For example, if you were running 1.3.2 and you wanted to upgrade to 1.3.5 (and versions 1.3.3 and 1.3.4 existed), you would need to repeat the merging process for all those string files. - For information on how to merge--both manually and using the translation tool--see the ISSO manual. + For information on how to merge--both manually and using the translation tool--see the ISSO manual.
@@ -172,53 +185,47 @@ The language manager has an important link next to each language: [Reloa
Edit User Help - The user help manager allows you to edit the help text that is displayed in popups in the user's browser. Next to fields that are help-enabled, a small "?" is placed next to the name of the field; clicking this results in a small pop-up that displays help text. - -By default, Bugdar has default text entries for all the fields. These entries cannot be deleted (but the text can be modified) as they are standard Bugdar fields. + The user help manager allows you to edit the help text that is displayed in popups in the user's browser. Next to fields that are help-enabled, a small "?" is placed next to the name of the field; clicking this results in a small pop-up that displays help text. -The help text for custom fields is set through the description field in the custom field editor. + By default, Bugdar has default text entries for all the fields. These entries cannot be deleted (but the text can be modified) as they are standard Bugdar fields. -You can also create your own help text entries by clicking [Add New Help Text]. You then enter a unique key that is used to identify the text, the title of the text, and then the body. + The help text for custom fields is set through the description field in the custom field editor. -Once you have created a custom entry, you can place the following code in any Bugdar template to create the help link: + You can also create your own help text entries by clicking [Add New Help Text]. You then enter a unique key that is used to identify the text, the title of the text, and then the body. -[php]$help[UNIQUE_KEY][/php] + Once you have created a custom entry, you can place the following code in any Bugdar template to create the help link, where "UNIQUE_KEY" is the unique key you specified: -... where "UNIQUE_KEY" is the unique key you specified. + [php]$help[UNIQUE_KEY][/php]
Products and Versions - Bugdar organizes bugs into products and versions. When a user enters a bug report, he or she is required to specify a product and a version. Therefore, you need at least one product and one version in your system to be usable. + Bugdar organizes bugs into products and versions. When a user enters a bug report, he or she is required to specify a product and a version. Therefore, you need at least one product and one version in your system to be usable. -Components are essentially sub-products. They behave in the exact same fashion as products (in that they require a version to be selected, too) but they are like a part of the project. For instance, in a calendar application there could be components for making events, displaying the calendar, notifications and reminders, etc. These are smaller--but yet still significant--portions of the product. + Components are essentially sub-products. They behave in the exact same fashion as products (in that they require a version to be selected, too) but they are like a part of the project. For instance, in a calendar application there could be components for making events, displaying the calendar, notifications and reminders, etc. These are smaller--but yet still significant--portions of the product. -In the product manager, you see this: + In the product manager, you see this: - - - - -This screen allows you to change the display order (the lower the value, the higher it appears in the list) and manage any components or versions. If you wish to add a component or version, simply choose the option from the pulldown on the far-right. + This screen allows you to change the display order (the lower the value, the higher it appears in the list) and manage any components or versions. If you wish to add a component or version, simply choose the option from the pulldown on the far-right. -In this screen, products (but not components) are bold, both components and products are underlined, and versions have no special formatting. This interface feature will help you differentiate (along with the depth marks) which is a product and which is a version. + In this screen, products (but not components) are bold, both components and products are underlined, and versions have no special formatting. This interface feature will help you differentiate (along with the depth marks) which is a product and which is a version. -[note]A product has all of its versions and then any global versions. A component will inherit the global versions, its product's versions along with the versions defined specifically for the component. This allows you to specify components without locally-defined versions; instead, they can be inherited.[/note] + [note]A product has all of its versions and then any global versions. A component will inherit the global versions, its product's versions along with the versions defined specifically for the component. This allows you to specify components without locally-defined versions; instead, they can be inherited.[/note]
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. + 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: @@ -230,58 +237,46 @@ The following is an explanation of each bug field: 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. + 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. -[note]The status field also has a colour field associated with it. By filling this value in with a HEX code (be sure to include the # when you specify the value), the background colour of the bug rows in lists will fill to this colour according to bug status (this is a user option). For instance, any unconfirmed bugs will be highlighted in red when viewing the bug list.[/note] + [note]The status field also has a colour field associated with it. By filling this value in with a HEX code (be sure to include the # when you specify the value), the background colour of the bug rows in lists will fill to this colour according to bug status (this is a user option). For instance, any unconfirmed bugs will be highlighted in red when viewing the bug list.[/note]
Custom Bug Fields - Bugdar offers many fields to help you track and triage bugs. However, sometimes additional fields are needed for your specific setup. The additional bug fields feature allows you to create those extra fields and exert fine control over the fields. + Bugdar offers many fields to help you track and triage bugs. However, sometimes additional fields are needed for your specific setup. The additional bug fields feature allows you to create those extra fields and exert fine control over the fields. -The manager shows you all the information regarding the field: + The manager shows you all the information regarding the field: - - - - -There are three types of field that can be created: single-line text boxes, check boxes, and drop-down menus. When you click [Add New Bug Field], you are presented with this screen: + There are three types of field that can be created: single-line text boxes, check boxes, and drop-down menus. When you click [Add New Bug Field], you are presented with this screen: - - - - -Here you select the type of field you want. After selecting the type of field you want and pressing [Submit], you are taken to the options screen; here you specify all the various options for your field. This is discussed here. + Here you select the type of field you want. After selecting the type of field you want and pressing [Submit], you are taken to the options screen; here you specify all the various options for your field. This is discussed here.
Custom Bug Field Options - All custom fields have the same standard options: + All custom fields have the same standard options: - - - - - - - - + + + + Field Type: The type of field that you are creating (selected previously) @@ -291,19 +286,15 @@ Here you select the type of field you want. After selecting the type of field yo 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: + 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: + + + + - - - - - - - - - Each type of field also has a unique set of options: + Each type of field also has a unique set of options: Single-Line Text Field
@@ -331,13 +322,9 @@ Here you select the type of field you want. After selecting the type of field yo
Automations - 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. + 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: + 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. @@ -345,47 +332,39 @@ The three required fields are: 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. + 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. -[note]If the user is in a usergroup that does not have permission to change one of the fields that is specified in the automatic action, the field will change despite this when the automatic action is run.[/note] + [note]If the user is in a usergroup that does not have permission to change one of the fields that is specified in the automatic action, the field will change despite this when the automatic action is run.[/note]
User Management - In Bugdar, you can control and edit the profiles of all registered users. If you want to change a user's options, simply specify a display name, email, or a user ID at this screen: + In Bugdar, you can control and edit the profiles of all registered users. If you want to change a user's options, simply specify a display name, email, or a user ID at this screen: - - - - -If more than one user matches your search criteria, you will get a listing of users that match. Otherwise, you will be redirected to the edit screen: + If more than one user matches your search criteria, you will get a listing of users that match. Otherwise, you will be redirected to the edit screen: - - - - -Here, you can change all the options that the user can change in his or her profile. + Here, you can change all the options that the user can change in his or her profile.
Usergroups - Usergroups are at the backbone of BugStrike's permissions system. There are two textual options for 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. @@ -411,38 +390,32 @@ The majority of the permissions on this page are similar to those of 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. + 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.
Usergroup Permissions - In the usergroups manager, you can set the default permissions that apply to every product. However, sometimes you may need finer control over the permissions. + In the usergroups manager, you can set the default permissions that apply to every product. However, sometimes you may need finer control over the permissions. Using the permissions manager, you can override the default permissions set by the usergroup. - Using the permissions manager, you can override the default permissions set by the usergroup. - - The default screen shows a list of all the usergroups with an [Expand] link next to them. Clicking this link will display a list of all available products underneath the usergroup: + The default screen shows a list of all the usergroups with an [Expand] link next to them. Clicking this link will display a list of all available products underneath the usergroup: + + + + - - - - - - - - - If you want to override the permissions for a certain product, simply click the [Customize] link to go to a permissions page, similar to the one in the usergroup editor. You can find an explanation of these permissions here. + If you want to override the permissions for a certain product, simply click the [Customize] link to go to a permissions page, similar to the one in the usergroup editor. You can find an explanation of these permissions here. - After you have customized permissions, but you find that you no longer want the customizations, simply click the [Revert] link. + After you have customized permissions, but you find that you no longer want the customizations, simply click the [Revert] link.
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. + 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. -- 2.22.5