From 6c050f3b70a2dffe8abf17d449f65a901b618719 Mon Sep 17 00:00:00 2001 From: Natalia Portillo Date: Wed, 23 Nov 2022 16:38:07 +0000 Subject: [PATCH] Add readme for localization. --- Aaru.Localization/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 Aaru.Localization/README.md diff --git a/Aaru.Localization/README.md b/Aaru.Localization/README.md new file mode 100644 index 000000000..8fd856590 --- /dev/null +++ b/Aaru.Localization/README.md @@ -0,0 +1,17 @@ +This is the project where all the localized strings of the Aaru application reside. + +Many of them are shared between different projects, and even with the Aaru server, that's why they reside there. + +Here are following some tips for translators: +- The files are in the Microsoft Resource format, it shall be editable with most translation tools and if not they can be edited with Visual Studio Community (it's free). +- Each project has its own resource file. However many resources are shared, that's the reason why they are here, to not create circular dependencies. +- `Core` contains most of the shared language resources, while `UI` contains any shared language resource that is exclusive to the user interfaces (CLI or GUI). +- Other projects shall contain their own resource file appropriately named. +- The resource IDs that start with `Title_` are headers on a table or similar. +- When the resource IDs contain numbers starting in `0` it means the string contains an argument. Arguments are in the format of `{x}` with `x` being a number bigger or equal than `0`. +- If you need to put a curly bracket (`{` or `}`) you need to put it TWICE ALWAYS: `{{` or `}}`. +- If the resource ID ends with `_WithMarkup` it means it contains markup as described [here](https://spectreconsole.net/markup). +- Due to the use of square brackets (`[` or `]`) as part of markup, it's use is discouraged unless really needed. +- Right now the Microsoft resource format does not support complex plural rules (different words for `0`, `1` or more elements). If your language uses such rules please open a bug issue indicating which resource ID is affected. +- Resource IDs starting with `ButtonLabel_` are actions, and shall use the appropriate verbal tense. +- Resource IDs ending with `_Q` are questions. \ No newline at end of file