From f45bf015ae8064bc4cdc22fef71dac7b52090f4f Mon Sep 17 00:00:00 2001 From: Ivan Diaz Date: Mon, 11 Jun 2018 14:50:43 -0300 Subject: [PATCH] Created How to add a new language (markdown) --- How-to-add-a-new-language.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 How-to-add-a-new-language.md diff --git a/How-to-add-a-new-language.md b/How-to-add-a-new-language.md new file mode 100644 index 0000000..47e83f9 --- /dev/null +++ b/How-to-add-a-new-language.md @@ -0,0 +1,11 @@ +If you want to add a translation for OpenSupports, you'll need to [create a Pull Request](https://help.github.com/articles/creating-a-pull-request/) to this repository from a fork with the necessary code changes. + +The changes that need to be made are the following: +1. Create corresponding `.js` translation file in the folder [client/src/data/languages](https://github.com/opensupports/opensupports/tree/master/client/src/data/languages), you can take `en.js` as a template. Please use a two-letter code for each language. The language code should mirror [famfamfam flag icons](http://www.famfamfam.com/lab/icons/flags/). +2. Add the language code and require the newly created file in [language-list.js](https://github.com/opensupports/opensupports/blob/master/client/src/data/language-list.js) +3. Add the language code to the `LANGUAGES` constant in [Language.php](https://github.com/opensupports/opensupports/blob/master/server/models/Language.php#L6) +4. Create a element with the language code in the array returned by `getTexts()` in [MailTexts.php](https://github.com/opensupports/opensupports/blob/master/server/data/MailTexts.php). Insert the corresponding translations for each mail template. + +One the changes are made, you can create a PR with those. Once it's merged, you will need to wait to the next OpenSupports release to see the changes. + +If you want to test the changes you can build your own version by setting up the development environment and [building a package](https://github.com/opensupports/opensupports/blob/master/README.md#building). It will create a `.zip` file ready for installation with your changes. \ No newline at end of file