Skip to content

Commit 9373006

Browse files
sm7515sm7515
committed
merge
2 parents 2e41188 + 0017860 commit 9373006

27 files changed

+2311
-1125
lines changed

‎contributor_docs/i18n_contribution.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,10 +198,13 @@ In some cases, the text translated from the original .hbs file (written in HTML)
198198

199199
### Translation of Reference
200200

201-
* The reference works a bit differently. The pages are built in English based on the inline documentation in the source code. They are then swapped out using JS on the front-end.
201+
* The reference works a bit differently. The pages are built in English based on the inline documentation in the p5.js source code. The English text is then swapped out with the appropriate translation using JS on the front-end.
202+
* The inline API documentation is automatically extracted from the p5.js repository using [YUIdoc](https://yui.github.io/yuidoc/) and saved in a [JSON file](https://github.com/processing/p5.js-website/blob/master/src/templates/pages/reference/data.json).
203+
* The translation files are created from the data.json file, but have a different structure (i.e. [es.json](https://github.com/processing/p5.js-website/blob/master/src/data/reference/es.json)).
202204
* The top level keys in the JSON object correspond to the page headings, menu, footer, etc. You can see all the swaps in [this file](https://github.com/processing/p5.js-website/blob/master/src/templates/pages/reference/index.hbs#L60).
203205
* The "p5" key in the JSON object contains individual keys for each reference entry, indexed by variable/function/object name.
204206
* Any entries in the JSON object which are not filled in will be left in English when the page is loaded.
207+
* The translated versions of the JSON file need to be manually created and updated.
205208
* This is a somewhat hacky solution and not ideal. However, it comes from balancing the desire to have documentation directly in the source code, with the unwieldiness of having multiple languages of documentation inline. It will be our working solution until a better one is found.
206209
* The source content for the reference is handled inline in the [p5.js source code](https://github.com/processing/p5.js). See [Inline documentation](https://github.com/processing/p5.js/blob/master/contributor_docs/inline_documentation.md) in the p5.js repo for information on how to contribute.
207210

‎i18n-tracking.yml

Lines changed: 326 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,126 @@
11
es:
22
src/data/en.yml:
3+
line 720: ' project-links-text-2-roni-cantor'
4+
line 721: ' project-q-1-1'
5+
line 727: ' project-q-2'
6+
line 730: ' project-a-2-3-roni-cantor'
7+
line 713: ''
8+
line 714: ''
9+
line 715: ' created-by'
10+
line 716: ' pronouns-female'
11+
line 717: ' creator-from-roni-cantor'
12+
line 718: ' project-links'
13+
line 719: ' project-links-text-1-roni-cantor'
14+
line 722: ' project-q-1-2'
15+
line 723: ' project-a-1-1-roni-cantor'
16+
line 724: ' project-a-1-2-roni-cantor'
17+
line 725: ' project-a-1-3-roni-cantor'
18+
line 726: ' project-a-1-4-roni-cantor'
19+
line 728: ' project-a-2-1-roni-cantor'
20+
line 729: ' project-a-2-2-roni-cantor'
21+
line 731: ' project-a-2-4-roni-cantor'
22+
line 732: ' project-a-2-5-roni-cantor'
23+
line 733: ' project-q-3'
24+
line 734: ' project-a-3-roni-cantor'
25+
line 735: ' project-q-4'
26+
line 736: ' project-a-4-roni-cantor'
27+
line 737: ' project-q-5'
28+
line 738: ' project-a-5-roni-cantor'
29+
line 739: ' project-q-6'
30+
line 740: ' project-a-6-roni-cantor'
31+
line 741: ''
32+
line 742: ' project-resources'
33+
line 743: ' creator-from-qianqian'
34+
line 744: ' project-a-1-1-qianqian'
35+
line 745: ' project-a-1-2-qianqian'
36+
line 746: ' project-a-2-1-qianqian'
37+
line 747: ' project-a-2-2-qianqian'
38+
line 748: ' project-a-2-3-qianqian'
39+
line 749: ' project-a-2-4-qianqian'
40+
line 750: ' project-a-3-1-qianqian'
41+
line 754: ' project-a-4-3-qianqian'
42+
line 755: ' project-a-5-1-qianqian'
43+
line 756: ' project-a-5-2-qianqian'
44+
line 757: ''
45+
line 758: ' creator-from-phuong'
46+
line 759: ' project-a-1-1-phuong'
47+
line 760: ' project-a-1-2-phuong'
48+
line 761: ' project-a-1-3-phuong'
49+
line 762: ' project-a-1-4-phuong'
50+
line 763: ' project-a-2-1-phuong'
51+
line 764: ' project-a-2-2-phuong'
52+
line 765: ' project-a-2-3-phuong'
53+
line 766: ' project-a-2-4-phuong'
54+
line 767: ' project-a-2-5-phuong'
55+
line 768: ' project-a-2-6-phuong'
56+
line 769: ' project-a-2-7-phuong'
57+
line 770: ' project-a-3-1-phuong'
58+
line 771: ' project-a-3-2-phuong'
59+
line 772: ' project-a-3-3-phuong'
60+
line 773: ' project-a-3-4-phuong'
61+
line 774: ' project-a-4-1-phuong'
62+
line 775: ' project-a-5-1-phuong'
63+
line 776: ' project-a-5-2-phuong'
64+
line 777: ''
65+
line 778: ' pronouns-male'
66+
line 779: ' creator-from-chung'
67+
line 780: ' project-a-1-1-chung'
68+
line 781: ' project-a-1-2-chung'
69+
line 782: ' project-a-1-3-chung'
70+
line 783: ' project-a-2-1-chung'
71+
line 784: ' project-a-2-2-chung'
72+
line 785: ' project-a-3-1-chung'
73+
line 786: ' project-a-3-2-chung'
74+
line 787: ' project-a-4-1-chung'
75+
line 788: ' project-a-4-2-chung'
76+
line 789: ' project-a-4-3-chung'
77+
line 790: ' project-a-5-1-chung'
78+
line 791: ' project-a-5-2-chung'
79+
line 792: ''
80+
line 793: ' creator-from-casey-louise'
81+
line 794: ' project-a-1-1-casey-louise'
82+
line 751: ' project-a-3-2-qianqian'
83+
line 752: ' project-a-4-1-qianqian'
84+
line 753: ' project-a-4-2-qianqian'
85+
line 795: ' project-a-1-2-casey-louise'
86+
line 796: ' project-a-1-3-casey-louise'
87+
line 797: ' project-a-1-4-casey-louise'
88+
line 798: ' project-a-1-5-casey-louise'
89+
line 799: ' project-a-2-1-casey-louise'
90+
line 800: ' project-a-2-2-casey-louise'
91+
line 801: ' project-a-3-1-casey-louise'
92+
line 802: ' project-a-3-2-casey-louise'
93+
line 803: ' project-a-3-3-casey-louise'
94+
line 804: ' project-a-3-4-casey-louise'
95+
line 805: ' project-a-3-5-casey-louise'
96+
line 806: ' project-a-4-1-casey-louise'
97+
line 807: ' project-a-4-2-casey-louise'
98+
line 808: ' project-a-4-3-casey-louise'
99+
line 809: ' project-a-4-4-casey-louise'
100+
line 810: ' project-a-4-5-casey-louise'
101+
line 811: ' project-a-4-6-casey-louise'
102+
line 812: ' project-a-4-7-casey-louise'
103+
line 813: ' project-a-5-1-casey-louise'
104+
line 814: ' project-a-5-2-casey-louise'
105+
line 815: ''
106+
line 816: ' pronouns-nonbinary'
107+
line 817: ' creator-from-moon'
108+
line 818: ' posters-by'
109+
line 819: ' project-a-1-1-moon'
110+
line 820: ' project-a-1-2-moon'
111+
line 821: ' project-a-1-3-moon'
112+
line 822: ' project-a-1-4-moon'
113+
line 823: ' project-a-1-5-moon'
114+
line 824: ' project-a-2-1-moon'
115+
line 825: ' project-a-2-2-moon'
116+
line 826: ' project-a-2-3-moon'
117+
line 827: ' project-a-3-1-moon'
118+
line 828: ' project-a-3-2-moon'
119+
line 829: ' project-a-3-3-moon'
120+
line 830: ' project-a-3-4-moon'
121+
line 831: ' project-a-4-1-moon'
122+
line 832: ' project-a-5-1-moon'
123+
line 833: ' project-a-5-2-moon'
3124
line 480: ' notes3'
4125
line 44: ' description-roni'
5126
line 45: ' project-phuong'
@@ -171,6 +292,170 @@ es:
171292
line 551: ' credit-moon-xin'
172293
line 552: ' description-moon-xin'
173294
line 669: ' credit-moon-xin'
295+
line 672: ' created-by'
296+
line 673: ' pronouns-female'
297+
line 674: ' creator-from-roni-cantor'
298+
line 675: ' project-links'
299+
line 676: ' project-links-text-1-roni-cantor'
300+
line 677: ' project-links-text-2-roni-cantor'
301+
line 678: ' project-q-1-1'
302+
line 679: ' project-q-1-2'
303+
line 680: ' project-a-1-1-roni-cantor'
304+
line 681: ' project-a-1-2-roni-cantor'
305+
line 682: ' project-a-1-3-roni-cantor'
306+
line 683: ' project-a-1-4-roni-cantor'
307+
line 684: ' project-q-2'
308+
line 685: ' project-a-2-1-roni-cantor'
309+
line 686: ' project-a-2-2-roni-cantor'
310+
line 687: ' project-a-2-3-roni-cantor'
311+
line 688: ' project-a-2-4-roni-cantor'
312+
line 689: ' project-a-2-5-roni-cantor'
313+
line 690: ' project-q-3'
314+
line 691: ' project-a-3-roni-cantor'
315+
line 692: ' project-q-4'
316+
line 693: ' project-a-4-roni-cantor'
317+
line 694: ' project-q-5'
318+
line 695: ' project-a-5-roni-cantor'
319+
line 696: ' project-q-6'
320+
line 697: ' project-a-6-roni-cantor'
321+
line 698: ''
322+
line 699: ' project-resources'
323+
line 700: ' creator-from-qianqian'
324+
line 701: ' project-a-1-1-qianqian'
325+
line 702: ' project-a-1-2-qianqian'
326+
line 703: ' project-a-2-1-qianqian'
327+
line 704: ' project-a-2-2-qianqian'
328+
line 705: ' project-a-2-3-qianqian'
329+
line 706: ' project-a-2-4-qianqian'
330+
line 707: ' project-a-3-1-qianqian'
331+
line 708: ' project-a-3-2-qianqian'
332+
line 709: ' project-a-4-1-qianqian'
333+
line 710: ' project-a-4-2-qianqian'
334+
line 711: ' project-a-4-3-qianqian'
335+
line 712: ' project-a-5-1-qianqian'
336+
zh-Hans:
337+
src/data/en.yml:
338+
line 720: ' project-links-text-2-roni-cantor'
339+
line 721: ' project-q-1-1'
340+
line 727: ' project-q-2'
341+
line 730: ' project-a-2-3-roni-cantor'
342+
line 713: ''
343+
line 714: ''
344+
line 715: ' created-by'
345+
line 716: ' pronouns-female'
346+
line 717: ' creator-from-roni-cantor'
347+
line 718: ' project-links'
348+
line 719: ' project-links-text-1-roni-cantor'
349+
line 722: ' project-q-1-2'
350+
line 723: ' project-a-1-1-roni-cantor'
351+
line 724: ' project-a-1-2-roni-cantor'
352+
line 725: ' project-a-1-3-roni-cantor'
353+
line 726: ' project-a-1-4-roni-cantor'
354+
line 728: ' project-a-2-1-roni-cantor'
355+
line 729: ' project-a-2-2-roni-cantor'
356+
line 731: ' project-a-2-4-roni-cantor'
357+
line 732: ' project-a-2-5-roni-cantor'
358+
line 733: ' project-q-3'
359+
line 734: ' project-a-3-roni-cantor'
360+
line 735: ' project-q-4'
361+
line 736: ' project-a-4-roni-cantor'
362+
line 737: ' project-q-5'
363+
line 738: ' project-a-5-roni-cantor'
364+
line 739: ' project-q-6'
365+
line 740: ' project-a-6-roni-cantor'
366+
line 741: ''
367+
line 742: ' project-resources'
368+
line 743: ' creator-from-qianqian'
369+
line 744: ' project-a-1-1-qianqian'
370+
line 745: ' project-a-1-2-qianqian'
371+
line 746: ' project-a-2-1-qianqian'
372+
line 747: ' project-a-2-2-qianqian'
373+
line 748: ' project-a-2-3-qianqian'
374+
line 749: ' project-a-2-4-qianqian'
375+
line 750: ' project-a-3-1-qianqian'
376+
line 754: ' project-a-4-3-qianqian'
377+
line 755: ' project-a-5-1-qianqian'
378+
line 756: ' project-a-5-2-qianqian'
379+
line 757: ''
380+
line 758: ' creator-from-phuong'
381+
line 759: ' project-a-1-1-phuong'
382+
line 760: ' project-a-1-2-phuong'
383+
line 761: ' project-a-1-3-phuong'
384+
line 762: ' project-a-1-4-phuong'
385+
line 763: ' project-a-2-1-phuong'
386+
line 764: ' project-a-2-2-phuong'
387+
line 765: ' project-a-2-3-phuong'
388+
line 766: ' project-a-2-4-phuong'
389+
line 767: ' project-a-2-5-phuong'
390+
line 768: ' project-a-2-6-phuong'
391+
line 769: ' project-a-2-7-phuong'
392+
line 770: ' project-a-3-1-phuong'
393+
line 771: ' project-a-3-2-phuong'
394+
line 772: ' project-a-3-3-phuong'
395+
line 773: ' project-a-3-4-phuong'
396+
line 774: ' project-a-4-1-phuong'
397+
line 775: ' project-a-5-1-phuong'
398+
line 776: ' project-a-5-2-phuong'
399+
line 777: ''
400+
line 778: ' pronouns-male'
401+
line 779: ' creator-from-chung'
402+
line 780: ' project-a-1-1-chung'
403+
line 781: ' project-a-1-2-chung'
404+
line 782: ' project-a-1-3-chung'
405+
line 783: ' project-a-2-1-chung'
406+
line 784: ' project-a-2-2-chung'
407+
line 785: ' project-a-3-1-chung'
408+
line 786: ' project-a-3-2-chung'
409+
line 787: ' project-a-4-1-chung'
410+
line 788: ' project-a-4-2-chung'
411+
line 789: ' project-a-4-3-chung'
412+
line 790: ' project-a-5-1-chung'
413+
line 791: ' project-a-5-2-chung'
414+
line 792: ''
415+
line 793: ' creator-from-casey-louise'
416+
line 794: ' project-a-1-1-casey-louise'
417+
line 751: ' project-a-3-2-qianqian'
418+
line 752: ' project-a-4-1-qianqian'
419+
line 753: ' project-a-4-2-qianqian'
420+
line 795: ' project-a-1-2-casey-louise'
421+
line 796: ' project-a-1-3-casey-louise'
422+
line 797: ' project-a-1-4-casey-louise'
423+
line 798: ' project-a-1-5-casey-louise'
424+
line 799: ' project-a-2-1-casey-louise'
425+
line 800: ' project-a-2-2-casey-louise'
426+
line 801: ' project-a-3-1-casey-louise'
427+
line 802: ' project-a-3-2-casey-louise'
428+
line 803: ' project-a-3-3-casey-louise'
429+
line 804: ' project-a-3-4-casey-louise'
430+
line 805: ' project-a-3-5-casey-louise'
431+
line 806: ' project-a-4-1-casey-louise'
432+
line 807: ' project-a-4-2-casey-louise'
433+
line 808: ' project-a-4-3-casey-louise'
434+
line 809: ' project-a-4-4-casey-louise'
435+
line 810: ' project-a-4-5-casey-louise'
436+
line 811: ' project-a-4-6-casey-louise'
437+
line 812: ' project-a-4-7-casey-louise'
438+
line 813: ' project-a-5-1-casey-louise'
439+
line 814: ' project-a-5-2-casey-louise'
440+
line 815: ''
441+
line 816: ' pronouns-nonbinary'
442+
line 817: ' creator-from-moon'
443+
line 818: ' posters-by'
444+
line 819: ' project-a-1-1-moon'
445+
line 820: ' project-a-1-2-moon'
446+
line 821: ' project-a-1-3-moon'
447+
line 822: ' project-a-1-4-moon'
448+
line 823: ' project-a-1-5-moon'
449+
line 824: ' project-a-2-1-moon'
450+
line 825: ' project-a-2-2-moon'
451+
line 826: ' project-a-2-3-moon'
452+
line 827: ' project-a-3-1-moon'
453+
line 828: ' project-a-3-2-moon'
454+
line 829: ' project-a-3-3-moon'
455+
line 830: ' project-a-3-4-moon'
456+
line 831: ' project-a-4-1-moon'
457+
line 832: ' project-a-5-1-moon'
458+
line 833: ' project-a-5-2-moon'
174459
line 481: ' notes1'
175460
line 482: ' notes2'
176461
line 483: ' notes3'
@@ -179,10 +464,6 @@ es:
179464
line 608: ' book-1-authors'
180465
line 617: ' book-2-authors'
181466
line 409: ' p5.bots'
182-
line 656: ' Image_Processing'
183-
zh-Hans:
184-
src/data/en.yml:
185-
line 480: ' notes3'
186467
line 44: ' description-roni'
187468
line 45: ' project-phuong'
188469
line 17: Showcase
@@ -280,12 +561,44 @@ zh-Hans:
280561
line 551: ' credit-moon-xin'
281562
line 552: ' description-moon-xin'
282563
line 669: ' credit-moon-xin'
283-
line 481: ' notes1'
284-
line 482: ' notes2'
285-
line 483: ' notes3'
286-
line 484: ' notes4'
287-
line 485: ' notes5'
288-
line 608: ' book-1-authors'
289-
line 617: ' book-2-authors'
290-
line 409: ' p5.bots'
291-
line 656: ' Image_Processing'
564+
line 672: ' created-by'
565+
line 673: ' pronouns-female'
566+
line 674: ' creator-from-roni-cantor'
567+
line 675: ' project-links'
568+
line 676: ' project-links-text-1-roni-cantor'
569+
line 677: ' project-links-text-2-roni-cantor'
570+
line 678: ' project-q-1-1'
571+
line 679: ' project-q-1-2'
572+
line 680: ' project-a-1-1-roni-cantor'
573+
line 681: ' project-a-1-2-roni-cantor'
574+
line 682: ' project-a-1-3-roni-cantor'
575+
line 683: ' project-a-1-4-roni-cantor'
576+
line 684: ' project-q-2'
577+
line 685: ' project-a-2-1-roni-cantor'
578+
line 686: ' project-a-2-2-roni-cantor'
579+
line 687: ' project-a-2-3-roni-cantor'
580+
line 688: ' project-a-2-4-roni-cantor'
581+
line 689: ' project-a-2-5-roni-cantor'
582+
line 690: ' project-q-3'
583+
line 691: ' project-a-3-roni-cantor'
584+
line 692: ' project-q-4'
585+
line 693: ' project-a-4-roni-cantor'
586+
line 694: ' project-q-5'
587+
line 695: ' project-a-5-roni-cantor'
588+
line 696: ' project-q-6'
589+
line 697: ' project-a-6-roni-cantor'
590+
line 698: ''
591+
line 699: ' project-resources'
592+
line 700: ' creator-from-qianqian'
593+
line 701: ' project-a-1-1-qianqian'
594+
line 702: ' project-a-1-2-qianqian'
595+
line 703: ' project-a-2-1-qianqian'
596+
line 704: ' project-a-2-2-qianqian'
597+
line 705: ' project-a-2-3-qianqian'
598+
line 706: ' project-a-2-4-qianqian'
599+
line 707: ' project-a-3-1-qianqian'
600+
line 708: ' project-a-3-2-qianqian'
601+
line 709: ' project-a-4-1-qianqian'
602+
line 710: ' project-a-4-2-qianqian'
603+
line 711: ' project-a-4-3-qianqian'
604+
line 712: ' project-a-5-1-qianqian'

‎offline-reference/extra/js/reference.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4595,7 +4595,7 @@ define('router',[
45954595
get: function(searchClass, searchItem) {
45964596

45974597
// if looking for a library page, redirect
4598-
if (searchClass === 'p5.sound')
4598+
if (searchClass === 'p5.sound'
45994599
&& !searchItem) {
46004600
window.location.hash = '/libraries/'+searchClass;
46014601
return;
@@ -4811,4 +4811,4 @@ require([
48114811
});
48124812

48134813
define("main", function(){});
4814-
}());
4814+
}());

0 commit comments

Comments
 (0)