From d923f5298d33a04f16f47958651c589781222594 Mon Sep 17 00:00:00 2001 From: Damien Regad Date: Wed, 27 Mar 2019 17:25:54 +0100 Subject: [PATCH] Doc: custom_strings_file is obsolete Config has been removed in 2014 (see issue #16850, commit 2928756bbc621e04d691f9e9cce10cf673e0e742) but it was still referenced in the Admin Guide. --- docbook/Admin_Guide/en-US/Customizing.xml | 26 +++++++++++----------- docbook/Admin_Guide/en-US/Installation.xml | 5 +---- docbook/Admin_Guide/en-US/config/html.xml | 6 ++--- 3 files changed, 17 insertions(+), 20 deletions(-) diff --git a/docbook/Admin_Guide/en-US/Customizing.xml b/docbook/Admin_Guide/en-US/Customizing.xml index b6773bdcb7..5ed325d84c 100644 --- a/docbook/Admin_Guide/en-US/Customizing.xml +++ b/docbook/Admin_Guide/en-US/Customizing.xml @@ -7,7 +7,8 @@ All strings used in MantisBT, including those defined in plugins, can be customized or translated differently. This is achieved by overriding them in the - Custom Strings File (in config/custom_strings_inc.php), + Custom Strings File + (config/custom_strings_inc.php), which is automatically detected and included by MantisBT code. @@ -44,7 +45,7 @@ $s_CODE = STRING; NEVER call lang_get_current() - from the Custom Strings File, as doing so + from the custom_strings_inc.php, as doing so will reset the active_language, causing the code to return incorrect translations if the default language is different from English. @@ -131,9 +132,8 @@ $s_CODE = STRING; (see ). If the specified variable is not found in the - language files or in the - Custom Strings File - (see ), + language files or in + custom_strings_inc.php, then it will be displayed as-is. @@ -354,9 +354,9 @@ $s_CODE = STRING; Set the localization strings - In the main MantisBT directory, - locate and edit the - Custom Strings File + In the MantisBT config + directory, locate and edit + custom_strings_inc.php (see ), create it if it does not exist. @@ -386,7 +386,7 @@ switch( $g_active_language ) { Had we decided to use start_date as the custom field's name, then it would not have been necessary - to modify the Custom Strings File + to modify custom_strings_inc.php (see ), since MantisBT would have used the existing, already localized string from the standard language files. @@ -644,7 +644,7 @@ $g_manage_custom_fields_threshold = SENIOR_DEVELOPER; - Update the Custom Strings File + Update custom_strings_inc.php (see ) $s_access_levels_enum_string = @@ -852,8 +852,8 @@ $g_status_colors['testing'] = '#ACE7AE'; underscores in the language strings names (e.g. for '35:pending user', use '$s_pending_user_bug_button') - In subfolder config, locate and edit - the Custom Strings File + In the config subfolder, locate and edit + custom_strings_inc.php (see ), create it if it does not exist @@ -1134,7 +1134,7 @@ define( 'ERROR_VALIDATE_FAILURE', 2000 ); - Custom Strings File + custom_strings_inc.php (see ) diff --git a/docbook/Admin_Guide/en-US/Installation.xml b/docbook/Admin_Guide/en-US/Installation.xml index 225d923160..c89b9603e5 100644 --- a/docbook/Admin_Guide/en-US/Installation.xml +++ b/docbook/Admin_Guide/en-US/Installation.xml @@ -561,10 +561,7 @@ tar -xf filename.tar config_inc.php, - the Custom Strings File - (custom_strings_inc.php by - default, see ), - + custom_strings_inc.php, custom_constants_inc.php and diff --git a/docbook/Admin_Guide/en-US/config/html.xml b/docbook/Admin_Guide/en-US/config/html.xml index d5ba904a33..4203fe5d41 100644 --- a/docbook/Admin_Guide/en-US/config/html.xml +++ b/docbook/Admin_Guide/en-US/config/html.xml @@ -135,9 +135,9 @@ $g_main_menu_custom_options = array( ) ); - Note that if the caption is found in the - Custom Strings File - (see ) + Note that if the caption is found in + custom_strings_inc.php + (see ), it will be replaced by the corresponding translated string. Options will only be added to the menu if the current logged in user has the appropriate