Skip to content

Localization #2195

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.

Sign up for GitHub

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

Merged
merged 22 commits into from
Dec 11, 2017
Merged

Localization #2195

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
7e075f5
localization routine and tests
alexcjohnson Dec 6, 2017
9a9de77
remove zsmooth that doesn't apply to contourcarpet
alexcjohnson Dec 6, 2017
d859de5
wrap all displayed strings in localize
alexcjohnson Dec 6, 2017
7d057e5
task to collect translation keys and verify syntax
alexcjohnson Dec 6, 2017
8a5eeec
looser placeholder check in titles
alexcjohnson Dec 7, 2017
03dcb5d
lint
alexcjohnson Dec 7, 2017
bf2c6db
move colons into the translations
alexcjohnson Dec 7, 2017
04ed6f0
set default locale to en-US and build this into the library
alexcjohnson Dec 8, 2017
0f8520e
turn log level 1 on by default and move zsmooth messages to logs
alexcjohnson Dec 8, 2017
5d6f267
take <br> out of notifier messages
alexcjohnson Dec 8, 2017
97c0898
include file & line number with translation keys
alexcjohnson Dec 8, 2017
daf0884
disable logging in image server
alexcjohnson Dec 8, 2017
4b48038
convert locales to json, only en(US)? in bundles, and build all local…
alexcjohnson Dec 8, 2017
4b8f980
move geo missing id warn -> log
alexcjohnson Dec 8, 2017
1275661
convert locales back into js instead of json
alexcjohnson Dec 8, 2017
fc03cce
change "unable to bind..." warning to a log
alexcjohnson Dec 8, 2017
cb2f00c
fix command test for warn -> log
alexcjohnson Dec 8, 2017
97821e9
tweak a few of the string literals for consistency
alexcjohnson Dec 8, 2017
e80ec91
fix sankey test and clean log messages from other tests
alexcjohnson Dec 8, 2017
8b9e7d8
remove invalid data from geo_choropleth-text.json
alexcjohnson Dec 8, 2017
6029f94
update finance test for lowercase labels
alexcjohnson Dec 8, 2017
9708b56
update select_test for choropleth mock change
alexcjohnson Dec 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 56 additions & 60 deletions dist/translation-keys.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,60 +1,56 @@
Autoscale
Box Select
Click to enter Colorscale title
Click to enter Component A title
Click to enter Component B title
Click to enter Component C title
Click to enter Plot title
Click to enter X axis title
Click to enter Y axis title
Close:
Compare data on hover
Double click on legend to isolate individual trace
Double-click to<br>zoom back out
Download plot as a png
Edit in Chart Studio
High:
IE only supports svg. Changing format to svg.
Incoming flow count:
Lasso Select
Low:
Open:
Orbital rotation
Outgoing flow count:
Pan
Produced with Plotly
Reset
Reset axes
Reset camera to default
Reset camera to last save
Reset view
Reset views
Show closest data on hover
Snapshot succeeded
Sorry there was a problem downloading your snapshot!
Source:
Taking snapshot - this may take a few seconds
Target:
Toggle Spike Lines
Toggle show closest data on hover
Turntable rotation
Zoom
Zoom in
Zoom out
cannot use zsmooth: "fast"
kde:
lat:
log axis found
lon:
lower fence:
max:
mean ± σ:
mean:
median:
min:
q1:
q3:
trace
upper fence:
x scale is not linear
y scale is not linear
Autoscale // components/modebar/buttons.js:139
Box Select // components/modebar/buttons.js:103
Click to enter Colorscale title // plots/plots.js:437
Click to enter Component A title // plots/ternary/ternary.js:386
Click to enter Component B title // plots/ternary/ternary.js:400
Click to enter Component C title // plots/ternary/ternary.js:411
Click to enter Plot title // plot_api/plot_api.js:579
Click to enter X axis title // plots/plots.js:435
Click to enter Y axis title // plots/plots.js:436
Close: // traces/ohlc/transform.js:139
Compare data on hover // components/modebar/buttons.js:167
Double click on legend to isolate individual trace // components/legend/handle_click.js:90
Double-click to zoom back out // plots/cartesian/dragbox.js:299
Download plot as a png // components/modebar/buttons.js:52
Edit in Chart Studio // components/modebar/buttons.js:76
High: // traces/ohlc/transform.js:137
IE only supports svg. Changing format to svg. // components/modebar/buttons.js:60
Incoming flow count: // traces/sankey/plot.js:142
Lasso Select // components/modebar/buttons.js:112
Low: // traces/ohlc/transform.js:138
Open: // traces/ohlc/transform.js:136
Orbital rotation // components/modebar/buttons.js:279
Outgoing flow count: // traces/sankey/plot.js:143
Pan // components/modebar/buttons.js:94
Produced with Plotly // components/modebar/modebar.js:256
Reset // components/modebar/buttons.js:432
Reset axes // components/modebar/buttons.js:148
Reset camera to default // components/modebar/buttons.js:314
Reset camera to last save // components/modebar/buttons.js:322
Reset view // components/modebar/buttons.js:583
Reset views // components/modebar/buttons.js:529
Show closest data on hover // components/modebar/buttons.js:157
Snapshot succeeded // components/modebar/buttons.js:66
Sorry there was a problem downloading your snapshot! // components/modebar/buttons.js:69
Source: // traces/sankey/plot.js:140
Taking snapshot - this may take a few seconds // components/modebar/buttons.js:57
Target: // traces/sankey/plot.js:141
Toggle Spike Lines // components/modebar/buttons.js:548
Toggle show closest data on hover // components/modebar/buttons.js:353
Turntable rotation // components/modebar/buttons.js:288
Zoom // components/modebar/buttons.js:85
Zoom in // components/modebar/buttons.js:121
Zoom out // components/modebar/buttons.js:130
kde: // traces/violin/calc.js:73
lat: // traces/scattergeo/calc.js:48
lon: // traces/scattergeo/calc.js:49
lower fence: // traces/box/calc.js:134
max: // traces/box/calc.js:132
mean ± σ: // traces/box/calc.js:133
mean: // traces/box/calc.js:133
median: // traces/box/calc.js:128
min: // traces/box/calc.js:129
q1: // traces/box/calc.js:130
q3: // traces/box/calc.js:131
trace // plots/plots.js:439
upper fence: // traces/box/calc.js:135
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@etpinard @bpostlethwaite thoughts on this format, with the (first) source line for each key included for a translator to use for more context?

