• Abstract and Figures
• Public Full-text

Pootle Documentation Release 2.5.0-rc1 Translate.org.za December 01, 2013 Contents i ii Pootle Documentation, Release 2.5.0-rc1 Pootle is an online tool that makes the process of translating so much simpler. It allows crowd-sourced translations, easy volunteer contribution and gives statistics about the ongoing work. Pootle is built using the powerful API of the Translate Toolkit and the Django framework. If you want to know more about these, you can dive into their own documentation. • Translate Toolkit Documentation • Django Documentation Contents 1 Pootle Documentation, Release 2.5.0-rc1 2 Contents CHAPTER 1 All you need to know The following pages cover the documentation of Pootle from a wide variety of perspectives, including user’s, server administrator’s, and developer’s view. 1.1 User’s guide 1.1.1 Getting started Pootle is a web portal that allows you to translate more easily. The name stands for PO-based Online Translation / Localization Engine, but you may need to read this. Pootle is GPL licensed Free Software, and you can download it and run your own copy if you like. You can also help participate in the development in many ways (you don’t have to be able to program). The Pootle project itself is hosted at http://pootle.translatehouse.org where you can find details about source code, mailing lists, etc. Registration While everybody can view the files, only registered users can edit them and receive credit for their effort, so unless your server uses LDAP authentication, the first thing you should do in order to translate, is to register. You can register in the register page (accessible by clicking Register in the menubar) following two simple steps, providing you have a current e-mail address. 1. Fill in your desired user name, a valid e-mail account, and enter your password twice for verification. Then choose Register and an you will receive a message with an activation link in the e-mail address you have provided. 2. When you receive the activation message by e-mail, just click on the activation link and your account will be activated. Login and user settings setup Now that you are a registered user, you can login to Pootle by following the Login link on the top menubar and filling in your credentials. 3 Pootle Documentation, Release 2.5.0-rc1 Once you have logged in, your account’s dashboard will be shown, which includes links to your selected languages and projects. The first time you log in, no links will be shown since you haven’t chosen any before. You can click on the link provided to change your settings and select your preferred languages and projects. You can set more settings within the same page as well. Browsing the files tree Now that your dashboard is set up, you can reach the desired files for translation directly through the links in it. Another way to find the file you wish to translate is through the main page. The main page displays two categories: languages and projects. Choosing a language will give you the list of projects available for translation into this language; choosing a project will give you the list of languages to which it can be translated. Once you have chosen both the project and the language, you’ll be presented with the files and directories available for translation. Heading to translating If you click on a filename it will start showing all the entries on the file, independently whether the entries are translated or not. This is also known as Translate All. Alternatively, if the translation for a file is not complete, you can click on the summary text (eg, 27 words need attention), which will give you through all the untranslated or fuzzy entries on the file. This mode is also named as Quick Translate. In both cases you’ll be presented with a two-column table, with the strings to be translated on the left, and the current translation on the right. The current edited entry will appear as a text box with the options Skip and Suggest or Submit below it. Naturally you can enter text in the text box and submit it or skip to the next entry. You can also directly access any of the other entries presented by clicking on the numbers on the left-hand side. Other aids from Pootle Pootle’s editor also helps translators by displaying Terminology related to the entry currently being edited. Another helpful feature is the Alternative source language, which displays how the current entry has been translated into other languages. In order for this to work, you must select your desired alternative source languages in you account’s settings. In addition to the above, you can also download the translation file, work offline with your favourite editor and upload the file. For multi-file projects, you can download a ZIP file with all the files for a directory and upload the ZIP file with the translated files. 1.1.2 Administration In default Pootle installations, an admin account (the password matches the username) is created with superuser privileges which can be used to administer the whole site. Note: It’s highly recommended that you change the password for the default admin account on your first login, or even delete the account and assign superuser rights to another user. 4 Chapter 1. All you need to know Pootle Documentation, Release 2.5.0-rc1 Administration scope Users with administration privileges will have an extra Admin element within the main navigation bar, which gives direct access to the administration functions of the site. Administrators can change the general settings for the site (such as the server title or description), as well as add, edit, and remove users, languages, and translation projects. They are also able to define the default permissions that will apply to the whole site unless otherwise noted. Apart from that, administrators have full rights over all the translation projects, so they can do whatever can be done: translate, suggest, upload new files, update VCS checkouts, ... Adding new site administrators If you want to assign site administration permissions to an already existing user, just go to the Users tab within the Administration page, check the Superuser status checkbox for the user you want to make administrator and click on Save Changes. That’s all! Language administrators Administration rights can be delegated for all tasks within a language. This allows the language administrator to set permissions in the language, set permissions in certain projects in the language, manage files, etc. To appoint a language administrator, visit the language page, and add the administration right on the Permissions tab. 1.2 Features 1.2.1 Backends and storage Authentication Backends LDAP Authentication LDAP configuration can be enabled by appending the ’pootle.auth.ldap_backend.LdapBackend’ to the list of AUTHENTICATION_BACKENDS. The settings page lists all the configuration keys available for LDAP. Below a brief example of a working configuration is showcased. The mail addresses are [email protected], the LDAP server is your.ldapserver.org. In this case, we need a specific user account to search in our LDAP server, this user/password is admin/pootle. The LDAP accounts are based on the mail addresses: these are the uids. Finally, John Doe is part of the branch employees on the LDAP. # Authenticate first with an LDAP system and then fall back to Django’s # authentication system. AU- THENTICATION_BACKENDS = [ #: Uncomment the following line for enabling LDAP authentication ‘poo- tle.auth.ldap_backend.LdapBackend’, ‘django.contrib.auth.backends.ModelBackend’, ] # The LDAP server. Format: protocol://hostname:port AUTH_LDAP_SERVER = ‘ldap://your.ldapserver.org:389’ # Anonymous Credentials : if you don’t have a super user, don’t put cn=... AUTH_LDAP_ANON_DN = ‘cn=admin,dc=website,dc=org’ AUTH_LDAP_ANON_PASS = ‘pootle’ # Base DN to search AUTH_LDAP_BASE_DN = ‘ou=employees,dc=website,dc=org’ # What 1.2. Features 5 Pootle Documentation, Release 2.5.0-rc1 are we filtering on? %s will be the username (must be in the string) # In this case, we filter on mails, which are the uid. AUTH_LDAP_FILTER = ‘uid=%s’ # This is a mapping of Pootle field names to LDAP fields. The key is # Pootle’s name, the value should be your LDAP field name. If you don’t use the # field or don’t want to automatically retrieve these fields from LDAP comment # them out. The only required field is ‘dn’. givenName, sn and uid are the names # of the LDAP fields. AUTH_LDAP_FIELDS = { ‘dn’: ‘dn’, ‘first_name’:’givenName’, ‘last_name’:’sn’, ‘email’:’uid’ } File formats Pootle supports many file formats through the powerful Translate Toolkit API. The Toolkit also provides several format converters for other formats, this will allow you to host a lot of translatable content on Pootle. All these formats can be downloaded for offline use/or translation (for example in Virtaal). We recommend Virtaal for offline translation. They can also be downloaded in XLIFF format. Bilingual formats These formats are translation files that include the source and target language in one file. • Gettext PO • XLIFF New in version 2.0.3. • Qt TS • TBX • TMX Monolingual formats New in version 2.1. These files contain only one language in the file. Pootle supports formats without conversion. • Java properties • Mac OSX strings • PHP arrays • Subtitles in many formats Monolingual files need special attention in order to provide translators with good workflow and to assist to perform good translation. Read more in the localization guide. The main difference between monolingual and bilingual projects in Pootle is that for monolingual projects a translation template is required. Pootle cannot meaningfully import strings from monolingual files unless the original text is present.

Load more

  60

Copy Link