mknals programming (under construction)

OpenTM2 Tools -> ZZ-PaT -> FAQs & Documentation

1 FAQs

What are the requirements?

ZZ-PaT is installed as a server-client program pair (one program in the PM machine another one in the translator machine).

• OpenTM2 in the PM and translator machine.
• Public FTP server (if you want to send to external translators) and/or shared drives (inhouse translators).
• Email account allowable to send emails

How much it costs?

Nothing. Has been placed in github in https://github.com/miguelknals/ZZ-Pat. You can use it free under the MIT license that only requires acknowledgment to the author. But be aware this program means a lot of hours and time effort, so understand that I will welcome any support or professional request.

Where are the binaries?

The program has been compiled Visual Studio Code (free) in vb.net 4.6.1 and uses the plain .Net framework. You can compile the binaries easily. To my knowledge you cannot store binaries in gitub, so you have these alternatives a) clone the repository and compile it in Visual Studio, b) send me an email and ask for them.

How I set up the program?

The solution provides a step by step guide. Remember need OpenTM2, an FTP server (for external translator) and email account send emails. Here you can download the ZZ-PaT Server install guide

2 Additional information

In GitHub you will find the following docs:

• ZZ-PaT work flow shows the whole process, from PM to Translator, and back from Translator to PM.
• ZZ-PaT Server install guide with information that explains how to setup a ZZ-PaT server machine, the PM machine.
• ZZ-PaT Client install guide with information that explains how to setup a ZZ-PaT client machine, the translator machine.

2.1 PaT file content

PaT is a Spanish acronym for "Package to be Translated" ("Paquete a Traducir)". A PaT file is a zip file that contents all the material you traditionally will send to the translator (plus some ZZ-Pat files). For example:

• Folders in the PM OpenTM2 machine to be translated. One or several.
• CNT files. The untranslated word count to be translated.
• *_PROFILE_ini_cal.RPT. Initial calculating of the folders. The profile is selected when the PM creates the PaT file. This calculating is needed to subtract from the final calculating of the word count once the translator folder is returned and counted.
• In the Ref\ path of the zip file there are the reference files, auxiliary files that the PM will include when creates the PaT file. It can be any type of file in the PM host file system.
• PaT_name_MFT.XML. This xml is the Manifest File (MFT) of the PaT. This file describes the package itself. It contains:
  • Folder information (Folder name, CNT, initial calculating, profile or rate ).
  • Translation notes sent to the translator.
  • List of the references sent to the translator.
  • Email information of the PM and the Translator.
  • Manifest (MFT) signature. A MD5 hash of MFT in order to prevent any accidental change or possible tampering.
  • Translation due date
• PaT_name_MFT.HTM. This HTM is human readable information of the manifest File (MFT) of the PaT. It contains the basic information of the PaT file.

The mission of ZZ-PaT is to deliver the PaT file to the translator, but notice that even without any ZZ-PaT transporting feature, the translator would have all he needs once he receives the PaT file by any other mean.

2.2 The Exchange Area (EA)

Thru the doc, in several places, we will use the term Exchange Area (EA). This term describes a computer resource (an FTP server or a network resource) that can be accessed both from the Project Manager and the Translator. All the files that are exchanged between the Project Manager and the Translator go thru this area.