README.md

Tools for i18n

🎈 Feature

• ✅ Segment translation files into their respective languages
• ✅ Restoring a segmented translation file back to its original file
• ✅ Automatic translation of additional language

⚙️ Setup

$ git clone https://github.com/ogty/tools-for-internationalization
$ source ./tools-for-internationalization/setup.sh # or make

📖 Usage

$ i18n <commands> [options]

Note
To change the output format of the table, you need to replace the commented out variables in settings.py.

🤖 Commands

Command	Description
segment	Commands to segment translation files into their respective languages
revgene	Command to convert a segmented translation file into a yaml file
table	Command to create a table from segmented translation data
help	Commands to display usage, etc.

🔍 Options

Name	Argument	Commands
-f, --file	<file>	segment, revgene, table
-o, --output	<directory/file>	segment, revgene, table
-l, --languages	<language [...]>	segment, table
-al, --additonal_language	<language>	revgene
-d, --directory	<directory>	revgene
-at, --automatic_translation	-	revgene
-s, --show	-	table

✏️ Example

Segment the translation file into each language

$ i18n segment -f ./sample/public/locales/i18n.yaml -l ja en -o ./sample/public/locales

Generate the original translation file (yaml) from the segmented translation file (json)

$ i18n revgene -d ./sample/public/locales -f translations.json -o i18n.yaml

Output translation files to a file as a table

$ i18n table -f ./sample/public/locales/i18n.yaml -l ja en -o i18n.md

Add new languages to the translation file and output as a table

$ i18n revgene -d ./sample/public/locales -f translations.json -al fr -o i18n.yaml && \
  i18n table -f ./sample/public/locales/i18n.yaml -l ja en fr -o i18n.md

🖨️ Output

./sample/index.html

Note
If you want to change the design of the output table, please modify the templates/html.tpl file