Localizing Customer and Business Manager

In this chapter, we will discuss the details of Business Manager localization.

Preparing for Translation

Before you start translating Business Manager to a certain language, export the American English (en-US) locale by copying the file en.php. This file is located in the following directory:

  • On Linux: /opt/plesk-billing/lib/lib-billing/include/translations/en.php
  • On Windows: %plesk_dir%\billing\lib\lib-billing\include\translations

Then change the name of your copy to the two-letter code of your language. To find the code of a certain language, see the Appendix: Locale codes.

Translating GUI Messages

Business Manager locale files are PHP files with simple associative arrays made up of records like

"<em><localization_key>"</em> => "<em><message>"</em>,

where

  • <localization_key> uniquely identifies a GUI item.
  • <message> is the message corresponding to the GUI item, appearing as either a GUI or a contextual help text.

The localization task is to translate all string parts containing messages (<message>), leaving localization keys and string syntax as they are.

Note: locale messages can contain HTML source text, be sure to preserve the HTML syntax during the translation, too.

The section Translating Plesk GUI Messages provides more information on translating locale strings.

After you complete editing locale files, we recommend that you validate the new locale file after translation to avoid possible problems caused by breaking the PHP syntax.

To validate the translated files:

  1. Upload the files to the machine with PHP installed.
  2. Run the following command:

    #php -l <file-name>

    for example,

    #php -l conhelp_pt-BR.php

Importing New Locale

To import the new locale to Business Manager:

  1. Upload the new locale file to the Business Manager locales directory:
    • On Linux: /opt/plesk-billing/lib/lib-billing/include/translations/
    • On Windows: %plesk_dir%\billing\lib\lib-billing\include\translations
  2. Run the following command on the Plesk server:
    • On Linux:

      # usr/share/plesk-billing/cache --clear --type locale

    • On Windows:

      > C:\Program Files\Parallels\Plesk\bin\billing-cache.exe --clear --type locale

Changing Default Locales

In addition to creating new locales, you can change existing GUI messages in Business Manager, for example, if you find default names or descriptions not suitable for your business.

To change an existing Business Manager locale:

  1. Create a file with the name <locale>.custom.php in the directory with the default locale you want to change. Here <locale> is the abbreviation used for the locale, for example, en for the English locale.

    Note: If you correct keys directly in the corresponding locale file <locale>.php, your changes may be lost since Business Manager completely overwrites these files during upgrades.

  2. Add the following lines to the file:

    <?php

    $translation_keys = array(

  3. Copy the keys you want to change to this file and specify custom values for them.
  4. Add the following line to the end of the file:

    );

  5. Save the file.
  6. Run the following command on the Plesk server:
    • On Linux: # usr/share/plesk-billing/cache --clear
    • On Windows: > C:\Program Files\Parallels\Plesk\bin\billing-cache.exe --clear
 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.