User guide

Translating Tutorial

    Note: This tutorial refers mainly to the development build of Zenphoto since localization/translation is a work in progress. Zenphoto includes a file "zp-core/functions-l18n.php" that contains a prefdefined list of languages and their related locales. Check this list to be sure your language is included. If it is not there, let us know and we will add it.

    What should I know before starting a translation?

    All existing complete or uncomplete translations are included in the Zenphoto release package. The language selector on the backend options indicates the status how current a translation is. 

    It would be good if you were quite confident in written English and quite comfortable with Zenphoto itself and with web developement terms in general, although no coding is required to make a translation.
     
    Keep in mind that if you volunteer to make translations there will be the need of updating the languages files at least for every official release since Zenphoto is a work in progress. You may make your translation based on the current release of zenphoto. Then it can be provided to most Zenphoto users.

    The translation mailing list

    You should join the Google Zenphoto translator's group. Here you can query if anyone else is working on your language. If so, a collaboration should be possible. There you will find other like-minded people and be able to ask questions and share experiences. Also the development team is on this list.

    Also the developers post pre-announcements of up-coming Zenphoto releases to this group to give you a heads up so you can get your translations into that release.

    Submitting a translation via GitHub

    You need a GitHub account and have to create a Git controlled Zenphoto installation of the GitHub development version preferredly on a local server using WAMP, LAMP or MAMP. 

    If you update the languages there you can directly update them via GitHub.  For more on this please read about how to update Zenphoto using GitHub

    Then there are two ways to contribute a translation using GitHub:

    1. Become a member of the Zenphoto GitHub translators team

    The translation mailing list is also the place to ask for becoming part of our GitHub translators team (= getting commit rights) so you can update your translation there yourself. You will need a GitHub account to contribute. 

    If you wish your translation to be included in the release package and like to contribute regulary this is the only way to go. Please only ask if you really would like to contribute as a regular translator.

    For more on this please read about how to update Zenphoto using GitHub

    If you prove to be a reliable and frequently committed translation contributor we also may ask you if you would like to get an translator entry on our Zenphoto team page. We really do appreciate the time and work ”“ one of our developers maintains the German translation and knows about this ”“ that needs to be put into a frequently updated translation and would like to honor frequent contribution this way

    2. Using Pull requests

    You can contribute without such commit rights as well using pull requests on GitHub. See instructions here: https://help.github.com/articles/using-pull-requests

    Development build or official release?

    It is recommended to make your translation against the development build on GitHub. This way it will be ready for and matched up to the next release of Zenphoto.The work will be outdated initially since there are changes all the time otherwise.

    Currently there way are over 4000 strings that need to be translated so it does not really make sense to start with an older or already release Zenphoto version. Some of these strings are only single words though, some are doubled for specific reasons. Since we change strings here and there all the time we recommend doing updates frequently at least once a week, so it will be much easier to match a given release date of the next version. You simply will have less that way than doing all at once. So better think twice before your volunteer...:-) More on that in detail later.

    Licence of your translation

    Just to note: Since a translation falls under copyright, your submitted translation should be provided under a open licence compatible to Zenphoto's GPL v2 or later licence. If no special licence note is attached, we will assume GPL.

    How does Zenphoto's translation work?

    Zenphoto uses the gettext technology to provide translation and localization capability. Currently this requires native gettext support, meaning gettext needs to be installed as a binary PHP extension on your server. 

    Zenphoto uses the message-level for translation. We use the standard gettext functions gettext() amd ngettext() to translate strings. If you are working with Zenphoto you might have spotted strings that look like this in the code:

    Singular:

     <?php echo gettext("some text"); ?>
    


    Plural (actually rarely used):

     <?php echo ngettext("1 apple","2 apples"); ?>
    


    If a translation is found, "some text" will be replaced by the translation string. If no translation is found, simply "some text" is used.

    Additionally Zenphoto uses translatable format strings rather than gettext fragments only (post Zenphoto 1.2).  You will also see strings that look like:

    Singular:

    <?php printf(gettext("text %s"),$var); ?> 
    


    Plural:

     <?php printf(ngettext("%s apple","%s apples",$var),$var); ?>
    


    The things which begin with % are parameters that get filled in at runtime. We are using sprintf/printf to format the output. If you are not familiar with these functions you can review the format variables here: http://us3.php.net/manual/en/function.sprintf.php.

    The quick lesson is that the above example has two numbers that will be filled in at runtime. %1$u is the first in the list and %2$u is the second. So the output from this would look like:

    Album 5 of 10

    If you wish to reverse the order of the elements you just change their place in the string while translating:

    'Of %2$u albums this is number %1$u'

    would yield

    Of 10 albums this is number 5

    In short: These variables are required to be included in your translation as well as any html code that may be within a string.

    Which language translation to use you can set within the admin options of Zenphoto. There is a separate option for setting the date-format, too. The translation is provided then for the admin interface, setup.php and the standard themes and plugins included in the distribution. Month and day names do not need to be translated manually, these will be done automatically by your server, assuming that your server operates on your (chosen) country's locale.

    Language files and naming conventions

    Zenphoto gets the translation terms itself from a .mo-file (machine object file). This file is binary and contains the original text and the translation. But the actual file to translate is a .po-file (portable object file). 

    File and folder structure

    Both files are stored within zp-core/locale with the following standard folder structure:

    de_DE/
    de_DE/LC_MESSAGES
    de_DE/LC_MESSAGES/zenphoto.po
    de_DE/LC_MESSAGES/zenphoto.mo
    


    The folder structure and the filenames are mandatory. You would have to provide an archive of exactly this structure for your language.

    Since the .mo-file is binary, you can't work directly with it, so you have to work with the .po-file instead. This is a normal text file, that looks like this:

    msgid ""
    msgstr ""
    "Project-Id-Version: zenphoto 1.1.5 svn\n"
    "Report-Msgid-Bugs-To: \n"
    "POT-Creation-Date: 2008-04-09 17:50+0100\n"
    "PO-Revision-Date: 2008-04-09 17:56+0100\n"
    "Last-Translator: john smith \n"
    "Language-Team: john smith\n"
    "MIME-Version: 1.0\n"
    "Content-Type: text/plain; charset=UTF-8\n"
    "Content-Transfer-Encoding: 8bit\n"
    "X-Poedit-Language: German\n"
    "X-Poedit-Country: GERMANY\n"
    "X-Poedit-SourceCharset: utf-8\n"
    "X-Poedit-Basepath: /Applications/MAMP/htdocs/zenphoto-svn/\n"
    "X-Poedit-SearchPath-0: zp-core\n"
    "X-Poedit-SearchPath-1: themes\n"
    #: zp-core/admin-functions.php:169>
    msgid "A reset request has been sent."
    msgstr "Eine Reset-Anfrage wurde gesendet."
    (...)

    Note: the "Project-id-Version" text must be manually inserted to indicate the version of Zenphoto for which the translation corresponds. If you use Poedit to translate you can set this on the catalog properties. See "Starting a new translation".

    Upload page upload button

    Zenphoto 1.2.5 introduced a new multi file flash upoad that does not allow special characters due to a limitation of the flash script. This requires the creation of an image with your translation serving as the upload button. This button must be named select_files_button.png placed in above folder structure:

    de_DE/select_files_button.png
    

     


    We have preprepared a .psd template file for download with instructions in the attached read me file.

    Language flag image

    Zenphoto 1.3.2 has introduced a "visual" language selection feature. For this an 24 x 16 px image named flag.png must be placed within your locale folder:

    de_DE/flag.png
    


    Should the image be missing an "error flag" will be substituted.

    Translation tools

    You can edit the .po-file with any text editor. But you have to transform it into a .mo-file to be used for translation. There are several tools that can do that for you:

    The official GNU gettext package includes command-line tools, but you might prefer a real editor with a GUI. For Linux based systems there are for example LaunchPad or KBabel and others, but considered the standard tool for this is Poedit which is available for Windows, Mac and Linux.

    We would recommend Poedit (well, we don't really know the others..:-)) and the description in the next section uses it. But probably the setup for another editor will be not that different.

    Starting a new translation

    There are basically two ways to start on a translation: You could use one of the translation files  included in the Zenphoto distribution and change it to your language. Or you can parse the Zenphoto package yourself using Poedit.
    The second is the way we would recommend, because you then can be sure that you don't miss any string since we update and change all the time. And it saves workload if you update the file more often than just once when a new version comes out.

    1. Download and install Poedit.
    2. Download the latest nightly build of zenphoto and extract the files the same folder where Poedit is or a folder level below. Poedit needs a absolute path to work correctly. This does not need to be within a localhost server setup like WAMP, LAMP or MAMP, but of course this would be very useful to test your translation.
    3. On Mac OS X the folder to parse is best located on the same level or below Poedit's location in the Applications folder, since the paths to are relative from Poedit's location:
      Zenphoto folder: /Applications/MAMP/htdocs/zenphoto
      Poedit: /Applications/Poedit
      Also working is simply the folder (as used on 6.):
      Zenphoto install: /Applications/zenphoto
      Poedit: /Applications/Poedit
      On Windows that folder setup seems not to be that important.
    4. Do not install any additional plugins or themes besides the already included ones as some may included additional gettext calls (and separate translation files) that are not necessary for Zenphoto's own translation file and bloat the file unnessecarily.
      Then open zenphoto/zp-core/locale in your zenphoto installation, duplicate the de_DE folder or any other folder and rename it to match your locale.
       
    5. Now open Poedit and select "New Catalog":
      1-4-new-catalog

    6. In the appearing setttings window enter your data. Most are pretty obvious, only language, country and charset are mandatory. Set the charset to UTF-8. Then you have to enter the string  for "Plural forms" because in a few places Zenphoto uses gettext plural forms. For example English has two forms (e.g. day/days) so this would be nplural=2; plural(n !=1);. Other languages require different settings. More info about that on the gettext plural page.1-5-general-data
      Please set the Zenphoto <version> correctly to indicate the version of Zenphoto for which the translation corresponds- This will be displayed on the admin language selector.
    7. Next you need to set the path of the zenphoto folder to parse. (See also 2.) Remember that it is important to divide a path like this C:\Programs\zenphoto into the base path C:\Programs\ and the relative path zenphoto (Mac OS X example shown below). You can ignore the keywords tab, because Zenphoto uses the default gettext keyword
      .1-6-folder-path

    8. In the appearing save window change the name of the file from default.po to zenphoto.po and save/overwrite it within your new zenphoto/zp-core/locale//LC_MESSAGES/ folder (in the image the German locale is used as example).1-7-saving-the-file

    9. You will now see that Poedit searches the zenphoto folder for gettext calls.1-8-building-the-file

    10. Now you see on the left the original english strings. Klick on an line and you can enter the translation for it below. The two field on the right bottom can be used for comments to the translation, but are not really important now. Singular translation will look like this:1-9-translation-window

    11. Plural translation will look like this (see also here about plural strings):
      translation-window-plural

    12. Sometimes you will encounter HTML markup within the strings to translate. We have included them because some languages have a very different syntax that might require changing the order within a string. These markup needs to be included within your translation, too. Also you might think that some strings are completly useless like a lonely ")" or the double point in "View image:" for example. It's not forgotton, but on purpose. There are languages that use not only differenty syntax but completly different characters, too. And some even write from right to left, so these characters need to be changeable, too. Sometimes you might see a string that you don't need or want to translate. Something like "SpamAssassin" is most likely a fixed term for example. You can leave that field empty, but it's recommend to fill in the same term, so simply use the context menu to copy the original string to the translation field.

    13. Some sentences are hard to translate without knowing the context. Poedit's context menu will show you were in Zenphoto the referring string is used.1-9c-copy-original

    14. When you are done with translation just hit save and Poedit automatically generates a .mo-file that is used for the translation called zenphoto.mo. Now you should check your translation with Zenphoto. It's recommended to use your zenphoto folder as a base for future translation updates, so that you don't have to change the parsing path for Poedit all the time. Don't forget to create a upload button!
    15. To submitt your translation to the zenphoto team generate an archive of your locale folder with all its subfolders and upload it to the translation ticket. Since we probably will provide the files as a additional downloads, a common type like .zip or .tar would be good. We actually would prefer if you use SVN to update the release package directly. For more on this please read about how to update Zenphoto using svn

     

    Updating or modifying an existing translation

    1. If you choose to update or modify your own translation or a translation someone else had provided, you can just open the .po-file of that locale with Poedit. IMPORTANT: If that file was not generated by you, you would have to check and change the path to parse to match your zenphoto folder in Poedit's settings!
      2-1-adjusting-settings

    2. If you have done that, hit "Update" and Poedit will now compare the translation file with the zenphoto folder to check if and what strings have changed.If Poedit finds untranslated strings, they will be listed in the window below you already know. The second tab then will show strings that are not used anymore. These will be deleted from the file. (None found in this example).
      2-2-new-strings

    3. If you have worked in that language before, Poedit might have collected some terms in its internal dictionary and will try to autotranslate some strings. These strings are then marked in a dark yellow as "fuzzy". Most of the time Poedit is fairly wrong with its guesses though, so don't count on that.
      2-3-auto-translate
    4. Blue strings are apparently empty, while successfully translated are printed in black (freshly translated ones are marked with a little star). Poedit lists the percentage of translation, the total number of strings plus the fuzzy strings (autotransation attempts), the bad ones and the untranslated in the bottom left footer.
      2-3b-poedit-statistic

    5. When you are finished with you update, hit "Save" again and the .mo-file gets automatically updated. Don't forget to create a upload button if necessary!

     

    Plugin and theme translations

    If you provide a theme or plugin as a third party, its translation is naturally not included with Zenphoto's general translation file. But with post Zenphoto 1.3.2 it is possible to have independent translations files for your theme or plugin.

    Plugin translations

    There are two sources of strings that need to be translated for a theme/site:

    1. The first is items in your database such text to be set in options manually. For these to have multiple languages you will need to have to enable the multi-lingual feature and define the option field multilingual. See the multilingual sites and plugin  tutorials about this.
    2. The second and most prominent is the literal strings in the PHP code that this tutorial refers to. Plugins which are included with the Zenphoto distribution are also handled by the normal processing as described above.

    To set up your plugin for separate translation, you need to enclose every string in your plugin that should be translatable with this special function instead of the standard gettext():

    <?php echo gettext_pl("some text","<yourplugin>"); ?>
    

    This function tells Zenphoto that this string uses its own plugin translation. You should not mix standard gettext() with this in your plugin as Poedit would read these as well and add them to the translation file unnecessarily.

    If your plugin consists of just one single file .php, you have to create an additional folder of the same name next to the plugin file. Use exact this folder setup:

    /plugins/<yourplugin>.php
    /plugins/<yourplugin>/locale//LC_MESSAGES/
    /plugins/<yourplugin>/locale//LC_MESSAGES/<yourplugin>.po
    /plugins/<yourplugin>/locale//LC_MESSAGES/<yourplugin>.mo
    

    Now setup Poedit as described above but only to parse your plugin's folder. Additionally you have to add the keyword "gettext_pl" to Catalog > Settings > Keywords so that the special plugin translation strings are recognized.

    Theme translations

    There are two sources of strings that need to be translated for a theme/site:

    1. The first is items in your database such as image and album descriptions. For these to have multiple languages you will need to have to enable the multi-lingual feature. See the multilingual sites tutorial about this.
    2. The second and most prominent is the literal strings in the PHP code that this tutorial refers to. Themes which are included with the Zenphoto distribution are also handled by the normal processing as described above.

    To set up your theme for separate translation, you just need to enclose every string in your theme that should be translatable with this function instead of the standard gettext():

     <?php echo gettext_th("some text","<yourtheme>"); ?>
    

    This function tells Zenphoto that this string uses its own theme translation. You should not mix standard gettext() with this in your theme as Poedit would read these as well and add them to the translation file unnecessarily.

    You also need need to have a locale folder set up within your theme's folder this way:

    /themes/<yourtheme>/
    /themes/<yourtheme>/locale/ 
    /themes/<yourtheme>/locale//LC_MESSAGES/
    /themes/<yourtheme>/locale//LC_MESSAGES/<yourtheme>.po
    /themes/<yourtheme>/locale//LC_MESSAGES/<yourtheme>.mo
    

    Now setup Poedit as described above but only to parse your theme's folder. Additionally you have to add the keyword "gettext_th" to Catalog > Settings > Keywords so that the special theme translation strings are recognized.

    Joining separate translation files

    Poedit provides the translation memory feature that is a kind of dictionary/database to make this task easier. Some resources:

    Updating the Zenphoto release using GitHub

    You need an account on GitHub. GitHub offers several convenient clients for various systems and there are others out there. This example will use the Mac client but should be similar in others. You find a list of other Git clients here:
    http://git-scm.com/downloads/guis

    Note: This tutorial is about to be extended some time soon. Currently it covers only committing translations to the "master" stream. 

    1. Once you setup your client with your GitHub account and you have been granted commit rights (= been added as a member to the translation team) you will see the Zenphoto repository appearing in the client.
      github-translators01
    2. After you cloned that repository to your local server, you've got a version controlled version listed. You can easily sync with the lastest changes so you always have all new strings to translate
      github-translators02
    3. The GitHub client should note about any change you did to your translation files and offer them to be commited. A speciality of GitHub is that you have to commit your changes first before you can get new files from the repository that changed meanwhile. Be sure to use the "master" branch. 

      Language translation is typically done by individual translators. When no co-operative translation effort is in place, the translator need not maintain any branches, published or otherwise. Instead changes are made locally and committed directly to the appropriate published branch.
      github-translators04
    4. The GitHub clients let you only clone each repository once. If you want to keep your translation clone separate from another local install, so you don't accidentally parse unwanted 3rd party gettext strings, you can just drop the folder with the just cloned repository on the client to get a 2nd one. A bit unfortunate is that they are named the same. You see only which is what if you click on it and look at the top left breadcrum in the client.
      github-translators03

    Creative Commons LicenseThis text by www.zenphoto.org is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.

    For questions and comments please use the forum or discuss on the social networks.

    Related items