Add Translation Page (#12)

Co-authored-by: Jowan-Spooner <[email protected]>

Documentation/translation.md

@@ -0,0 +1,102 @@
+![header_getting_started](media/headers/translations.png)
+
+## What is Translation?
+
+Translation is a Godot and Dialogic 2 feature, allowing you to translate your game into multiple languages.
+
+Sometimes, the word *localisation* is used as well.
+Localisation provides very specific regional considerations for each consumer market.\
+This includes not only translation of the game, but also changes to the game itself to reflect specific cultural differences.
+
+While Dialogic supports translation of your timeline, it's better to focus on
+your game first and add translation later.\
+However, keeping the translation and localisation in mind is a very good idea:
+
+- How will you handle variables?
+- Do you need the glossary?
+- What images do you want to localise?
+- Any features in mind that may complicate translation?
+
+```admonish
+For now, Dialogic supports CSV translation only.
+Godot itself supports `gettext` as well.
+```
+
+## How to translate timelines?
+
+In Dialogic, head to the Settings tab, a look under the Translation section. Tick the "Enable Translation" checkbox.
+
+![translation_settings](/media/translation/translation_settings.png)
+
+### Setting up Translation
+
+Let's walk through the settings! You will have to pick a default locale.
+This locale must be the language you write the timeline in.
+Additionally, this locale will be used as fallback, if no translation exists for a given translatable event.
+The "translation file mode" allows you to store all your timelines into one file (Per Project) or into multiple files (Per Timeline).
+
+Setting up a translation folder is a good idea, it keeps your project clean and allows you to easily find your translation files.
+
+### Writing Translations
+
+First of all, you will need to have a timeline file. Dialogic will automatically find and generate CSV files for you after you hit the "Update CSV files" button.
+
+The CSV format is very simple and has a great variety of support. You can open it with any spreadsheet software, like Excel or Google Sheets. Even VSCode offers extensions to edit the file.\
+The gist of CSV files is that each line represents a row and each column is separated by a comma.
+
+Once Dialogic has generated the CSV file, it may look like this:
+
+```csv
+keys,en
+Text/1/text,Hello World!"
+```
+
+The `keys` are locales, the `en` is the locale code for English, if you chose a different default locale, the locale code will be different.
+
+You can add a new language for your game by adding a new column. The following example added "ja" for Japanese to the first row and translated the text in the second row. Pay attention to the commas!
+
+```csv
+keys,en,ja
+Text/1/text,Hello World!,こんにちは世界！
+```
+
+That's it! You can now hit "Collect translation" and Dialogic will generate a translation file for you.\
+The translation file is a specific Godot file. Here is their official documentation: [Internationalising games](https://docs.godotengine.org/en/stable/tutorials/i18n/internationalizing_games.html)
+
+### Supporting Commas
+
+In CSV, you use commas to separate columns. However, if you want to use commas inside your text, you will have to wrap your text in quotation marks.
+
+### The Translation Workflow
+
+From now on, whenever you change the CSV file, you can hit "Collect translation" and Dialogic will update the translation files for you.\
+Once you are done editing your timeline, you will have to hit "Update CSV files" to update the CSV file.
+
+In order to verify whether your timeline has been properly inserted your text into the CSV, you can switch into the timeline Text editor. Obviously, you can check the CSV file too.
+
+```
+Character: Hello world! #id:14
+Do you like Visual Novels? #id:15
+- Yes, I do! #id:16
+- No, I love them! #id:17
+That's the spirit! #id:18
+```
+
+The `#id` tags at the end of each Text Event are the translation IDs. They won't be visible during text display, however, you can be rest assured that Dialogic has inserted the text into a CSV file.
+
+## How to test Translation?
+
+If everything went well, you can select a different locale in the "Testing locale" dropdown.\
+Hit "Play Timeline" or "Run Project" and take a look at the translated text.\
+This setting is editor-only and may not work in exported projects.
+
+## Scripting API
+
+The translation process is handled by Godot!
+
+In order to change the locale when your game is exported, use the Godot API method on the [TranslationServer](https://docs.godotengine.org/en/stable/classes/class_translationserver.html#translationserver) class:
+
+```gdscript
+# Japanese's language code is "ja"
+TranslationServer.set_locale("ja")
+```