GSoC 2010/Projects/transifex-mobile/manual

Latest revision as of 10:32, 13 September 2010

1 Intro
2 Installation
3 Usage
4 Reporting bugs and problems
- 4.1 Acquiring debugging output
- 4.2 Other relevant data

[edit] 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

[edit] 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

[edit] Usage

[edit] Icon

After installing the icon should appear in the menu, tap it to start the program

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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

[edit] String editor

String editor view provides all the things you need to translate one string. With the buttons on the bottom user can do following:

Previous string - Go to previous string in current translation file
Next string - Go to next string in current translation file
Revert - Revert back to original translation since last save
Copy source string - Copies the content of left-hand box to right-hand box
Automatic translation - Use Google Translate to translate the string (this overwrites any previous work in right-hand box!)
Green flag - Mark translation as finished or translated
Blue flag - Mark translation as semi-finished or fuzzy
Red flag - Mark translation as not started or untranslated (this clears right-hand box!)

[edit] 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, otherwise other translators can't work on those files! If you're just saving your changes so they won't get lost, keep the file locked.

[edit] Reporting bugs and problems

You can report bugs in this Maemo Talk thread, please include debugging output.

[edit] Acquiring debugging output

To start Transifex-Mobile in debugging mode, fire up terminal and execute following command:

/opt/transifex-mobile/main.py -d

[edit] Other relevant data

Transifex-Mobile configuration file is located at:

~/.config/transifex-client.json

Cached PO files are stored in:

~/.cache/transifex-mobile

Retrieved from "https://wiki.maemo.org/GSoC_2010/Projects/transifex-mobile/manual"

Categories: Documentation | Google Summer of Code

This page was last modified on 13 September 2010, at 10:32.
This page has been accessed 18,308 times.

@@ Line 1: / Line 1: @@
 =Intro=
-Transifex-Mobile is a mobile localtraization application linked to translations portal [http://www.transifex.net Transifex.net]. (FIXME: For which platform? Which license? Written in what language? Using which UI framework? Created as part of Maemo@SoC2010, etc.. - even if it is "kind of" clear through the placement in the Wiki, etc..)
+Transifex-Mobile is a mobile localization application linked to translations portal [http://www.transifex.net 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.
-FIXME: Add "what it is" and "what it is not" in list form, e.g. it's a tool to do translations of texts that appear in applications, but it's not an automated translation tool (the user has to do the translation manually, though maybe supported), it's a tool to do app translations, but it's not a tool for document translation, it works with .po files and transifex, but does not work yet with other services, it works with applications that are prepared for translation, but it does not work with applications that do not support gettext translations, ...
+* It is an application to translate texts that appear in applications
+* It is an application integrated with [http://www.transifex.net Transifex.net] service
+* It is an application to edit [http://en.wikipedia.org/wiki/GNU_gettext 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=
@@ Line 20: / Line 25: @@
 ==Dashboard==
 The main screen mimics [http://www.transifex.net/ Transifex]'s
-dashboard view. The user can see her locks (FIXME: Describe locks a bit more in detail - what are they, how are they created, how can they be "removed", etc..) there, browse projects
+dashboard view.
-etc. Left-top button shows user's first and last name plus e-mail
+To browse and search for projects available at [http://www.transifex.net/ 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 (FIXME: Why? What are the problems if the user does not, what are the beenfits if (s)he does?). PO-file (FIXME: What is a PO file? Where does it reside in the project source tree? Does the user have to know?) metadata is updated based on this information.
+back to server, otherwise your work might go uncredited. The metadata of translations stored in PO-files is updated based on this information.
-Editing local PO-files (FIXME: What does this mean? When is it useful? Where to get .po files from application developers?) is also enabled, just tap on "Open local
-file" in the menu (FIXME: tell the user that the menu can be reached by tapping the title bar).
+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 [http://www.transifex.net/ 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.
-FIXME: What happens if the user touches a row in this view?
 [[Image:Transifex-mobile-dashboard.png]]
 ==Projects==
-(FIXME: How does the user get here? By clicking on the button...)
+This view is shown once user taps "Browse projects..." button in previous view.
-Browsing projects is rather straightforward, to search tap on
+Browsing projects is rather straightforward, to search tap on "Search" in the menu. To open up the menu, tap on the title bar.
-"Search" in the menu (FIXME: ... from the title bar).
-FIXME: What happens if the user touches a row in this view?
+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.
 [[Image:Transifex-mobile-projects.png]]
@@ Line 43: / Line 51: @@
 ==Files==
 Each component in a project contains files, or translations to
-be more abstract. File list view shows progress for each file.
+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.
-FIXME: What do the three numbers in brackets in the "Translations" column stand for?
-FIXME: What happens if the user touches a row in this view?
 [[Image:Transifex-mobile-files.png]]
@@ Line 53: / Line 57: @@
 ==Strings==
 Each file contains a set of strings. In the left-bottom corner
-there are some buttons for filtering. A string can have three
+there are some buttons for filtering.
-statuses - green means translated string, red means not translated
-and blue is used mark fuzzy strings, this means that the string
-is basically translated but might need to be checked one more time.
-FIXME: I would place the "status" description (red, green, blue) in a table here, and have not only the textual description, but also a square colored in the specific color (you can do this by embedding the icon, etc..). This makes the description stand out more and makes it clearer to the user which is which.
+* Green - Include translated strings
+* Blue - Include fuzzy strings
+* Red - Include not translated strings
+* Magnifying glass - Filter strings by content
-FIXME: What does the magnifying glass icon do?
+Tapping on a string opens up string editor where the user can actually modify the translation
-FIXME: What happens if the user touches a row in this view?
 [[Image:Transifex-mobile-strings.png]]
@@ Line 69: / Line 71: @@
 String editor view provides all the things you need to translate
-one string. With the buttons on the bottom user can navigate through
+one string. With the buttons on the bottom user can do following:
-strings in the current stringset, revert back to the original one,
+* Previous string - Go to previous string in current translation file
-copy source string, use Google Translate to automatically translate
+* Next string - Go to next string in current translation file
-the string and finally set the string status either to translated,
+* Revert - Revert back to original translation since last save
-fuzzy or untranslated.
+* Copy source string - Copies the content of left-hand box to right-hand box
+* Automatic translation - Use Google Translate to translate the string (this overwrites any previous work in right-hand box!)
-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).
+* Green flag - Mark translation as finished or translated
+* Blue flag - Mark translation as semi-finished or fuzzy
+* Red flag - Mark translation as not started or untranslated (this clears right-hand box!)
 [[Image:Transifex-mobile-string-editor.png]]
 ==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?)
+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, otherwise other translators can't work on those files! If you're just saving your changes so they won't get lost, keep the file locked.
 [[Image:Transifex-mobile-push-dialog.png]]
-=Debugging=
+=Reporting bugs and problems=
-FIXME: I would rename this section "reporting problems and bugs", with the link to the TMO thread at the top and then a sub-section called "how to obtain debugging output" with the info from here.
+You can report bugs in [http://talk.maemo.org/showthread.php?t=58520& 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:
@@ Line 100: / Line 108: @@
   ~/.cache/transifex-mobile
-You can report bugs in [http://talk.maemo.org/showthread.php?t=58520& this Maemo Talk thread], please include debugging output.
+[[Category:Documentation]]
+[[Category:Google Summer of Code]]

Personal tools

Navigation

Views