From 80fc03cef40452626d701f913d95fe31cf552590 Mon Sep 17 00:00:00 2001 From: Robert Sesek Date: Sun, 24 Sep 2006 23:45:02 +0000 Subject: [PATCH] r1181: More formatting done --- locale/en_US/manual-xml/admin.xml | 141 +++++++++++++++++++++++------- 1 file changed, 109 insertions(+), 32 deletions(-) diff --git a/locale/en_US/manual-xml/admin.xml b/locale/en_US/manual-xml/admin.xml index ac58a8a..c6c51fc 100644 --- a/locale/en_US/manual-xml/admin.xml +++ b/locale/en_US/manual-xml/admin.xml @@ -43,10 +43,7 @@
Bugdar Settings - Bugdar's main options are broken up into three different sections: General Options, Bug Reporting Options, and Pagination Options. - -For the most part, you will only have to alter the general settings. In the following three pages, we will explain the key options of each page. - + Bugdar's main options are broken up into three different sections: General Options, Bug Reporting Options, and Pagination Options. For the most part, you will only have to alter the general settings. In the following three pages, we will explain the key options of each page. @@ -58,7 +55,7 @@ For the most part, you will only have to alter the general settings. In the foll 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. + 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.
@@ -93,7 +90,15 @@ For the most part, you will only have to alter the general settings. In the foll Manage Languages 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. @@ -107,7 +112,15 @@ The language manager has an important link next to each language: [Reloa Adding or Editing a Language 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. @@ -117,11 +130,11 @@ The language manager has an important link next to each language: [Reloa 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. + 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. + 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. @@ -163,7 +176,7 @@ The language manager has an important link next to each language: [Reloa 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 help text for custom fields is set through the description field in the custom field editor. +The help text for custom fields is set through the description field in the custom field editor. 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. @@ -184,7 +197,15 @@ Components are essentially sub-products. They behave in the exact same fashion a 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. @@ -209,7 +230,7 @@ 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] @@ -222,13 +243,29 @@ All of these fields have a title, which is the value of the field; for instance The manager shows you all the information regarding the field: -
Custom Bug Field Manager
+ + + + + + + + + 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: -
Add New Custom Field - Step 1
+ + + + + + + + + -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. @@ -236,7 +273,15 @@ Here you select the type of field you want. After selecting the type of field yo Custom Bug Field Options All custom fields have the same standard options: -
Global Options
+ + + + + + + + + Field Type: The type of field that you are creating (selected previously) @@ -246,9 +291,17 @@ 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: + + -
Field Permissions
+ + + + + + + Each type of field also has a unique set of options: @@ -303,11 +356,27 @@ Below this is a list of fields and you can specify a value for each. When the au 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: -
User Search
+ + + + + + + + + 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: -
Edit User
+ + + + + + + + + Here, you can change all the options that the user can change in his or her profile. @@ -322,41 +391,49 @@ Here, you can change all the options that the user can change in his or her prof 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 and they are explained in-depth here. Those that are not part of the usergroup permissions system are listed here. +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 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 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 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 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 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. +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. 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: -
Usergroup Permissions
+ + + + + + + + + - 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.
@@ -365,7 +442,7 @@ Additionally, the usergroup manager has the custom field permissions system, sim
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