Editing GSoC 2010/Projects/transifex-mobile/manual

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

=Intro=
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, ...

=Installation=
* Start Application manager
* Enable [http://wiki.maemo.org/Extras 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

[[Image:Transifex-mobile-menu-item.png]]

==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
etc. 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.
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).

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...)

Browsing projects is rather straightforward, to search tap on
"Search" in the menu (FIXME: ... from the title bar).

FIXME: What happens if the user touches a row in this view?

[[Image:Transifex-mobile-projects.png]]

==Files==
Each component in a project contains files, or translations to
be more abstract. File list view shows progress for each file.

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

==Strings==
Each file contains a set of strings. In the left-bottom corner
there are some buttons for filtering. A string can have three
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.

FIXME: What does the magnifying glass icon do?

FIXME: What happens if the user touches a row in this view?

[[Image:Transifex-mobile-strings.png]]

==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).

[[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?)

[[Image:Transifex-mobile-push-dialog.png]]

=Reporting bugs and problems=

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:

~/.config/transifex-client.json

Cached PO files are stored in:

~/.cache/transifex-mobile

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

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

Personal tools

Navigation

Views

Editing GSoC 2010/Projects/transifex-mobile/manual

@@ Line 3: / Line 3: @@
 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
+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 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 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's not an application to translate documents
-* It's not an application to do automated translations
 =Installation=
@@ Line 25: / Line 23: @@
 ==Dashboard==
 The main screen mimics [http://www.transifex.net/ Transifex]'s
-dashboard view.
+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
+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, otherwise your work might go uncredited. The metadata of translations stored in PO-files is updated based on this information.
+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.
+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
-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.
+file" in the menu (FIXME: tell the user that the menu can be reached by tapping the title bar).
-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==
-This view is shown once user taps "Browse projects..." button in previous view.
+(FIXME: How does the user get here? By clicking on the button...)
-Browsing projects is rather straightforward, to search tap on "Search" in the menu. To open up the menu, tap on the title bar.
+Browsing projects is rather straightforward, to search tap on
+"Search" in the menu (FIXME: ... from 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.
+FIXME: What happens if the user touches a row in this view?
 [[Image:Transifex-mobile-projects.png]]
@@ Line 51: / Line 46: @@
 ==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.
+be more abstract. File list view shows progress for each file.
+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 57: / Line 56: @@
 ==Strings==
 Each file contains a set of strings. In the left-bottom corner
-there are some buttons for filtering.
+there are some buttons for filtering. A string can have three
+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.
-* Green - Include translated strings
+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.
-* 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
+FIXME: What does the magnifying glass icon do?
+FIXME: What happens if the user touches a row in this view?
 [[Image:Transifex-mobile-strings.png]]
@@ Line 71: / Line 72: @@
 String editor view provides all the things you need to translate
-one string. With the buttons on the bottom user can do following:
+one string. With the buttons on the bottom user can navigate through
-* Previous string - Go to previous string in current translation file
+strings in the current stringset, revert back to the original one,
-* Next string - Go to next string in current translation file
+copy source string, use Google Translate to automatically translate
-* Revert - Revert back to original translation since last save
+the string and finally set the string status either to translated,
-* Copy source string - Copies the content of left-hand box to right-hand box
+fuzzy or untranslated.
-* 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
+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).
-* 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, 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.
+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?)
 [[Image:Transifex-mobile-push-dialog.png]]
@@ Line 107: / Line 106: @@
   ~/.cache/transifex-mobile
-[[Category:Documentation]]
-[[Category:Google Summer of Code]]