Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Descriptions for the localization #40

Open
jeblad opened this issue Jun 9, 2017 · 9 comments
Open

Descriptions for the localization #40

jeblad opened this issue Jun 9, 2017 · 9 comments

Comments

@jeblad
Copy link

jeblad commented Jun 9, 2017

Please provide proper descriptions for the localizations, qqq.json is full of way to superficial descriptions, preferably also make a glossary so the strings are standardized.

@cyberpower678
Copy link
Owner

This is just as unhelpful as the descriptions are presumably to you. Can you tell me which need improvement. They are meant to be short so the translators don't have to struggle to understand their meanings.

@jeblad
Copy link
Author

jeblad commented Jun 9, 2017 via email

@jeblad
Copy link
Author

jeblad commented Jun 9, 2017 via email

@cyberpower678
Copy link
Owner

They are from my point of view, and I received no complaints about them until now. They describe what they are, if it's on a button, or if it's describing something else.

@jeblad
Copy link
Author

jeblad commented Jun 9, 2017 via email

@cyberpower678
Copy link
Owner

I'm not arguing anything. I'm not sure what's unclear about the existing descriptors. Am I supposed to write a paragraph for each object?

@MusikAnimal
Copy link
Collaborator

Try looking at other repos for examples, such as MediaWiki. I agree descriptions like "Label" or "Checkbox" are not by themselves particularly helpful. You should provide context to explain what the message is meant to convey, and not just how it is used. However this probably less important for messages that use {{Identical}}.

To be fair to Cyberpower, I'm not sure any documentation on "best practices" exists, or if it does it is not easy to find. I tried searching on translatewiki.net and found nothing. So for now, as I said, I would model your i18n after other popular repos.

@MusikAnimal
Copy link
Collaborator

To further clarify, it is my impression that translators are generally able to look at the English message and go off of that. If they are for any reason unsure they look at the qqq, so that's why it's important to provide sufficient context. E.g. submit (which I think should be using \n{{Identical|Submit}}) is straightforward. They probably don't need to look at qqq. fpdisplayopen however says "Display open reports" which can be interpreted any number of ways for someone who is unfamiliar with the application, and finding out that it is the text for a checkbox doesn't help them.

@MusikAnimal
Copy link
Collaborator

I finally found some documentation on Localization! Thought I'd share it with you... https://www.mediawiki.org/wiki/Localisation

Specifically here, see https://www.mediawiki.org/wiki/Localisation#Message_documentation

Hope this helps

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants