GSoC 2010/Projects/transifex-mobile/manual
(→Intro) |
(→Strings) |
||
| Line 57: | Line 57: | ||
==Strings== | ==Strings== | ||
Each file contains a set of strings. In the left-bottom corner | Each file contains a set of strings. In the left-bottom corner | ||
| - | there are some buttons for filtering | + | there are some buttons for filtering. |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | * Green - Include translated strings | |
| + | * Blue - Include fuzzy strings | ||
| + | * Red - Include not translated strings | ||
| + | * Magnifying glass - Filter strings by content | ||
| - | + | Tapping on a string opens up string editor where the user can actually modify the translation | |
| - | + | ||
| - | + | ||
[[Image:Transifex-mobile-strings.png]] | [[Image:Transifex-mobile-strings.png]] | ||
Revision as of 16:53, 18 August 2010
Contents |
Intro
Transifex-Mobile is a mobile localization application linked to translations portal Transifex.net. It's written in Python, on top of Qt4 user interface framework and it's currently available for Maemo devices. It's Google Summer of Code 2010 project and it's licensed under GPL license.
- It is an application to translate texts that appear in applications
- It is an application integrated with Transifex.net service
- It is an application to edit GNU Gettext catalogs, or PO-files for short
- It's not an application to translate documents
- It's not an application to do automated translations
Installation
- Start Application manager
- Enable Maemo Extras repository
- Tap on "Download"
- Tap on "Development"
- Tap on "Transifex-mobile" to install it
- Icon with title "Transifex-Mobile" should appear in the menu, use it to run the application
Usage
Icon
After installing the icon should appear in the menu, tap it to start the program
Dashboard
The main screen mimics Transifex's dashboard view.
To browse and search for projects available at Transifex server, tap on "Browse projects..."
Left-top button shows user's first and last name plus e-mail address. Verify that those are correct before pushing any files back to server, otherwise your work might go uncredited. The metadata of translations stored in PO-files is updated based on this information.
The locked files are shown in the list, a locked file indicates a translation the user is working with. Once a file is locked, another user can't update the file at Transifex server. Tapping one of the locked files, opens up string list view.
Editing local PO-files is also enabled although this is a feature for hardcore hackers, just tap on "Open local file" in the menu. To open up the menu, tap on the title bar.
Projects
This view is shown once user taps "Browse projects..." button in previous view.
Browsing projects is rather straightforward, to search tap on "Search" in the menu. To open up the menu, tap on the title bar.
Each project is made up of components and each component in return contains bunch of translations, or files to be more precise. Tapping on one of the items displays component list view.
Files
Each component in a project contains files, or translations to be more abstract. "Language" column indicates the language of translation. "Translations" column shows progress for each file, the number triplet in braces indicates the number of translated, fuzzy and untranslated strings. "Filename" indicates the path of the translation file in the source code management system. Tapping on one of the rows opens up the strings list view.
Strings
Each file contains a set of strings. In the left-bottom corner there are some buttons for filtering.
- Green - Include translated strings
- Blue - Include fuzzy strings
- Red - Include not translated strings
- Magnifying glass - Filter strings by content
Tapping on a string opens up string editor where the user can actually modify the translation
String editor
String editor view provides all the things you need to translate one string. With the buttons on the bottom user can navigate through strings in the current stringset, revert back to the original one, copy source string, use Google Translate to automatically translate the string and finally set the string status either to translated, fuzzy or untranslated.
FIXME: Also here, it would be nice to have a table of toolbar icons with their description. (i.e. one row with the left arrow icon and its description what it does, the next row with the right arrow icon and its description what it does, etc..) "Copy source string" could be better described as "copy the text from the left text area into the right text area" (if that's what it does - it could also mean that the text in the left pane is copied to the clipboard).
Push dialog
Upon closing the string list view user is confronted with push dialog. Here user can select whether changes are to be pushed back to server, or to be forgotten. Remember to unlock the file once you have finished translating. (FIXME: Why? What happens if the user does not do it? When should the user not unlock the file? How will the user be able to continue translating the file if it's locked? How can the user unlock the file if (s)he has accidentally left it locked?)
Reporting bugs and problems
You can report bugs in this Maemo Talk thread, please include debugging output.
Acquiring debugging output
To start Transifex-Mobile in debugging mode, fire up terminal and execute following command:
/opt/transifex-mobile/main.py -d
Other relevant data
Transifex-Mobile configuration file is located at:
~/.config/transifex-client.json
Cached PO files are stored in:
~/.cache/transifex-mobile