Skip to content

Commit

Permalink
Doc: custom_strings_file is obsolete
Browse files Browse the repository at this point in the history
Config has been removed in 2014 (see issue #16850, commit
2928756) but it was still referenced
in the Admin Guide.
  • Loading branch information
dregad committed Mar 29, 2019
1 parent 655874c commit d923f52
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 20 deletions.
26 changes: 13 additions & 13 deletions docbook/Admin_Guide/en-US/Customizing.xml
Expand Up @@ -7,7 +7,8 @@
<para>All strings used in MantisBT, including those defined in
plugins, can be customized or translated differently.
This is achieved by overriding them in the
<filename>Custom Strings File</filename> (in config/custom_strings_inc.php),
<emphasis>Custom Strings File</emphasis>
(<filename>config/custom_strings_inc.php</filename>),
which is automatically detected and included by MantisBT code.
</para>

Expand Down Expand Up @@ -44,7 +45,7 @@ $s_CODE = STRING;
</itemizedlist>
</para>
<warning><para>NEVER call <emphasis>lang_get_current()</emphasis>
from the <emphasis>Custom Strings File</emphasis>, as doing so
from the <filename>custom_strings_inc.php</filename>, as doing so
will reset the active_language, causing the code to return
incorrect translations if the default language is different
from English.
Expand Down Expand Up @@ -131,9 +132,8 @@ $s_CODE = STRING;
(see <xref linkend="admin.customize.customfields.localize" />).
</para>
<note><para>If the specified variable is not found in the
language files or in the
<emphasis>Custom Strings File</emphasis>
(see <xref linkend="admin.customize.strings"/>),
language files or in
<filename>custom_strings_inc.php</filename>,
then it will be displayed as-is.
</para></note>
</listitem>
Expand Down Expand Up @@ -354,9 +354,9 @@ $s_CODE = STRING;
<listitem>
<para>Set the localization strings
<itemizedlist>
<listitem><para>In the main MantisBT directory,
locate and edit the
<emphasis>Custom Strings File</emphasis>
<listitem><para>In the MantisBT <filename>config</filename>
directory, locate and edit
<filename>custom_strings_inc.php</filename>
(see <xref linkend="admin.customize.strings"/>),
create it if it does not exist.
</para></listitem>
Expand Down Expand Up @@ -386,7 +386,7 @@ switch( $g_active_language ) {

<note><para>Had we decided to use <emphasis>start_date</emphasis>
as the custom field's name, then it would not have been necessary
to modify the <emphasis>Custom Strings File</emphasis>
to modify <filename>custom_strings_inc.php</filename>
(see <xref linkend="admin.customize.strings"/>),
since MantisBT would have used the
existing, already localized string from the standard language files.
Expand Down Expand Up @@ -644,7 +644,7 @@ $g_manage_custom_fields_threshold = SENIOR_DEVELOPER;
</para>

<para>
Update the <emphasis>Custom Strings File</emphasis>
Update <filename>custom_strings_inc.php</filename>
(see <xref linkend="admin.customize.strings"/>)
<programlisting>
$s_access_levels_enum_string =
Expand Down Expand Up @@ -852,8 +852,8 @@ $g_status_colors['<emphasis>testing</emphasis>'] = '#ACE7AE';
underscores in the language strings names (e.g.
for '35:pending user', use '$s_pending_user_bug_button')
</para>
<para>In subfolder config, locate and edit
the <emphasis>Custom Strings File</emphasis>
<para>In the <filename>config</filename> subfolder, locate and edit
<filename>custom_strings_inc.php</filename>
(see <xref linkend="admin.customize.strings"/>),
create it if it does not exist
<programlisting>
Expand Down Expand Up @@ -1134,7 +1134,7 @@ define( 'ERROR_VALIDATE_FAILURE', 2000 );
</listitem>

<listitem>
<para><emphasis>Custom Strings File</emphasis>
<para><filename>custom_strings_inc.php</filename>
(see <xref linkend="admin.customize.strings"/>)
</para>

Expand Down
5 changes: 1 addition & 4 deletions docbook/Admin_Guide/en-US/Installation.xml
Expand Up @@ -561,10 +561,7 @@ tar -xf <emphasis>filename.tar</emphasis>
<para><filename>config_inc.php</filename>,</para>
</listitem>
<listitem>
<para>the <emphasis>Custom Strings File</emphasis>
(<filename>custom_strings_inc.php</filename> by
default, see <xref linkend="admin.customize.strings"/>),
</para>
<para><filename>custom_strings_inc.php</filename>,</para>
</listitem>
<listitem>
<para><filename>custom_constants_inc.php</filename> and</para>
Expand Down
6 changes: 3 additions & 3 deletions docbook/Admin_Guide/en-US/config/html.xml
Expand Up @@ -135,9 +135,9 @@ $g_main_menu_custom_options = array(
)
);
</programlisting>
Note that if the caption is found in the
<emphasis>Custom Strings File</emphasis>
(see <xref linkend="admin.customize.strings"/>)
Note that if the caption is found in
<filename>custom_strings_inc.php</filename>
(see <xref linkend="admin.customize.strings"/>),
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
Expand Down

0 comments on commit d923f52

Please sign in to comment.