Also having all these strings together raises some questions about whether they're all actually what we want, or if any could be made more consistent:

  • Is the verb "Double-click" or "Double click"?
  • Most of the hover label names (the items ending in ':') are lowercase, but some (OHLC, sankey) are capitalized - is this what we want?
  • In making this PR I standardized the "Click to enter <item> title" ones to have <item> capitalized (previously one or two of them were lowercase) - is that correct?
  • Most of the Lib.notifier items have no punctuation but some of them do. Should we standardize?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thoughts on this format,

I like this format a lot. Nicely done 👌

Is the verb "Double-click" or "Double click"?

I have no preference.

Most of the hover label names (the items ending in ':') are lowercase, but some (OHLC, sankey) are capitalized - is this what we want?

I'd vote for standardizing to lower case.

I standardized the "Click to enter title" [...] is that correct?

fine by me.

Most of the Lib.notifier items have no punctuation but some of them do. Should we standardize?

No preference.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made all the hover labels lower case, standardized on "Double-click" (when used as a verb, which is the only way we use it in plotly.js text), and tweaked a few other messages -> 97821e9

19 changes: 16 additions & 3 deletions tasks/find_locale_strings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ function findLocaleStrings() {

var dict = {};
var hasTranslation = false;
var maxLen = 0;

files.forEach(function(file) {
var code = fs.readFileSync(file, 'utf-8');
var filePartialPath = file.substr(constants.pathToSrc.length);

falafel(code, {locations: true}, function(node) {
// parse through code string looking for translated strings
Expand All @@ -44,8 +46,11 @@ function findLocaleStrings() {
if(strNode.type !== 'Literal') {
logError(file, node, 'Translated string must be a literal');
}
dict[strNode.value] = 1;
hasTranslation = true;
if(!dict[strNode.value]) {
dict[strNode.value] = filePartialPath + ':' + node.loc.start.line;
maxLen = Math.max(maxLen, strNode.value.length);
hasTranslation = true;
}
}

// make sure localize is the only thing we assign to a variable `_`
Expand All @@ -65,7 +70,9 @@ function findLocaleStrings() {
}

if(!EXIT_CODE) {
var strings = Object.keys(dict).sort().join('\n');
var strings = Object.keys(dict).sort().map(function(k) {
return k + spaces(maxLen - k.length) + ' // ' + dict[k];
}).join('\n');
common.writeFile(constants.pathToTranslationKeys, strings);
console.log('ok find_locale_strings');
}
Expand All @@ -78,6 +85,12 @@ function logError(file, node, msg) {
EXIT_CODE = 1;
}

function spaces(len) {
var out = '';
for(var i = 0; i < len; i++) out += ' ';
return out;
}

process.on('exit', function() {
if(EXIT_CODE) {
throw new Error('find_locale_strings failed.');
Expand Down