From 39898bc0369bc9523c965064fa10fabee559fece Mon Sep 17 00:00:00 2001 From: Robert Sesek Date: Thu, 28 Sep 2006 02:02:39 +0000 Subject: [PATCH] r1198: Removing thigns that are flat-out untrue anymore --- locale/en_US/manual-xml/admin.xml | 54 ++++++------------------------- 1 file changed, 9 insertions(+), 45 deletions(-) diff --git a/locale/en_US/manual-xml/admin.xml b/locale/en_US/manual-xml/admin.xml index f3dae3f..a7e136d 100644 --- a/locale/en_US/manual-xml/admin.xml +++ b/locale/en_US/manual-xml/admin.xml @@ -8,8 +8,6 @@ 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. - - If you would like more information about a feature, most sections have a small Help link in the upper-right corner. You can click this or the section's title to bring up the documentation page for the specific section. @@ -119,9 +117,7 @@ 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 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. + 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. @@ -148,52 +144,20 @@ 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. - -
- Translating a Language - Translating strings for &product; follows the same rules as translating strings for any other ISSO-based application. - - This page will give you the information that is &product;-specific to translating. However, for the general practice of translating in ISSO, please refer to the {{GETTEXT TRANSLATION GUIDE}}. - - 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. -
- - -
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. - - 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. - - For information on how to merge--both manually and using the translation tool--see the {{GETTEXT MERGING MANUAL}}. + + For information on how to merge--both manually and using the translation tool--see the manual on using msgmerge.
@@ -383,14 +347,14 @@
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. 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 automatic action. This is displayed on the bug display and users select an action by this name. + The name of the automation. This is displayed on the bug display and users select an action by this name. Description @@ -398,13 +362,13 @@ 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. + 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 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 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 automatic action, the field will change despite this when the automatic action is run. + 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.
@@ -463,7 +427,7 @@ Can Administer Bug Reports - Currently, this only controls access to the Automatic Actions feature. + Currently, this only controls access to the Automations feature. Can Administer Additional Bug Fields -- 2.22.5