Translating ccPublisher

From Creative Commons
Jump to: navigation, search

ccPublisher 2.2 (currently under development) will focus on providing internationalization (i18n) support. This document is a work in progress that describes the translation process which will be used once ccPublisher 2.2 release candidates are available.

Translations for ccPublisher are stored in gettext message catalogs. Message catalogs are text files which associate translated strings with identifiers used by the application. Each string to be translated is referred to as a "message".

Getting Help

The cctools-i18n mailing list at is used for managing translations for ccPublisher. If you are translating ccPublisher into a new language, you are encouraged to join this list. The addition of new messages to be translated will be announced there, and you may ask questions on the list regarding internationalization. The availability of new message catalogs will also be announced there.

Creating A Translation

When translating ccPublisher there are two files which must be copied and editted for the core application. Extensions may have their own message catalogs which need translating (see Translating Extensions for details on internationalizing ccPublisher extensions). The translation resources are located in the resources/locale subdirectory for a development sandbox. Use the following instructions to create a new translation for ccPublisher; these instructions are for translating ccPublisher to the fictional "ya" locale and assume a Linux development environment.

  • Create a locale subdirectory for your new translation
 $ cd resources/locale
 $ mkdir ya
 $ mkdir ya/LC_MESSAGES
  • Copy the template files into the new directory
 $ cp ccpublisher.pot ya/ccpublisher.po
 $ cp p6.pot ya/p6.pot
  • Edit the new files with the translated content. Two areas need editted: the header information and the messages.
    • The header information should be updated with the translator's contact information, email address and the character set used. The character set should usually be utf-8.
    • Each message is defined by two lines; the translated content goes between the quotes on the msgstr line. The msgid line must not be changed.
 msgid "OK"
 msgstr ""
  • You may encounter strings such as "The file %s can not be found."; the %s should be left intact, as ccPublisher will substitute the actual piece of information at run time.
  • Run ccPublisher with the --locale parameter; alternately if working on your default locale, omit the parameter and ccPublisher will use the operating system's default locale information.
 Change to the sandbox root directory
 $ cd ../../.. 
 $ python --locale ya

ccPublisher will recompile the .po files into binary message catalogs (.mo files) when it runs if the .po files are newer or the .mo files do not exist. This feature exists to aid translators.

Translating using poEdit

poEdit is an Open Source cross-platform gettext catalogs (.po files) editor. It is built with wxWidgets toolkit and can run on any platform supported by it (although it was only tested on Unix with GTK+ and Windows, and a alpha build for Mac OS X is just released). It aims to provide more convenient approach to editing catalogs than launching Notepad (or vi) and editing the file by hand.

Just use poEdit's File -> New catelog from POT file... function will easily doing so. It even can compile .po into .mo file in the same time you pressing Save.

Translating under Windows

To translate under Windows, download and install an i18n-enabled release (2.1 or later). In the installation directory you will find a resources directory, which contains the locale subdirectory. Create a new subdirectory under locale with a name matching your new locale. For example, to translate ccPublisher into French, create a directory named fr_FR.

The ccPublisher locale folder (full size).

Copy the template files from locale into your new directory; rename them from .pot to .po.

The .po files for the new locale (full size).

Edit each .po file per the instructions above.

Editting the .po file (full size).

If you are translating ccPublisher to your default locale, simply run ccPublisher to test your translation. If you are translating to a different locale, create a shortcut to ccp.exe and modify it to pass the --locale parameter in.

Editting a shortcut to ccp.exe to specify a locale (full size).

When you run ccPublisher with the new locale, the message catalogs will be compiled and the application should reflect your translation.

ccPublisher running with the French locale specified; note the File menu reflects the change to Dossier (full size).

Translating under Mac OS X

Translations for Mac OS X are currently shipped inside the application bundle. To find the translation files via the Finder, right click on the ccPublisher application and select Show Package Contents. This will open the application bundle in a Finder window. The locale files are stored in Contents -> Resources -> resources -> locale. Navigate to the locale directory and follow the instructions for Linux or Windows.

Translating "How Does This Work"

The text in the help dialog displayed when the user clicks the How Does This Work button on the opening page is not contained in the message catalogs. The help text is included in an HTML file which must also be translated to complete the translation process. The file, welcome.html, is located in the locale directory alongside the .pot message catalog templates; see the appropriate platform section above for information on locating the locale directory. ccPublisher looks for the translated version of welcome.html in the appropriate locale directory (i.e. in the same directory as the translated .po message catalogs). If a translated version is not found, ccPublisher falls back to English.

Submitting a Translation

Once you have completed or updated a translation and tested it, you can submit it to the ccPublisher developers using the Roundup bug tracking system. Click here to create a new issue with the correct default values set. Add the locale information for your new translation to the title and attach the .po and .html files you created (either individually or in a zip/tar file).

We encourage people submitting bugs and feature requests via Roundup to create accounts so they can easily monitor issues they create.

Updating Translations

Strings are sometimes added or removed from the application during development cycles. At those times it is necessary to update the translation (.po) files with the new strings and translations.

Using poEdit

If you are using poEdit, you can use the Update from POT file... option. Go to the Catalog menu and select Update from POT file.... Select the .pot file which cooresponds to the translation you have open (i.e. if you are updating ccpublisher.po, select ccpublisher.pot).

Poedit select catalog template.png

poEdit will display the new strings it will add, as well as the obsolete strings it will remove.

Poedit approve updates.png

Using GNU gettext tools

The GNU gettext tools include a command-line tool called msgmerge which may be used to merge two catalogs together. For example, to use msgmerge for ccpublisher.po, you can use the following commands (Linux):

 $ cd resources/locale/en_US
 $ msgmerge ccpublisher.po ../ccpublisher.pot > new_ccpublisher.po

This will create a new file (new_ccpublisher.po) containing the merged translations. After examining it, rename it to the original file name (ccpublisher.po).

Supported Languages

ccPublisher includes support for the following languages:

  • English

The following languages will be included in the next release: