Added internalisation do's and don't#927
Conversation
This is based on feedback we have collected at: Mudlet#900 http://forums.mudlet.org/viewtopic.php?f=7&t=19499
CONTRIBUTING.md
Outdated
| * minimise use of HTML styling tags in strings to be translated | ||
|
|
||
| Don't: | ||
| * translate Mudlet API functions, events, or error messages |
There was a problem hiding this comment.
I'd specify the error messages a bit further and make it scripting error messages. Because we may want to translate other error messages (like "can't connect" or other errors targeted at the actual user).
There was a problem hiding this comment.
It says "API functions, API events or API error messages", right?
There was a problem hiding this comment.
Does the clarified wording help?
|
To add another reason to the pile of why translating the API is a bad idea and why majority of the software doesn't do it - people running Mudlet on a different locale will be disadvantaged when it comes to using off-the-shelf scripts. If we start translating fundamentals like the |
|
Though the users will be able to have sub-consoles/labels etc. with whatever title they want won't they as long as it isn't "main"? |
|
Yeah, users should be able to name Mudlet objects using non-Latin text. |
|
@SlySven I've clarified it some more off your feedback - how does it look now? |
CONTRIBUTING.md
Outdated
|
|
||
| Don't: | ||
| * translate the Mudlet API: functions, events, or error messages | ||
| * translate the Mudlet API: functions, events, error messages or constants (`main` console, mapper directions) |
There was a problem hiding this comment.
"mapper directions" ? - you may have to be a bit more specific/focused as one of the things we WILL have to add is a system to customise the strings that Mudlet produces for speed-walking and those WILL need to have language specific, but over-ridable, defaults to use...!
OTOH any new function added that takes or produces exit directions WILL need to be coded with care to fit in with existing methods!
There was a problem hiding this comment.
OK. I will take that part out for now. I agree they need to be customisable, but in a way that is transparent to the mapper script.
|
@SlySven re-check. |
| Don't: | ||
| * translate the Mudlet API: functions, events, error messages or constants (`main` console, mapper directions) | ||
| * use numbers in the API - English words are preferred instead | ||
| * try to assemble a sentence on the fly - English grammar does not translate into other languages. Present the full sentence to translators instead |
There was a problem hiding this comment.
-
assume English-centric plural forms, other languages do not necessarily have the simple add an "s"/"es" for more/less then the singular case.†
-
assume universal quote and number punctuation formats. There are languages that use
«and»instead of"for "quoting" words or phrases. Qt can provide Locale specific displays of numbers/dates/times; we may have to look at them in more detail as we get further into Internationalization.
† Consider the tr("Deleted %n rooms(s).", "", x ) form that takes the integer value x and puts it into the %n place-holder and allows multiple alternate sentence forms to be provided by translation as needed by the value of x. This form is not that widely documented and only handles a phrase/sentence with a single variable so the source code may need revising to make use of this in cases where more than one value is involved.
|
Yeah, 76e6bb0 is good. |
|
Vadim wrote:
See (and approve? 🙏) #941 |
This is based on feedback we have already collected at:
#900
http://forums.mudlet.org/viewtopic.php?f=7&t=19499
Just writing down the knowledge gained from those conversations so we don't get into loops about this. Should be pretty straight-forward.
Tagging @Mudlet/core-cpp for review.