X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FTranslations.md;h=dd42bf3056e79625d4246907404e8eb4ba7f874c;hb=3ee8351e438f13ccf36062ce956e0b4a4d5f4a29;hp=c7d3385532451c031661f202e33f2f6aa2fdf61f;hpb=68c6afc56f3758154cfb96cba6fd48a6b5535590;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/Translations.md b/doc/md/Translations.md index c7d33855..dd42bf30 100644 --- a/doc/md/Translations.md +++ b/doc/md/Translations.md @@ -7,8 +7,8 @@ Note that only the `default` theme supports translations. ### Contributing -We encourage the community to contribute to Shaarli's translation either by improving existing -translations or submitting a new language. +We encourage the community to contribute to Shaarli's translation either by improving existing +translations or submitting a new language. Contributing to the translation does not require development skill. @@ -21,8 +21,8 @@ First, install [Poedit](https://poedit.net/) tool. Poedit will extract strings to translate from the PHP source code. -**Important**: due to the usage of a template engine, it's important to generate PHP cache files to extract -every translatable string. +**Important**: due to the usage of a template engine, it's important to generate PHP cache files to extract +every translatable string. You can either use [this script](https://gist.github.com/ArthurHoaro/5d0323f758ab2401ef444a53f54e9a07) (recommended) or visit every template page in your browser to generate cache files, while logged in. @@ -32,26 +32,26 @@ Here is a list : ``` http:/// http:///?nonope -http:///?do=addlink -http:///?do=changepasswd +http:///admin/add-shaare +http:///admin/password http:///?do=changetag -http:///?do=configure -http:///?do=tools -http:///?do=daily +http:///admin/configure +http:///admin/tools +http:///daily http:///?post -http:///?do=export -http:///?do=import -http:///?do=login -http:///?do=picwall -http:///?do=pluginadmin -http:///?do=tagcloud -http:///?do=taglist +http:///admin/export +http:///admin/import +http:///login +http:///picture-wall +http:///admin/plugins +http:///tags/cloud +http:///tags/list ``` #### Improve existing translation -In Poedit, click on "Edit a Translation", and from Shaarli's directory open -`inc/languages//LC_MESSAGES/shaarli.po`. +In Poedit, click on "Edit a Translation", and from Shaarli's directory open +`inc/languages//LC_MESSAGES/shaarli.po`. The existing list of translatable strings should have been loaded, then click on the "Update" button. @@ -63,20 +63,20 @@ Save when you're done, then you can submit a pull request containing the updated #### Add a new language -Open Poedit and select "Create New Translation", then from Shaarli's directory open +Open Poedit and select "Create New Translation", then from Shaarli's directory open `inc/languages//LC_MESSAGES/shaarli.po`. -Then select the language you want to create. +Then select the language you want to create. -Click on `File > Save as...`, and save your file in `/inc/language//LC_MESSAGES/shaarli.po`. -`` here should be the language code respecting the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) +Click on `File > Save as...`, and save your file in `/inc/language//LC_MESSAGES/shaarli.po`. +`` here should be the language code respecting the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) format in lowercase (e.g. `de` for German). Then click on the "Update" button, and you can start to translate every available string. Save when you're done, then you can submit a pull request containing the new `shaarli.po`. -### Theme translations +### Theme translations Theme translation extensions are loaded automatically if they're present. @@ -85,7 +85,7 @@ As a theme developer, all you have to do is to add the `.po` and `.mo` compiled tpl//language//LC_MESSAGES/.po tpl//language//LC_MESSAGES/.mo -Where `` is the ISO 3166-1 alpha-2 language code. +Where `` is the ISO 3166-1 alpha-2 language code. Read the following section "Extend Shaarli's translation" to learn how to generate those files. ### Extend Shaarli's translation @@ -106,7 +106,7 @@ First, create your translation files tree directory: Your `.po` files must be named like your domain. E.g. if your translation domain is `my_theme`, then your file will be `my_theme.po`. -Users have to register your extension in their configuration with the parameter +Users have to register your extension in their configuration with the parameter `translation.extensions.: `. Example: @@ -151,11 +151,11 @@ When you're done, open Poedit and load translation strings from sources: 1. `File > New` 2. Choose your language 3. Save your `PO` file in `/languages//LC_MESSAGES/my_theme.po`. - 4. Go to `Catalog > Properties...` + 4. Go to `Catalog > Properties...` 5. Fill the `Translation Properties` tab 6. Add your source path in the `Sources Paths` tab 7. In the `Sources Keywords` tab uncheck "Also use default keywords" and add the following lines: - + ``` my_theme_t my_theme_t:1,2