Personal tools
Namespaces

Variants
Actions

Polish Language Translation For WHMCS

From ModulesGarden Wiki
Revision as of 14:06, 13 September 2019 by Joanna (Talk | contribs)

Jump to: navigation, search


If you are looking for a Polish version of this documentation page, please follow the link here.


Contents

About Polish Language Translation For WHMCS

Polish Language Translation For WHMCS is a great tool prepared especially for Polish speaking users.
You will finally get the opportunity to extend the list of available languages with the long-awaited one - Polish.
Our solution will allow the freedom of choice for you, your clients and even guests when it comes to the selection of their language preferences.
  • Translation Overview:
✔ Professional Polish Localization
✔ Translation Of Both Client Area And Admin Area
✔ Additional Translation Of WHMCS Built-In Reports
✔ Additional Translation Of WHMCS Dashboard Widgets
✔ Open Source Version Of Language Files
✔ Nearly 7800 Complete Expressions Translated
✔ Supports WHMCS Template Six And Any Custom Template Based On It
✔ Supports All WHMCS Versions
✔ Translated All Available Records Up To WHMCS V7.8.2
✔ Supports Geolocation Hook For WHMCS Integration (read more)

Installation

Translations of Client and Admin Area

This tutorial will show you how to successfully install and configure Polish Language Translation For WHMCS.

We will guide you step by step through the whole process.

1. Log in to our client area and download the translation files.
PL 1.png
2. Extract the downloaded files.

The content of the files should look like this.

PL 2.png
3. Make sure to upload the files into correct directories.

Exemplary admin area polish.php file directory, as its location may have been customized and vary per system:

yourWHMCS/admin/lang

Client area polish.php translation file directory:

yourWHMCS/lang
That is all! You do not need to install or activate it in any place!

Translation of Reports

Installing the translation of reports is optional. If you wish, you can skip this step.

By default, WHMCS does not provide a translation of reports via language file, and the records required for localization are hardcoded in the reports themselves.
To make their translation possible, the original report files based on those from WHMCS V7.8.2. were modified.

For this reason, uploading translated reports will overwrite the original English versions in your WHMCS system!
If you want to keep both English and Polish versions of reports at the same time, you should change names of the '.php' files into your own ones, so that they do not collide with the names of original files.
Such reports will be then available on the reports home page in the 'Other' category. WHMCS recommends that report file names are written in small letters and numbers (a-z, 0-9), always starting with a letter.

1. We recommend that you make a copy of the original report files before uploading the translation of reports.

Go to the directory:

/yourWHMCS/modules

and rename the folder 'reports' to e.g. 'reports_backup' .

PL 11.png
2. Then, into the same directory ( '/yourWHMCS/modules' ) upload the translated directory named 'reports_RenameMe' .

Then change its name to 'reports' .

Note: If you have any additional reports installed, remember to move their files from the backup folder to the main report folder as well.

PL 12.png
3. The last step is to add a translation of the report names displayed in the admin area menu.

Their translation is contained directly in the admin area theme you currently use.
If you are using the standard WHMCS theme 'Blend' , go to the directory '/yourWHMCS/admin/templates/blend' and open 'menu.tpl' file. Then, find the following code fragment (in lines 97-103 by default):

    <li><a id="Menu-Reports-Daily_Performance" href="reports.php?report=daily_performance">Daily Performance</a></li>
    <li><a id="Menu-Reports-Income_Forecast" href="reports.php?report=income_forecast">Income Forecast</a></li>
    <li><a id="Menu-Reports-Annual_Income_Report" href="reports.php?report=annual_income_report">Annual Income Report</a></li>
    <li><a id="Menu-Reports-New_Customers" href="reports.php?report=new_customers">New Customers</a></li>
    <li><a id="Menu-Reports-Ticket_Feedback_Scores" href="reports.php?report=ticket_feedback_scores">Ticket Feedback Scores</a></li>
    <li><a id="Menu-Reports-Batch_Invoice_PDF_Export" href="reports.php?report=pdf_batch">Batch Invoice PDF Export</a></li>
    <li><a id="Menu-Reports-More..." href="reports.php">More...</a></li>

