Add i18n #27

Niharika29 · 2016-09-15T12:20:12Z

Add SimpleI18n support to project
Extract out all message keys to en.json
Replace all keys in twig and js by message keys
Update README

…to addI18n

MusikAnimal · 2016-09-15T16:13:25Z

public_html/i18n/en.json

+  "js-unauthorized": "You need to be logged in to be able to review.",
+  "js-dberror": "There was an error in connecting to database.",
+  "js-undo-own-only": "You can only undo your own reviews.",
+  "js-unknown-error": "An unknown error occurred when loading results. Please try again."


The only thing is I would avoid including links and markup in the messages. E.g. you get rid of footer-source and instead just have "source": "Source" and our HTML, <a href="https://github.com/wikimedia/PlagiabotWeb">{{ 'source'|message }}</a>. The markup is not translatable and there's a chance someone might unintentionally break it.

And for footer-poweredby you could use: Powered by $1 and $2 since EranBot and Turnitin are also not translatable. If they are, make a separate message for turnitin then in our HTML:
{{ 'footer-poweredby'|message | ( <a href="https://en.wikipedia.org/wiki/Wikipedia:Turnitin">{{ 'turnitin'|message }}</a> | <a href="https://en.wikipedia.org/wiki/User:EranBot">{{ 'EranBot'|message }}</a> }} (this is pseudocode, not sure how SimpleI18n works)

Also it should be https://github.com/wikimedia/CopyPatrol

Updated. I also fixed some links in Image attribution modal. I didn't break it up into 12 messages but 8 instead.
The link in footer is https://github.com/wikimedia/CopPatrol only. Did you see otherwise anywhere?

Also, simpleI18n doesn't support the sort of markup you were suggesting above so I resorted to break out the text.

MusikAnimal · 2016-09-15T16:16:58Z

Trying out these Gerrrit-wannabe features on GitHub, "Changes requested" doesn't mean I'm demanding any changes!

Other trivial changes

MusikAnimal · 2016-09-16T18:18:47Z

I pushed directly to your branch, hope that's OK...

To pass markup containing messages as a parameter to a message, I found you could use {% set variable %} followed by a block of HTML.

A few notes that I've learned doing i18n:

For simple words or phrases, it's probably better to not make them specific to a particular part of the interface unless you are sure the message may differ from the identical translation based on where it's located. So if we used the word "WikiProjects" somewhere else, we wouldn't have to ask for a new translation but instead use the existing "wikiprojects" message (as opposed to "form-wikiprojects" and "col-wikiprojects").
Avoid asking for translations of proper nouns. E.g. "EranBot" is a username and would be the same in every language
Finally, we need to add qqq documentation, like this. For direct translations of words, such as "login", append "\n{{Identical}}" to the end of qqq message.

Sorry if I'm being anal! I just think we should try to make it easy as possible for the translatewiki folks, because they are awesome.

Other not important things:

I used spaces to separate the pipes in the twig templates. I found this easier to read, but purely a nitpick. Maybe I should find a Twig syntax highlighter.
JavaScript variables are by convention camelCased
For public-facing attribution I prefer to go by MusikAnimal :)

That is the extent of my stupid quibbles!

Niharika29 · 2016-09-19T13:58:59Z

A few notes that I've learned doing i18n:

For simple words or phrases, it's probably better to not make them specific to a particular part of the interface unless you are sure the message may differ from the identical translation based on where it's located. So if we used the word "WikiProjects" somewhere else, we wouldn't have to ask for a new translation but instead use the existing "wikiprojects" message (as opposed to "form-wikiprojects" and "col-ewikiprojects")

For Copypatrol, I think I agree. When I did i18n for Wikimania scholarships app and Grants app, it was very prone to interface changes from time to time and hence separate keys were encouraged.

Avoid asking for translations of proper nouns. E.g. "EranBot" is a username and would be the same in every language

Got it.

Finally, we need to add qqq documentation, like this. For direct translations of words, such as "login", append "\n{{Identical}}" to the end of qqq message.

Thanks for reminding me to do this!

Sorry if I'm being anal! I just think we should try to make it easy as possible for the translatewiki folks, because they are awesome.

Agreed. :)

Other not important things:

I used spaces to separate the pipes in the twig templates. I found this easier to read, but purely a nitpick. Maybe I should find a Twig syntax highlighter.

I've worked with twig before for quite a while (here, for example) and never used spaces with the pipe separator. If you don't mind, I'll like to continue to have it that way.

JavaScript variables are by convention camelCased

Oh, right.

For public-facing attribution I prefer to go by MusikAnimal :).

Will remember in future.

safe - dont fail on missing metadata

kaldari · 2016-09-20T01:05:40Z

public_html/i18n/en.json

+  "phabricator": "Phabricator",
+  "footer-imageattr": "Image attribution",
+  "lboard-title": "Leaderboard",
+  "lboard-week": "Cases closed in the<br/> last 7 days",


Hardcoded linebreaks don't really work for translation, since the translators won't know where to put the linebreaks to make sure things wrap correctly. Danny originally wanted this done so that all the columns lined up right, but we can probably figure out a better way to do this in a future commit. For now, let's just remove the line breaks and let the lines wrap naturally (even if they don't all line up perfectly).

kaldari · 2016-09-20T01:07:58Z

public_html/i18n/en.json

+  "form-mine": "My reviews",
+  "form-drafts": "Drafts only",
+  "wikiprojects": "Wikiprojects",
+  "form-wikiprojects-placeholder": "Type Wikiproject names...",


"WikiProject" is always camelcase.

Other trivial changes

…to addI18n

Niharika29 · 2016-09-20T12:32:24Z

I've made the fixes and rebased the patch. I took this opportunity to split out the header, footer and modal templates from the base template. The code was nearly incomprehensible.
I've let the twig pipe spaces be because I don't mind them if that's what MusikAnimal prefers. We're nearly done with this app anyway.

bd808

A few nits inline. Mostly about making the qqq descriptions more useful for translators.

bd808 · 2016-09-20T17:23:38Z

src/Controllers/CopyPatrol.php

+				$editor = null;
+				if ( isset( $record['diff'] ) && isset( $editors[$record['diff']] ) ) {
+					$editor = $editors[$record['diff']];
+				}


Block overindented?

bd808 · 2016-09-20T17:24:58Z

public_html/i18n/qqq.json

+  "documentation": "Link to documentation in header\n{{Identical|Documentation}}",
+  "feedback": "Link to feedback in header\n{{Identical|Feedback}}",
+  "leaderboard": "Link to leaderboard in header",
+  "login": "Butten label\n{{Identical|login}}",


bd808 · 2016-09-20T17:25:51Z

public_html/i18n/qqq.json

+  "record-editcount": "Label to indicate number of edits a user has made",
+  "compare": "Button label to open a panel for text comparison between two pages",
+  "record-ithenticate": "Button label for a button to go to the original plagiarism report generated by Turnitin",
+  "record-url-text": "Label text to show amount of plagiarism.\n Parameters: $1 - Percentage of edit that was plagirized.\n $2 - Number of words plagiarized.",


"plagiarized"

bd808 · 2016-09-20T17:26:51Z

public_html/i18n/qqq.json

+  "compare-source-loading": "Temporary text shown to user while copyvio text source loads",
+  "footer-loadmore": "Label for a button to load more records.",
+  "footer-nomore": "Label to indicate no more records in database.",
+  "footer-broughtby": "Footer text to indicate authors. \n Parameters: $1 - String.",


$1 - List of names?

bd808 · 2016-09-20T17:27:15Z

public_html/i18n/qqq.json

+  "footer-nomore": "Label to indicate no more records in database.",
+  "footer-broughtby": "Footer text to indicate authors. \n Parameters: $1 - String.",
+  "footer-commtech": "Footer text - name of team.",
+  "footer-poweredby": "Footer text to highlight sources used for development. \n Parameters: $1 - String. $2 - String.",


"String" is not descriptive at all for a translator.

bd808 · 2016-09-20T17:28:43Z

public_html/i18n/qqq.json

+  "public-domain": "Text as part of the attributions box",
+  "open-font-license": "Text as part of the attributions box",
+  "imageattr-paragraph1": "Text as part of the attributions box. \n Parameters: $1, $2, $3, $4 - Strings.",
+  "imageattr-paragraph2": "Text as part of the attributions box. \n Parameters: $1, $2, $3 - Strings.",


Again, the "Strings" description won't help a translator understand the resulting sentence/phrase.

We might want to make it clear the imageattr messages should be gender-neutral (User:Xander89 hasn't specified their gender, other proper nouns are not human) and that {{GENDER}} should not be used, since the parameters are links. In Intuition a PHP error is thrown if GENDER is used on markup, I think, not sure if the same is true for Simplei18n

kaldari

A couple qqq suggestions.

kaldari · 2016-09-20T19:05:58Z

public_html/i18n/qqq.json

+      "Ryan Kaldari"
+    ]
+  },
+  "name": "Title of the application/tool",


