Skip to content

Commit

Permalink
Updated maintainer instructions for updated translation flow
Browse files Browse the repository at this point in the history
  • Loading branch information
Florian committed Jan 27, 2016
1 parent c5a6366 commit e75cf18
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions maintain/translations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

Pagekit supports i18n for its interface. Translations are managed on [Transifex](https://www.transifex.com/pagekit/pagekit-cms).

Several tools are available to extract translatable strings from the Pagekit source files (step B) and to pull available translations from Transifex into the Pagekit source (step D).
Several tools are available to extract translatable strings from the Pagekit source files (step B) and to pull available translations from Transifex into the Pagekit source (step D and E).

Translatable strings are located in `*.pot` files, i.e. `app/system/languages/messages.pot`. Translations are located in `*.php` files, i.e. `app/system/languages/de_DE/messages.php`. While both kind of files are located in the repository, pull requests are to be rejected. All contributions should happen via Transifex (and the pot files are generated automatically - see step B).
Translatable strings are located in `*.pot` files, i.e. `app/system/languages/messages.pot`. Translations are located in `*.php` files, i.e. `app/system/languages/de_DE/messages.php`. While `*.pot` files are located in the repository, pull requests are to be rejected. All contributions should happen via Transifex (and the pot files are generated automatically - see step B).

## A. Configuration

Expand Down Expand Up @@ -37,7 +37,16 @@ You need:

*When?* Before every release.

*What happens here?* For any languages with existing translations on the Transifex project, the translations are downloaded, converted to a PHP array and saved to the right folders in Pagekit.
*What happens here?* For any languages with existing translations on the Transifex project, the translations are downloaded, converted to a PHP array and saved to a separate `languages` repository.

1. `php pagekit translation:fetch pagekit/blog --username=<USER> --password=<PASSWORD>`
2. Commit & push the new files
1. Clone `https://github.com/pagekit/languages` and follow the setup instructions in the README
2. Run `php update.php` in the cloned repository. All current translations are fetched
3. Commit & push the new files

## E. Fetch translation strings from translation repository and merge into Pagekit installation

*When?* When you need translation files during development. Not needed before build, because build task does this automatically.

*What happens here?* Language files are fetched from the languages repository and sorted into the right languages folder (of system, extension-blog and theme-one).

`php pagekit translation:fetch`

0 comments on commit e75cf18

Please sign in to comment.