Article Index
The backend of BwTransifex contains a list of all projects. Here You create, edit and delete the projects and update the language packages.
A project of BwTransifex is an extension, for which language packages shall be created and updated, whose translations are located at transifex.com.
Create project
A click to the button New at the toolbar on top opens the view project details. This view shows as first tab the Project Details, other tabs are Transifex Settings, Publishing and Advanced Settings.
At the toolbar on top right You find the button Inline Help, with which You may toggle help texts.
Tab Project Details
Here You enter general data to the project.
Project Name
This is the name of the project, how it is used internally and for the views at frontend.
Alias
The alias of the project. It will be generated automatically if You don't enter something.
Description
A description for the project.
Status
The status of the project, how it is common at Joomla!®: Published, Unpublished, Archived and Trashed.
Access
The access level group that is allowed to view this project how it is common at Joomla!®.
Tab Transifex Settings
These are the specifications that are needed for the communication with transifex.com.
Extension name
The name of the extension used in the manifest for each language package.
Transifex project slug
The name of the project how it is set at transifex.com.
This is the identifier to get the data of the project from transifex.com.
Transifex Configuration
The settings here are ini-file-like with sections. A section for each language file is required, optionally You may provide a section main.
Resource sections (required)
The name of the section is an identifier for the resource, how the API of transifex.com needs it and is composed of the organization, the project name and the resource name, deposited at transifex.com. It looks like
[o:<your-organization>:p:<project-name>:r:<resource name>]
Required settings are:
file_filter:
The path to the language file based on Your Joomla!® installation path.
Optional settings are:
minimum_percent
If You want to process only files which are translated for at least minimum_percent. Defaults to 0.
source_lang
If You want to use a different source language for this resource than set at the options of BwTransifex or the main section of this project.
Section main (optional)
lang_map
If You want to use a different language mapping than provided at the options of BwTransifex.
Project Version
The current version of the project for which the language packages shall be created.
Path to update servers
Here You have to enter the path to the update servers for the language packages, based on base folder of the Joomla! installation. But this also means, that the update servers for the language packages have to be placed within this webserver.
Replacement list
A list with key->value pairs to replace in the language files. Ini-file-like without section, separator between key and value is the equal sign =. Spaces around the equal sign are as is.
These are the variables You can use:
@@VERSION@@ for the new version of the language packages,
@@YEAR@@, @@DATE@@, @@TIME@@, @@CREATION_DATE@@ for dates,
@@EXTENSION_NAME@@ for the name of the extension
@@AUTHOR@@, @@AUTHOR_EMAIL@@ and @@AUTHOR_URL@@ for particulars to the creator of the language packages,
@@COPYRIGHT@@,
@@DESCRIPTION@@,
@@LANGUAGE@@,
@@UPDATE_SERVER@@
Determine location
BwTransifex has to detect, if a resource belongs to the backend or to the frontend. A resource is the name of the language file specified at transifex.com. To do so, there are two options:
File filter
If you choose File filter, then BwTransifex will use the declaration of file_filter specified in each resource section of the transifex configuration at left for each resource.
Resource name
If you choose Resource name, then BwTransifex will look at the name of each individual resource.
For both options is valid:
If BwTransifex finds one of the words admin, administrator or backend, then this file belongs to the backend. Otherwise the file is applied to the frontend.
Contribute link
Should a contribute now link for languages appear at the frontend? The link appears at the frontend at the single view for a language of a project.
Contributor info
The text entered here will be displayed on single view for the language of a project. Use it to motivate your users to contribute to the translations.
Tab Publishing
These data are mainly for information.
Created Date
The date the project was created it is filled automatically. It can be modified manually.
Created By
The name of the creator of this project is filled automatically. It can be modified manually.
Modified Date
Date of the last modification of the project
Modified By
The name of the person who lastly modified the project
Project ID
The internal ID of this project.
Tab Advanced Settings
Update always?
Default is off. To save time, language packages are only created, if there are new or changed language stings at transifex.com or there is a new project version.
Set this option only to on, if You have problems with downloading language packages or the downloaded language packages are not up-to-date. That means especially, the download for a language package is displayed at the front end, but there is no language package to download. This options ensures, the language packages are created, even if there are no new or changed language stings or there is no new project version. Switch back to off, if problems are solved.
Update language packages of a project
Language packages of a project are updated at the backend. To do so You have to enter the new project version for the desired extension at the tab Transifex Settings. Save & Close leads back to the list. There You click the button with the two arrows at the column status of the extension. A modal window opens with the message, that the update may take a while.
A click to Load data starts the creation of the language packages for the new version of the extension. While processing, the buttons to close are hidden to prevent an accident. When the language packages are created, the buttons are displayed again and You may close the modal window.
If errors occur while updating the language files, they are shown at the modal window and depending on the severity of the error the update is going on or is cancelled. If the update is cancelled, this should happen in a well-arranged manner, so that the modal window may be closed.
If an error occurs, which is not even known and which I don't catch so far, it may happen, that the modal window may not be closed in an well-arranged manner, because the buttons to close don't appear. In this case, only the back button of the browser may help. In this case I would be very grateful to get a note at the forum, if possible with a description as accurate as possible. As a developer You know, what I mean.
Create menu entries for the frontend
To be able to provide the language packages for downloading, BwTransifex offers the possibility to create menu entries for the frontend.
Whether You create a menu of its own for BwTransifex or You use an existing menu for the menu entries is Your decision, as well as which menu entries You offer. I suggest at least one menu entry for the list of the existing extensions with language packages.
As menu entries for BwTransifex there are:
- All projects
- Single project
The menu entries are created the known way of Joomla!®:
At the backend at menus You add the desired menu entries at an existing menu or You create an separate menu with the desired menu entries and appropriate module.
All Projects
For this menu entry there is not much to tell. It is a simple link to the list of the projects of BwTransifex. Only projects appear, for which the user has the access rights.
Single Project
For this menu entry You have to select at project, which the menu entry shall display. like You do for Joomla!® articles or categories. Also the behaviour is Joomla!®-like: If the user does not have the appropriate access right, this project is not displayed an an error message occurs.