You may want to mark this one as optional to translate, since it's a proper noun and a translation isn't strictly needed. To mark something as optional to translate, add {{Optional}}\n to the beginning of it.

kaldari · 2016-09-20T19:09:02Z

public_html/i18n/qqq.json

+  "name": "Title of the application/tool",
+  "documentation": "Link to documentation in header\n{{Identical|Documentation}}",
+  "feedback": "Link to feedback in header\n{{Identical|Feedback}}",
+  "leaderboard": "Link to leaderboard in header",


"Leaderboard" may be tricky to understand. You might want to explain this better, like "Link to a list of the top reviewers in header".

bd808

LGTM

Niharika29 added 3 commits September 15, 2016 17:42

Add internationalization

dc20691

Add internationalization

82be74e

Merge branch 'addI18n' of https://github.com/Niharika29/CopyPatrol in…

3dd1a4f

…to addI18n

MusikAnimal requested changes Sep 15, 2016

View reviewed changes

MusikAnimal and others added 4 commits September 15, 2016 14:16

update build status URL to reflect new location

ae39d50

rm DB_DSN_WIKIPROJECT no longer using this service

298731e

Update messages, remove html

f124155

Generalize i18n messages, use {% set %} to nest markup in messages

283a49a

Other trivial changes

eranroz added 2 commits September 18, 2016 21:04

safe - dont fail on missing metadata

3e8e81d

rm extra parenthesis

7364f00

Merge pull request wikimedia#28 from eranroz/master

ecda678

safe - dont fail on missing metadata

kaldari requested changes Sep 20, 2016

View reviewed changes

Niharika29 and others added 7 commits September 20, 2016 17:42

Split out header, footer & modal; Add qqq; Changes per review

a12cc60

Add internationalization

4188d98

Add internationalization

8d4f93b

Update messages, remove html

8b81663

Generalize i18n messages, use {% set %} to nest markup in messages

6a96c26

Other trivial changes

Split out header, footer & modal; Add qqq; Changes per review

54e1dc9

Merge branch 'addI18n' of https://github.com/Niharika29/CopyPatrol in…

b631075

…to addI18n

bd808 reviewed Sep 20, 2016

View reviewed changes

kaldari reviewed Sep 20, 2016

View reviewed changes

qqq fixes; fix indentation

80c58ae

bd808 approved these changes Sep 24, 2016

View reviewed changes

kaldari approved these changes Sep 28, 2016

View reviewed changes

MusikAnimal approved these changes Sep 28, 2016

View reviewed changes

kaldari merged commit 22d401b into wikimedia:master Sep 28, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add i18n #27

Add i18n #27

Niharika29 commented Sep 15, 2016

MusikAnimal Sep 15, 2016 •

edited

MusikAnimal Sep 15, 2016

Niharika29 Sep 16, 2016

Niharika29 Sep 16, 2016

MusikAnimal commented Sep 15, 2016

MusikAnimal commented Sep 16, 2016 •

edited

Niharika29 commented Sep 19, 2016

kaldari Sep 20, 2016

kaldari Sep 20, 2016

Niharika29 commented Sep 20, 2016

bd808 left a comment

bd808 Sep 20, 2016 •

edited

bd808 Sep 20, 2016

bd808 Sep 20, 2016

bd808 Sep 20, 2016

bd808 Sep 20, 2016

bd808 Sep 20, 2016

MusikAnimal Sep 20, 2016 •

edited

kaldari left a comment

kaldari Sep 20, 2016

kaldari Sep 20, 2016 •

edited

bd808 left a comment

Add i18n #27

Add i18n #27

Conversation

Niharika29 commented Sep 15, 2016

MusikAnimal Sep 15, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MusikAnimal commented Sep 15, 2016

MusikAnimal commented Sep 16, 2016 • edited

Niharika29 commented Sep 19, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Niharika29 commented Sep 20, 2016

bd808 left a comment

Choose a reason for hiding this comment

bd808 Sep 20, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MusikAnimal Sep 20, 2016 • edited

Choose a reason for hiding this comment

kaldari left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaldari Sep 20, 2016 • edited

Choose a reason for hiding this comment

bd808 left a comment

Choose a reason for hiding this comment

MusikAnimal Sep 15, 2016 •

edited

MusikAnimal commented Sep 16, 2016 •

edited

bd808 Sep 20, 2016 •

edited

MusikAnimal Sep 20, 2016 •

edited

kaldari Sep 20, 2016 •

edited