And replace it with:

    <li><a id="Menu-Reports-Daily_Performance" href="reports.php?report=daily_performance">Dzienna Działalność</a></li>
    <li><a id="Menu-Reports-Income_Forecast" href="reports.php?report=income_forecast">Prognozy Przychodów</a></li>
    <li><a id="Menu-Reports-Annual_Income_Report" href="reports.php?report=annual_income_report">Sprawozdanie Roczne</a></li>
    <li><a id="Menu-Reports-New_Customers" href="reports.php?report=new_customers">Nowi Klienci</a></li>
    <li><a id="Menu-Reports-Ticket_Feedback_Scores" href="reports.php?report=ticket_feedback_scores">Oceny Zwrotne Zgłoszeń</a></li>
    <li><a id="Menu-Reports-Batch_Invoice_PDF_Export" href="reports.php?report=pdf_batch">Eksport Faktur do PDF</a></li>
    <li><a id="Menu-Reports-More..." href="reports.php">Więcej...</a></li>

Of course, following the scheme above, you can link here more shortcuts to other reports or change the default ones.
If you use other themes in the admin panel, the above step should be followed in the similar manner.

PL 13.png
That's all. From now on, whenever you open any of the reports, you will see its Polish version.


Important: If you upgrade your WHMCS to a newer, full version, the report translation files will be overwritten by their English counterparts (unless you renamed them earlier).
In this case, you will need to upload the translated versions again.

PL 14.png
Important - on the reports list ( '.../reports.php' ), these will continue to appear in the original English names and untranslated categories.
This is due to the fact that WHMCS derives the names of these reports from the .php file names.
If you wish, you can rename the report files yourself so as they will be displayed in Polish as well, but then each of these reports will be moved to the 'Other' category.
This is due to the fact that WHMCS assigns reports to a particular category using the original report file names.
A similar problem also takes place with some elements of the reports, such as names of months, weekdays or currency selection records, still appearing in the original English form.
Unfortunately, changing the above mechanisms and translating these records is not currently possible due to their direct implementation in the '(...)/admin/reports.php' file, which is encoded by WHMCS.
If you have any questions regarding this matter, or if you wish to know whether it is going to change with the following WHMCS updates, we recommend that you contact WHMCS support directly.
PL 15.png

Translation of Widgets

The installation of widgets translation is optional. If you wish, you can skip this step.

By default, WHMCS does not provide translation of widgets via language file, and the records required for translation are hardcoded in the widget files themselves.
To make translation possible, the original widget files based on those from WHMCS V7.8.2 were modified.

For this reason, installing a translation will overwrite the original English version of the widgets in your WHMCS system!

1. We recommend that you make a copy of the original files before you upload Polish version of widgets.

Go to the directory:

/yourWHMCS/modules

and change the name from 'widgets' directory to e.g. 'widgets_backup' .

PL 16.png
2. Then, in the ( '/yourWHMCS/modules' ), upoload the directory with widgets translation named 'widgets_RenameMe' .

And then change its name to 'widgets' .

Note: If you have any additional widgets installed, such as ModulesGarden Widget For WHMCS, remember to move their files from the backup folder to the main widgets folder.

PL 17.png
That's all. From now on, whenever you open the dahsboard of your WHMCS admin area, all widgets will be displayed in Polish language.


Important: If you upgrade WHMCS to a newer, full version, the widget translation files will be overwritten by their English counterparts.
In such a case, you will need to upload the localized versions again.

PL 18.png

Configuration and Management

Language in Admin Area

Personal Admin Account

Set up the language of your preference to use when logged in to the admin area.

To do so, move to: 'My Account', find 'Language' option and select 'Polish' from the dropdown menu.
You will also need to confirm your administrator password before saving the changes.

Note: In case you have not uploaded the files correctly, 'Polish' language will not appear on the list to select.

PL 3.png
In order to set up a language choice for any other administrator, follow to: 'Setup' → 'Staff Management' → 'Administrator Users' and open the selected admin's details page.
PL 4.png
There, find the 'Language' option and select 'Polish' from the dropdown menu.

Do not forget to save the changes.

PL 4 1.png
From now, this administrator, once logged in, will navigate the WHMCS admin panel in Polish.
PL 4 2.png

Default Clients' Language

In order to change the language for all visitors and customers in your system, please follow the below steps:
  • Follow to: 'Setup' → 'General Settings' → 'Localisation'.
  • There find the 'Default Language' option and select 'Polish'.

Remember to save the changes.

PL 5.png
Underneath, there is also an option: 'Enable Language Menu'.

Make sure this option is enabled if you want to allow visitors to choose the language in your client area.

