phynet / honyaku Goto Github PK

Honyaku (hon'yaku) suru in japanese means translation or to translate. And we believe it applies to this software, a web application helper to generate Android and iOS translation files (.xml & .strings) using a CSV file as a source.

Right now, we don't support .po files, because we develop this tool to help us in our day to day work (we don't work with .po files), and we thought that maybe as it is, this software could help others in the same quest we fought (making easy translation process), but if lot of people asks for .po support we could add it (or maybe you could added it and make a PR? ;] )

This application is a node express-server based application. You will need to install npm.

1. Download node for your operative system:

   https://nodejs.org/en/download/package-manager/
   

2. Next, download this project and go to root path, there you'll see a file called express-server.js and package.json (with other files), use the next command to install npm packages:

   sudo npm install
   

3. Next step is to run express-server using the next command:

    node express-server.js
   

3.1. If you want to edit any JS file, think of using nodemon. Is a utility that will monitor for any changes in your source and automatically restart your server. Perfect for development

    sudo npm install -g nodemon

4. Open a web browser and type this url:

    http://localhost:3000/
   

Now, if everything goes OK you will be able to see something like the image above

5. You need now to select if you will have or will not have plurals:

6. If you select NO for plurals and click on process button, you will see a Success! message. Go to Honyaku/download path and select iOS or Android, you'll see the localized files for each language specified in the CSV file converted in .xml for Android and .strings for iOS.

The Success Message looks like this:

7. If you select YES for plurals, you must select the base CSV file and the CSV plurals file and click Process button, if everything goes well you will see a success! message. Go to download path and select iOS or Android, you'll see the localized files for each language specified in CSV file there.

Success Message looks like this:

This is the path were the iOS files are downloaded

This is the path were the Android files are downloaded

The CSV file needs to have the next structure: key (lower case) and the short name for each language supported in capital letters, placed in each column of the CSV. The first column should always be the key word, next column should be each of the supported languages in your application.

• 📄 You can use the Example folder to see how the CSV are constructed.

• 📝 Also, you can create in path download/Android and download/iOS all the languages that your app will support.

The key word represents the key that your app will use to localize text for each language.

• Adding variables

As you will probably know, sometimes is necessary to add variables between our text. Honyaku supports this feature, adding a wildcard (double asterisk) inside the localizable text. For example:

• Data type supported

• Example output

• Escape symbols

For now, we are escaping the % symbol. This case is evaluated in the application, but if you need to escape more symbols, please add an issue and we will try to add it.

You can create a CSV file to process plurals. This is how the structure looks like:

You can see all of the rule cases supported for each language in: http://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html

Example:

if you have any errors deploying express-server.js try to kill the process in CLI:

Search for express-server process:

    $:  ps -ef | grep express

Kill the process:

    $:  kill process-number

• Errors control
• Tests

This role was created in 2017 by Sofa E Swidarowicz Andrade, iOS engineer at Rentalia