You are here

Home » API reference » Translation Management Tool 8

README.txt in Translation Management Tool 8

Same filename in this branch
  1. 8 README.txt
  2. 8 translators/tmgmt_local/README.txt
Same filename and directory in other branches
  1. 7 translators/tmgmt_local/README.txt
TMGMT Local Translator
----------------------

A user interface to execute the actual translation of TMGMT source elements.
Includes management tools for handling translations and users.

Requirements
------------

Local Translator is a translation plugin for TMGMT and is included in TMGMT core.

Basic Concepts
--------------

Acts as a translator plugin for TMGMT. Can be used to do manual local
translation. In addition it offers some management tools to handle the
assignment of jobs to users.

The local translator adds two permissions:

- Provide translation services

  The user can assign jobs to himself (assuming he has the right skills) and
  execute the translation. Adds a 'Translate' link to the User menu.

- Administer translation tasks

  Assign jobs to other users for translation. Adds a 'Manage Translate Tasks'
  to the User Menu.

Moreover, as we use the admin theme for the local translator, that means that
the users will need the following permissions to be able to see the theme:

- View the administration theme

- Access toolbar


Getting started
---------------

In TMGMT, a translation job can be sent to the local translator. In the checkout
settings, the plugin offers the possibility to assign the job to a specific user.
Only users with the required language skills are listed at this moment. If no
person is selected, the job will be moved to the 'unassigned' task list for later
treatment.

Following the 'Translate' link in the User Menu, the user finds a listing
of the tasks assigned to him as well as eligible tasks to assign to himself,
depending on his skills. Assigned tasks will show a 'translate' link in the
action column. Follow it to get a list of the task items to be translated.
Choose to translate one item to get to the actual translation page.

It lists two panes for each data item contained in the task item. One showing
the text in the original language. The second one for writing in the translation.
Each line sports a check button to its right. Once the translation is done, the
data item can be checked off as complete. This check is purely informational
and has no functional consequences.

A translation task item can be saved at any time for later rework. It will show
up as pending or translated depending on the state of the check mark for each
item.

Once the data items are all translated, the 'Save as completed' button will
finalize the task and send it back to TMGMT core for further processing. Please
note: Completing a task item is independent of the state of the checkboxes.

File

translators/tmgmt_local/README.txt
View source 
  1. TMGMT Local Translator

  2. ----------------------

  3. 

  4. A user interface to execute the actual translation of TMGMT source elements.

  5. Includes management tools for handling translations and users.

  6. 

  7. Requirements

  8. ------------

  9. 

  10. Local Translator is a translation plugin for TMGMT and is included in TMGMT core.

  11. 

  12. Basic Concepts

  13. --------------

  14. 

  15. Acts as a translator plugin for TMGMT. Can be used to do manual local

  16. translation. In addition it offers some management tools to handle the

  17. assignment of jobs to users.

  18. 

  19. The local translator adds two permissions:

  20. 

  21. - Provide translation services

  22. 

  23.   The user can assign jobs to himself (assuming he has the right skills) and

  24.   execute the translation. Adds a 'Translate' link to the User menu.

  25. 

  26. - Administer translation tasks

  27. 

  28.   Assign jobs to other users for translation. Adds a 'Manage Translate Tasks'

  29.   to the User Menu.

  30. 

  31. Moreover, as we use the admin theme for the local translator, that means that

  32. the users will need the following permissions to be able to see the theme:

  33. 

  34. - View the administration theme

  35. 

  36. - Access toolbar

  37. 

  38. 

  39. Getting started

  40. ---------------

  41. 

  42. In TMGMT, a translation job can be sent to the local translator. In the checkout

  43. settings, the plugin offers the possibility to assign the job to a specific user.

  44. Only users with the required language skills are listed at this moment. If no

  45. person is selected, the job will be moved to the 'unassigned' task list for later

  46. treatment.

  47. 

  48. Following the 'Translate' link in the User Menu, the user finds a listing

  49. of the tasks assigned to him as well as eligible tasks to assign to himself,

  50. depending on his skills. Assigned tasks will show a 'translate' link in the

  51. action column. Follow it to get a list of the task items to be translated.

  52. Choose to translate one item to get to the actual translation page.

  53. 

  54. It lists two panes for each data item contained in the task item. One showing

  55. the text in the original language. The second one for writing in the translation.

  56. Each line sports a check button to its right. Once the translation is done, the

  57. data item can be checked off as complete. This check is purely informational

  58. and has no functional consequences.

  59. 

  60. A translation task item can be saved at any time for later rework. It will show

  61. up as pending or translated depending on the state of the check mark for each

  62. item.

  63. 

  64. Once the data items are all translated, the 'Save as completed' button will

  65. finalize the task and send it back to TMGMT core for further processing. Please

  66. note: Completing a task item is independent of the state of the checkboxes.