From 41e1fbe33e831d558768cb46dddee93c4dd6e2b6 Mon Sep 17 00:00:00 2001 From: Robert Sesek Date: Sun, 1 Oct 2006 00:34:09 +0000 Subject: [PATCH] r1215: Moving the XML files --- locale/en_US/manual-xml/admin.xml | 545 ---------------------------- locale/en_US/manual-xml/build.xml | 28 -- locale/en_US/manual-xml/install.xml | 61 ---- locale/en_US/manual-xml/manual.xml | 32 -- locale/en_US/manual-xml/upgrade.xml | 29 -- 5 files changed, 695 deletions(-) delete mode 100644 locale/en_US/manual-xml/admin.xml delete mode 100644 locale/en_US/manual-xml/build.xml delete mode 100644 locale/en_US/manual-xml/install.xml delete mode 100644 locale/en_US/manual-xml/manual.xml delete mode 100644 locale/en_US/manual-xml/upgrade.xml diff --git a/locale/en_US/manual-xml/admin.xml b/locale/en_US/manual-xml/admin.xml deleted file mode 100644 index fa44736..0000000 --- a/locale/en_US/manual-xml/admin.xml +++ /dev/null @@ -1,545 +0,0 @@ - - The Administration Panel - - - -
- About the Administration Panel - Once you have logged into your user account, you will see an "Administration" tab in the top navigation bar. Click this to be presented with the login screen. Here, login again for an added layer of security. - - In the administration panel, there are numerous options and features that can be accessed through the main menu. -
- - - -
- The Main Menu - The primary page of the administration screen is the main menu: - - - - - - - - In this menu there is a listing of all the various mutable aspects of your &product; installation. In this manual, we will explain each item in the main menu in the order that they appear. - - We should also note that any option available in the main menu is also in the navigation menu (the pull down bar in the upper-left corner of the window): - - - - - - - - The logout link in the administration panel will not log you out of the entire &product; system--just the administration panel. However, the opposite is true of the logout link in the non-administration interface: if you log out there, you will also be logged out of the administration panel. -
- - - -
- &product; Settings - &product;'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. - - - -
- 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. - - -
- - - -
- 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. -
- - - -
- Pagination Options - The pagination options are advanced features. If you are a novice user and do not have to worry about server load with &product;, 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. - - -
- -
- - - -
- Manage Languages - In the Manage Languages section, you are presented with the language manager: - - - - - - - - In &product;, 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 modify the language file and create a new MO file. To do this, you must be familiar with using GNU gettext; translating is out of the scope of this manual. - - - -
- 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. - - - 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. - - - 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. - - -
- - - -
- Languages and Upgrades - When a new version of &product; is released, you will need to merge the po/en_US.pot into your PO file using msgmerge. - - For information on how to merge--both manually and using the translation tool--see the manual on using msgmerge. -
- -
- - - -
- 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, &product; has default text entries for all the fields. These entries cannot be deleted (but the text can be modified) as they are standard &product; fields. - - 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. - - Once you have created a custom entry, you can place the following code in any &product; template to create the help link, where "UNIQUE_KEY" is the unique key you specified: - - $help[UNIQUE_KEY] -
- - - -
- Products and Versions - &product; 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. - - 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. - - 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. - - 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. -
- - - -
- 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. - - - - 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. - - 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. -
- - - -
- Custom Bug Fields - &product; 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: - - - - - - - - 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. - - - -
- Custom Bug Field Options - All custom fields have the same standard options: - - - - - - - - - - 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: - - - - - - - - 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. - - -
- -
- -
- - - -
- 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. Automations 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 automations from a list and when you commit the changes to the bug, the changes specified in the automation will be applied. - - The three required fields are: - - - - Name - The name of the automation. 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 automation 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 automation 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 automation at the same time, the automation will take precedence and override the user. - - If the user is in a usergroup that does not have permission to change one of the fields that is specified in the automation, the field will change despite this when the automation is run. -
- - - -
- User Management - In &product;, 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: - - - - - - - - Here, you can change all the options that the user can change in his or her profile. -
- - - -
- Usergroups - Usergroups are at the backbone of &product;'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 Automations 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. - - - -
- 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. 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: - - - - - - - - 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. -
- - - -
- 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. - - -
- -
- - \ No newline at end of file diff --git a/locale/en_US/manual-xml/build.xml b/locale/en_US/manual-xml/build.xml deleted file mode 100644 index 39301f7..0000000 --- a/locale/en_US/manual-xml/build.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - The Apache Ant buildfile to create the manual to simplify processing. - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/locale/en_US/manual-xml/install.xml b/locale/en_US/manual-xml/install.xml deleted file mode 100644 index 1437e7b..0000000 --- a/locale/en_US/manual-xml/install.xml +++ /dev/null @@ -1,61 +0,0 @@ - - Installation - - - -
- Installation Overview - - The installation process is very simple and includes only six easy steps: - - - Download the latest version of Bugdar from Blue Static. - Unzip the files from the download package. - Rename upload/includes/config.php.new to upload/includes/config.php. - Open and edit the new config.php according to the instructions in the file. - Upload the files to your web server. - Run the installation script. - -
- - - -
- The Configruation File - First, you have to rename the file includes/config.php.new to be includes/config.php. - - When you have done this, open it in a text editor. - - Microsoft Windows users: do not use Notepad to do this. It may corrupt the file and make it unusable by your web server. - - When you open it, you will find a list of variables. All but the following are required: - - - $usepconnect - $cookieprefix - $tableprefix - - - All of the other fields have to be provided by your host--if you do not know them. - - Also make sure that it ends in a trailing slash! -
- - - -
- Running the Installer - After modifying the configuration file, upload all of the files in the upload directory of your download package to the web server where you want. - - Be sure that these uploaded files include your modified includes/config.php. - - Once you have done this, go to your web browser and enter the address of your installation, plus /install/install.php. For instance, if I uploaded the installation to /bugtrack/ on my server, I'd go to: http://www.example.com/bugtrack/install/install.php - - Once here, follow through the steps until your installation is complete. - - After you have completed installation and can log into the administrative control panel, be sure to delete this file on your web server: install/global.php - - If you do not do this, then people may be able to cause harm to your bug tracker. -
- - \ No newline at end of file diff --git a/locale/en_US/manual-xml/manual.xml b/locale/en_US/manual-xml/manual.xml deleted file mode 100644 index d7abaf0..0000000 --- a/locale/en_US/manual-xml/manual.xml +++ /dev/null @@ -1,32 +0,0 @@ - -1.1.0"> - Bugdar"> - &product; &version;"> - - - - -]> - - - - - &fullprod; Manual - &product; - - - 2005 - 2006 - Blue Static () - - Revision: $Revision$ ($Id$) - - - &chap01; - &chap02; - &chap03; - - \ No newline at end of file diff --git a/locale/en_US/manual-xml/upgrade.xml b/locale/en_US/manual-xml/upgrade.xml deleted file mode 100644 index bdd3c21..0000000 --- a/locale/en_US/manual-xml/upgrade.xml +++ /dev/null @@ -1,29 +0,0 @@ - - Upgrading - - - -
- Preparing the Files - Upgrading &product; is simple. - - - Remove all files except ./includes/config.php. - Upload the new files. - Run the upgrade script. - - - That's all you have to be concerned with when upgrading &product;! -
- - - -
- Running the Upgrade Script - After uploading all of the files, simply point your browser to: http://www.example.com/bugdar/install/upgrade.php. Where http://www.example.com/bugdar/ is the path at which I have installed &product;. - - The script will automatically redirect you to the file for your version. Click through all the steps, there should be no errors or problems. At the end of the upgrade script, you will be returned to the administration panel. - - When you are done upgrading, be sure to delete ./install/global.php as leaving it in place is a security risk! -
- \ No newline at end of file -- 2.22.5