-
Notifications
You must be signed in to change notification settings - Fork 1
Adding localization to LMS plugins
The strings.txt file in the plugin folder contains all localizable strings.
Once you're done testing the plugin with your translated strings, create a pull request for the plugin GitHub repository.
-
⚠️ Make sure that there's atab
before and after the ISO language code (e.g. EN for English, FR for French)! Otherwise, (some) strings will produce a parsing error. -
Please do
not shorten the translation
, i.e. do not omit important information. Since some of these strings are supposed to be used with different UIs (LMS default skin, Material skin, piCorePlayer, SqueezePlay, or ip3k players like Boom), it's probably a good idea to keep the translated strings roughly as long as the original ones. -
If you find (multiple) blank lines in the strings.txt file, please leave them as they are. I use them to visually delineate different parts.
-
Do a
test
run: replace the strings.txt of the plugin with your new version, restart the server and check the server log for (parsing) errors. -
Avoid potentially problematic characters:
- Try not to use the double quote character (quotation mark) in your translated strings. You can use the double quotation mark instead. If the single quote character (apostrophe) causes problems, use the right single quotation mark.
- Avoid (special) characters that are used as metacharacters in programming languages (Perl), regex or SQLite.
- Try not to use the double quote character (quotation mark) in your translated strings. You can use the double quotation mark instead. If the single quote character (apostrophe) causes problems, use the right single quotation mark.
-
If there are already several localizations, the English (EN) localization is the authoritative one.
-
Please take your time, esp. if there are many strings to translate. You can use regex or AI to find (spelling) errors before you submit.