This is a documentation and answers of some frequently asked questions about ITP Transifex. The article describes the process of installation and configuration.
- Download and install
- Additional information
- Technical Requirements
- Import and Export
- Best practices
- How to import a project?
- How to make a copy of packages in a new language?
- How to translate ITP Transifex?
- How to debug the extension and catch an error?
- How to get FREE support?
- How to upgrade the extension?
- How to get support?
Download and install
Go to "Extension Manager" and install the package.
If you are installing the extension for the first time, you will see a list of installed libraries, plugins and modules. You will also see a list of minimum requirements. If the system displays red indicators for unfulfilled requirement, it will be good to find a way to fix it.
You will find additional information in the following pages:
You must install Prism Library because the extension needs it to work properly.
The minimum requirements to run the extension properly are:
- Joomla! v3.6
- PHP 5.5
- MySQL 5.1
- jQuery 1.9.x
- cURL, fopen
- Magic quotes disabled
- mod_rewrite loaded on the server
- Fileinfo loaded
- Bootstrap 3 based template
It is a time to configure ITP Transifex. Go to "Dashboard" and click on the button "Options". Review the settings and save them.
You have to enter information about you or your company. That information will be used when the system generates language packages.
You also have to enter username and password of your Transifex account. They will be used from the system to make a request to theirs API.
The languages will be used in the process of downloading translations from Transifex. You will have to select one of those languages when you create a package.
This is a copy of your project on Transifex. You have to start from here, creating a project. It is necessary to enter name and slug of a project.
The slug is a part of your project URL on Transifex.
When you create a project, you have to get information for its resources. To do that, you have to select the project from the list and click on the button "Update".
The resources are language files, which have been added to your project on Transifex. The system only downloads information about the source of language files.
When the information be downloaded for first time, it will miss some necessary data. That data will be used in the process of creating projects.
It will miss the filename, which will be used to be stored the resource, when it be downloaded.
It will also miss the type of the resources. The type will be used from the system to know where to store the resources. There are two types of the resources - admin or site ( back-end or front-end ).
You have to enter a filename and select a type for every resource.
NOTE: If you follow best practice of adding resources, you will provide enough information to the system. So, the system will be able to create filename and to select type automatically.
The packages contains translated language files, which can be installed on Joomla! website. You should follow next steps to create a package.
1. Go to project resources.
2. Select the resources that will be part of the package.
3. Click on the button "Create Package"
4. Enter a package name and file name.
5. Select language and extension type.
Now, you are able to create and download Joomla! language package.
- Go to Packages Manager.
- Select a package.
- Click on the button "Download".
The system will download translated resources from Transifex and will create a package, which you will be able to install on your Joomla! website.
Import and Export
This section gives you a functionality to export your projects in an XML file. The system will export data about a project, its packages and resources. So, you will be able to share it with other people or to publish it on Transifex Projects GitHub repository.
Alternatively, you can import projects using those files with meta data.
If you are developer and you would like to provide language packages for your extensions, you should follow these best practices when you upload resources on Transifex.
That will provide enough information to ITP Transifex and the system will download the resources properly.
Enter resource type
When you upload a resource, you have to enter its type at the beginning of its name. There are five types that you can use:
[ADMIN] - This should be used for files of a component that will be stored in its back-end folder.
[SITE] - This should be used for files of a component that will be stored in its front-end folder.
[PLUGIN] - This should be used for language files of a plug-in.
[MODULE] - This should be used for language files of a module.
[LIBRARY] - This should be used for language files of a library.
Edit resource on Transifex
When you are done with the uploading, you have to edit the resource. Go to its settings and...
- Edit its SLUG
- Remove the language code
- Remove the extension of the file "ini" from the end of the slug.
- If it is sys file, you have to split the phrase with slash "_".
- Enter the type of the resource as category. You have to enter only one category. You can enter admin, site, plugin, module or library.
The SLUG admin-en-gbcom_crowdfundingini becomes admin-com_crowdfunding.
The SLUG admin-en-gbcom_crowdfundingsysini becomes admin-com_crowdfunding_sys.
For more example, you look the resources of the Crowdfunding Platform.
How to import a project?
This video will show you how to import a project from metadata file.
You can download projects metadata from ITP Transifex Projects repository.
How to make a copy of packages in a new language?
This video shows how to make a copy of a package from another one.
How to translate ITP Transifex?
You can translate this extension in your language using Transifex. Go to the system and sign in. Find ITP Transifex translation project and start translating. If you need more information, read the article "How to translate ITPrism extensions in your language?"
How to debug the extension and catch an error?
If there is a problem with the extension and the system does not display error messages, you should debug it. That will give you more information about the problem.
- Go to "System" -> "Global Configuration" -> "System" -> "Debug Settings".
- Set to "Yes" the option "Debug System".
- Now go to tab "Server" and set option "Error Reporting" to maximum.
Now, the system should display information about the error.
You can also check log files in folder "/logs" or the log file "error_log" in your main folder.
How to upgrade the extension?
The better way to upgrade the extensions is:
- Make a backup of your site ( database and files ) ( optional but highly recommended );
- Install the new version over the old one ( all previous data will be saved );
- Check the extension settings and menu items for changes;
- Check for a new version of Prism Library. If there is a new version, install it.
- You should also upgrade all other modules and plugins, which work with ITP Transifex.
It is a good practice to have a copy of your website on a subdomain. It can be something like test.mywebsite.com. You should upgrade ITP Transifex on this test site first. That will be useful for you because you will be able to explore the newest features and configuration options. When all is OK, you will know how to upgrade the extension on your production website fast.
How to get support?
You can post issues on ITPTransifex GitHub repository. If you have any questions, you can send me a mail from the contact form. If you need premium support you are able to subscribe for my premium services on ITPrism members site.
How to get FREE support?
You can report issues on ITPTransifex GitHub repository.
If you have any questions, you can send them to me, using the contact form. Please, send me a message with only one question. When I answer you, you will be able to send me your next one.