Important: If enabled, clients may always freely change the language even if an administrator has previously set up a different language for them in general settings.

PL 6.png
If you aim to set up the language for a single client, please follow the below steps:
  • Follow to: 'WHMCS' → 'Clients' → 'View/Search Client' → 'Client Profile' → 'Profile'.
  • There find the 'Language' option and select 'Polish'.

Remember to save the changes.

From that moment, the client, when enters your client area, will have it open in Polish!

PL 7.png

Language in Client Area

Every client may alter the language by themselves directly, when logged into client area account.

In the top, right corner, there is a language configuration dropdown. Press and select 'Polish'/'Polski' language.
The language of your WHMCS client area account will be altered immediately. There is no need to save or confirm the changes.

PL 8.png
Of course, unlogged users and guests may also enter your client area with the language of their wish!

The option to change it is located at the very same place, that is top, right corner.

PL 9.png
From now, your clients may continue with the language of their choice!
PL 10.png

Geolocation Hook Integration

You are also given a unique opportunity to automatically switch the language in your client area for your clients and which is more surprising, even guests!

All you need to do is download our Geolocation Hook For WHMCS which is completely free of charge!
Configure it to change the client area language according to the visitor's location IP address based and let your clients work with ease on the system in their mother tongue!

Tips

1. Polish Language Translation For WHMCS files may be edited and updated according to your needs.

It is advised to use a copy of the file to avoid overwriting your changes when an updated version is uploaded. You can also use Overrides for strings customizations.

2. Translation files do not cover email templates as these are not included in the original english.php file.

If needed, they must be edited and translated directly in the system.

3. The content of Polish language translation files has been extended with commented out, original lines in English.

The original versions have been added to facilitate the process of introducing any changes in the translation.

4. Thanks to the 'Easy Translation' feature built into WHMCS, you can translate the names and descriptions of your products, groups, support departments or custom fields.

Due to specific functionality of this WHMCS feature, we recommend setting the 'Default Language', in 'Setup' → 'General Settings' → 'Localisation', to the English language for the time of performing the translation.
After you have prepared your own translations, you can change it back to Polish if you want it to be used by default in the system.
This way you can avoid inconsistency when switching from one language to another later on.

Instrukcja Aktualizacji

If you want to update the translation to a new version, simply overwrite the old Polish files with the new ones, as you did in installation steps].

Please also remember that any major update of WHMCS itself may overwrite the translation of reports and widgets files if there are any installed.
In that case, it should be enough to upload the translation files contained in '/modules/reports_RenameMe' and '/modules/widgets_RenameMe' directores again into the corresponding WHMCS 'yourWHMCS/modules/reports' and 'yourWHMCS/modules/widgets' directories.

Common Problems

1. Please be assured that all existing language strings have been translated. Despite that, there might be places in your WHMCS where some lines appear in English.
That might be due to single deficiencies in original WHMCS language files, used template or other WHMCS settings. In such cases, please contact WHMCS team and report the issues.
2. There are single translation lines which are used in more than one place in the system. Due to the complexity of Polish language, their translation might not be perfectly suitable in all situations.
3. The 1.0.0 version of the translation was prepared for WHMCS V7.7.1, while the 1.1.0 version corresponds to the WHMCS V7.8.2. Despite this fact, they both can be safely used with any other version, even WHMCS V5.

Yet, in such a situation you must be aware that some records translation might be missing as WHMCS continue to delete those lines that are no longer in use.
All such missing records can be easily translated on your own, for example, using Overrides.

4. When using the Lagom theme, the client area may contain untranslated phrases in the form of function names (e.g. generals.my_dashboard, etc.).
This problem is caused by the lack of built-in support for the Polish language in the Lagom theme, which uses its own additional translations.

To fix this, you should add the missing phrases to this theme on your own using the method described here.

5. If you encounter a problem with encoding Polish characters in PDF invoices, check your font selection in 'Setup' → 'General Settings' → 'Invoices'.

By default, the selected PDF font family 'Helvetica' does not support Polish encoding. We recommend using 'Dejavusans', 'Freesans', or your custom font.

6. Since version 1.1.0, a translation of WHMCS built-in reports is available. However, the translation does not cover the main page with the list of reports (.../admin/reports.php), so the report names and their categories on this page remain untranslated.

This is due to the fact that WHMCS does not allow for a direct modification of records contained in this page.

Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Polish Language Translation For WHMCS