Skip to content

Commit 21405de

Browse files
Rahulm2310Rahulm2310
authored
Merge branch 'master' into p5domlinkfix
2 parents 285f899 + fe4da8e commit 21405de

File tree

157 files changed

+3507
-1872
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

157 files changed

+3507
-1872
lines changed

‎Gruntfile.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ module.exports = function(grunt) {
8383
options: {
8484
expand: true,
8585
flatten: true,
86-
helpers: ['<%= config.src %>/assets/js/translation.js'],
8786
assets: '<%= config.dist %>/assets',
87+
helpers: ['<%= config.src %>/assets/js/translation.js', '<%= config.src %>/assets/js/cache-busting.js'],
8888
layout: '<%= config.src %>/templates/layouts/default.hbs',
8989
data: [
9090
'<%= config.src %>/data/**/*.{json,yml}',
@@ -408,10 +408,11 @@ module.exports = function(grunt) {
408408
'update-version',
409409
'exec',
410410
'clean',
411+
'requirejs:yuidoc_theme',
411412
'requirejs',
412413
'copy',
413-
'assemble',
414414
'optimize',
415+
'assemble',
415416
'file_append',
416417
'compress',
417418
'i18n',

‎contributor_docs/i18n_contribution.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,8 @@ p5.js-website/
136136
```
137137
4. Duplicate `en.yml` - stored under `src/data/` - and name it `language_abbreviation.yml`. For example, when the Spanish version was created it was named `es.yml`. Check [How the website works](#how-the-website-works) and [File Structure](#file-structure) for further information.
138138
5. Duplicate `es.json` - stored under `src/data/reference/` - and name it `[language_abbreviation].json`.
139-
6. Add a new menu entry in [`src/templates/partials/i18n.hbs`](https://github.com/processing/p5.js-website/blob/master/src/templates/partials/i18n.hbs#L8) like so `<li><a href='#' lang='[language_abbreviation]' data-lang='[language_abbreviation]'>[language_name]</a></li>`.
139+
6. Duplicate `en` folder - stored under `src/data/examples` - and name it `language_abbreviation`.
140+
7. Add a new menu entry in [`src/templates/partials/i18n.hbs`](https://github.com/processing/p5.js-website/blob/master/src/templates/partials/i18n.hbs#L8) like so `<li><a href='#' lang='[language_abbreviation]' data-lang='[language_abbreviation]'>[language_name]</a></li>`.
140141
141142
## Working on existing translations
142143
@@ -197,10 +198,13 @@ In some cases, the text translated from the original .hbs file (written in HTML)
197198

198199
### Translation of Reference
199200

200-
* 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)).
201204
* 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).
202205
* The "p5" key in the JSON object contains individual keys for each reference entry, indexed by variable/function/object name.
203206
* 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.
204208
* 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.
205209
* 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.
206210

‎i18n-tracking.yml

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
es:
22
src/data/en.yml:
3+
line 720: ' project-a-1-3-phuong'
4+
line 721: ' project-a-1-4-phuong'
5+
line 727: ' project-a-2-5-phuong'
6+
line 730: ' project-a-2-7-phuong'
7+
line 480: ' notes3'
38
line 44: ' description-roni'
49
line 45: ' project-phuong'
510
line 17: Showcase
@@ -170,8 +175,136 @@ es:
170175
line 551: ' credit-moon-xin'
171176
line 552: ' description-moon-xin'
172177
line 669: ' credit-moon-xin'
178+
line 672: ' created-by'
179+
line 673: ' pronouns-female'
180+
line 674: ' creator-from-roni-cantor'
181+
line 675: ' project-links'
182+
line 676: ' project-links-text-1-roni-cantor'
183+
line 677: ' project-links-text-2-roni-cantor'
184+
line 678: ' project-q-1-1'
185+
line 679: ' project-q-1-2'
186+
line 680: ' project-a-1-1-roni-cantor'
187+
line 681: ' project-a-1-2-roni-cantor'
188+
line 682: ' project-a-1-3-roni-cantor'
189+
line 683: ' project-a-1-4-roni-cantor'
190+
line 684: ' project-q-2'
191+
line 685: ' project-a-2-1-roni-cantor'
192+
line 686: ' project-a-2-2-roni-cantor'
193+
line 687: ' project-a-2-3-roni-cantor'
194+
line 688: ' project-a-2-4-roni-cantor'
195+
line 689: ' project-a-2-5-roni-cantor'
196+
line 690: ' project-q-3'
197+
line 691: ' project-a-3-roni-cantor'
198+
line 692: ' project-q-4'
199+
line 693: ' project-a-4-roni-cantor'
200+
line 694: ' project-q-5'
201+
line 695: ' project-a-5-roni-cantor'
202+
line 696: ' project-q-6'
203+
line 697: ' project-a-6-roni-cantor'
204+
line 698: ''
205+
line 699: ' project-resources'
206+
line 700: ' creator-from-qianqian'
207+
line 701: ' project-a-1-1-qianqian'
208+
line 702: ' project-a-1-2-qianqian'
209+
line 703: ' project-a-2-1-qianqian'
210+
line 704: ' project-a-2-2-qianqian'
211+
line 705: ' project-a-2-3-qianqian'
212+
line 706: ' project-a-2-4-qianqian'
213+
line 707: ' project-a-3-1-qianqian'
214+
line 708: ' project-a-3-2-qianqian'
215+
line 709: ' project-a-4-1-qianqian'
216+
line 710: ' project-a-4-2-qianqian'
217+
line 711: ' project-a-4-3-qianqian'
218+
line 712: ' project-a-5-1-qianqian'
219+
line 713: ' project-a-5-2-qianqian'
220+
line 714: ''
221+
line 715: ' creator-from-phuong'
222+
line 716: ' project-a-1-1-phuong'
223+
line 717: ' project-a-1-2-phuong'
224+
line 718: ' project-a-1-3-phuong'
225+
line 719: ' project-a-1-4-phuong'
226+
line 722: ' project-a-2-3-phuong'
227+
line 723: ' project-a-2-4-phuong'
228+
line 724: ' project-a-2-5-phuong'
229+
line 725: ' project-a-2-6-phuong'
230+
line 726: ' project-a-2-7-phuong'
231+
line 728: ' project-a-3-2-phuong'
232+
line 729: ' project-a-3-3-phuong'
233+
line 731: ' project-a-4-1-phuong'
234+
line 732: ' project-a-5-1-phuong'
235+
line 733: ' project-a-5-2-phuong'
236+
line 734: ''
237+
line 735: ' pronouns-male'
238+
line 736: ''
239+
line 737: ' pronouns-nonbinary'
240+
line 738: ' creator-from-chung'
241+
line 739: ' project-a-1-1-chung'
242+
line 740: ' project-a-1-2-chung'
243+
line 741: ' project-a-1-3-chung'
244+
line 742: ' project-a-2-1-chung'
245+
line 743: ' project-a-2-2-chung'
246+
line 744: ' project-a-3-1-chung'
247+
line 745: ' project-a-3-2-chung'
248+
line 746: ' project-a-4-1-chung'
249+
line 747: ' project-a-4-2-chung'
250+
line 748: ' project-a-4-3-chung'
251+
line 749: ' project-a-5-1-chung'
252+
line 750: ' project-a-5-2-chung'
253+
line 754: ' creator-from-casey-louise'
254+
line 755: ' project-a-1-1-casey-louise'
255+
line 756: ' project-a-1-2-casey-louise'
256+
line 757: ' project-a-1-3-casey-louise'
257+
line 758: ' project-a-1-4-casey-louise'
258+
line 759: ' project-a-1-5-casey-louise'
259+
line 760: ' project-a-2-1-casey-louise'
260+
line 761: ' project-a-2-2-casey-louise'
261+
line 762: ' project-a-3-1-casey-louise'
262+
line 763: ' project-a-3-2-casey-louise'
263+
line 764: ' project-a-3-3-casey-louise'
264+
line 765: ' project-a-3-4-casey-louise'
265+
line 766: ' project-a-3-5-casey-louise'
266+
line 767: ' project-a-4-1-casey-louise'
267+
line 768: ' project-a-4-2-casey-louise'
268+
line 769: ' project-a-4-3-casey-louise'
269+
line 770: ' project-a-4-4-casey-louise'
270+
line 771: ' project-a-4-5-casey-louise'
271+
line 772: ' project-a-4-6-casey-louise'
272+
line 773: ' project-a-4-7-casey-louise'
273+
line 774: ' project-a-5-1-casey-louise'
274+
line 775: ' project-a-5-2-casey-louise'
275+
line 776: ''
276+
line 777: ' pronouns-nonbinary'
277+
line 778: ' creator-from-moon'
278+
line 779: ' posters-by'
279+
line 780: ' project-a-1-1-moon'
280+
line 781: ' project-a-1-2-moon'
281+
line 782: ' project-a-1-3-moon'
282+
line 783: ' project-a-1-4-moon'
283+
line 784: ' project-a-1-5-moon'
284+
line 785: ' project-a-2-1-moon'
285+
line 786: ' project-a-2-2-moon'
286+
line 787: ' project-a-2-3-moon'
287+
line 788: ' project-a-3-1-moon'
288+
line 789: ' project-a-3-2-moon'
289+
line 790: ' project-a-3-3-moon'
290+
line 791: ' project-a-3-4-moon'
291+
line 792: ' project-a-4-1-moon'
292+
line 793: ' project-a-5-1-moon'
293+
line 794: ' project-a-5-2-moon'
173294
zh-Hans:
174295
src/data/en.yml:
296+
line 720: ' project-a-1-3-phuong'
297+
line 721: ' project-a-1-4-phuong'
298+
line 727: ' project-a-2-5-phuong'
299+
line 730: ' project-a-2-7-phuong'
300+
line 481: ' notes1'
301+
line 482: ' notes2'
302+
line 483: ' notes3'
303+
line 484: ' notes4'
304+
line 485: ' notes5'
305+
line 608: ' book-1-authors'
306+
line 617: ' book-2-authors'
307+
line 409: ' p5.bots'
175308
line 44: ' description-roni'
176309
line 45: ' project-phuong'
177310
line 17: Showcase
@@ -269,3 +402,119 @@ zh-Hans:
269402
line 551: ' credit-moon-xin'
270403
line 552: ' description-moon-xin'
271404
line 669: ' credit-moon-xin'
405+
line 672: ' created-by'
406+
line 673: ' pronouns-female'
407+
line 674: ' creator-from-roni-cantor'
408+
line 675: ' project-links'
409+
line 676: ' project-links-text-1-roni-cantor'
410+
line 677: ' project-links-text-2-roni-cantor'
411+
line 678: ' project-q-1-1'
412+
line 679: ' project-q-1-2'
413+
line 680: ' project-a-1-1-roni-cantor'
414+
line 681: ' project-a-1-2-roni-cantor'
415+
line 682: ' project-a-1-3-roni-cantor'
416+
line 683: ' project-a-1-4-roni-cantor'
417+
line 684: ' project-q-2'
418+
line 685: ' project-a-2-1-roni-cantor'
419+
line 686: ' project-a-2-2-roni-cantor'
420+
line 687: ' project-a-2-3-roni-cantor'
421+
line 688: ' project-a-2-4-roni-cantor'
422+
line 689: ' project-a-2-5-roni-cantor'
423+
line 690: ' project-q-3'
424+
line 691: ' project-a-3-roni-cantor'
425+
line 692: ' project-q-4'
426+
line 693: ' project-a-4-roni-cantor'
427+
line 694: ' project-q-5'
428+
line 695: ' project-a-5-roni-cantor'
429+
line 696: ' project-q-6'
430+
line 697: ' project-a-6-roni-cantor'
431+
line 698: ''
432+
line 699: ' project-resources'
433+
line 700: ' creator-from-qianqian'
434+
line 701: ' project-a-1-1-qianqian'
435+
line 702: ' project-a-1-2-qianqian'
436+
line 703: ' project-a-2-1-qianqian'
437+
line 704: ' project-a-2-2-qianqian'
438+
line 705: ' project-a-2-3-qianqian'
439+
line 706: ' project-a-2-4-qianqian'
440+
line 707: ' project-a-3-1-qianqian'
441+
line 708: ' project-a-3-2-qianqian'
442+
line 709: ' project-a-4-1-qianqian'
443+
line 710: ' project-a-4-2-qianqian'
444+
line 711: ' project-a-4-3-qianqian'
445+
line 712: ' project-a-5-1-qianqian'
446+
line 713: ' project-a-5-2-qianqian'
447+
line 714: ''
448+
line 715: ' creator-from-phuong'
449+
line 716: ' project-a-1-1-phuong'
450+
line 717: ' project-a-1-2-phuong'
451+
line 718: ' project-a-1-3-phuong'
452+
line 719: ' project-a-1-4-phuong'
453+
line 722: ' project-a-2-3-phuong'
454+
line 723: ' project-a-2-4-phuong'
455+
line 724: ' project-a-2-5-phuong'
456+
line 725: ' project-a-2-6-phuong'
457+
line 726: ' project-a-2-7-phuong'
458+
line 728: ' project-a-3-2-phuong'
459+
line 729: ' project-a-3-3-phuong'
460+
line 731: ' project-a-4-1-phuong'
461+
line 732: ' project-a-5-1-phuong'
462+
line 733: ' project-a-5-2-phuong'
463+
line 734: ''
464+
line 735: ' pronouns-male'
465+
line 736: ''
466+
line 737: ' pronouns-nonbinary'
467+
line 738: ' creator-from-chung'
468+
line 739: ' project-a-1-1-chung'
469+
line 740: ' project-a-1-2-chung'
470+
line 741: ' project-a-1-3-chung'
471+
line 742: ' project-a-2-1-chung'
472+
line 743: ' project-a-2-2-chung'
473+
line 744: ' project-a-3-1-chung'
474+
line 745: ' project-a-3-2-chung'
475+
line 746: ' project-a-4-1-chung'
476+
line 747: ' project-a-4-2-chung'
477+
line 748: ' project-a-4-3-chung'
478+
line 749: ' project-a-5-1-chung'
479+
line 750: ' project-a-5-2-chung'
480+
line 754: ' creator-from-casey-louise'
481+
line 755: ' project-a-1-1-casey-louise'
482+
line 756: ' project-a-1-2-casey-louise'
483+
line 757: ' project-a-1-3-casey-louise'
484+
line 758: ' project-a-1-4-casey-louise'
485+
line 759: ' project-a-1-5-casey-louise'
486+
line 760: ' project-a-2-1-casey-louise'
487+
line 761: ' project-a-2-2-casey-louise'
488+
line 762: ' project-a-3-1-casey-louise'
489+
line 763: ' project-a-3-2-casey-louise'
490+
line 764: ' project-a-3-3-casey-louise'
491+
line 765: ' project-a-3-4-casey-louise'
492+
line 766: ' project-a-3-5-casey-louise'
493+
line 767: ' project-a-4-1-casey-louise'
494+
line 768: ' project-a-4-2-casey-louise'
495+
line 769: ' project-a-4-3-casey-louise'
496+
line 770: ' project-a-4-4-casey-louise'
497+
line 771: ' project-a-4-5-casey-louise'
498+
line 772: ' project-a-4-6-casey-louise'
499+
line 773: ' project-a-4-7-casey-louise'
500+
line 774: ' project-a-5-1-casey-louise'
501+
line 775: ' project-a-5-2-casey-louise'
502+
line 776: ''
503+
line 777: ' pronouns-nonbinary'
504+
line 778: ' creator-from-moon'
505+
line 779: ' posters-by'
506+
line 780: ' project-a-1-1-moon'
507+
line 781: ' project-a-1-2-moon'
508+
line 782: ' project-a-1-3-moon'
509+
line 783: ' project-a-1-4-moon'
510+
line 784: ' project-a-1-5-moon'
511+
line 785: ' project-a-2-1-moon'
512+
line 786: ' project-a-2-2-moon'
513+
line 787: ' project-a-2-3-moon'
514+
line 788: ' project-a-3-1-moon'
515+
line 789: ' project-a-3-2-moon'
516+
line 790: ' project-a-3-3-moon'
517+
line 791: ' project-a-3-4-moon'
518+
line 792: ' project-a-4-1-moon'
519+
line 793: ' project-a-5-1-moon'
520+
line 794: ' project-a-5-2-moon'

‎offline-reference/extra/css/main.css

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@
8989
padding: 0.4em;
9090
margin: 1em 1.75em 0 0;
9191
width: 18.65em;
92+
float: left;
9293
color: #333 !important;
9394
height:7.45em;
9495
position: relative;

‎offline-reference/extra/index.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@
8686

8787
<script src="./js/p5.min.js"></script>
8888
<script src="./js/p5.sound.min.js"></script>
89-
<script src="./js/p5.dom.min.js"></script>
9089
<script src="./js/render.js"></script>
9190
<!-- prism for code highlighting -->
9291
<script src="./js/vendor/prism.js"></script>

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

Lines changed: 2 additions & 11 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.dom' || searchClass === 'p5.sound')
4598+
if (searchClass === 'p5.sound')
45994599
&& !searchItem) {
46004600
window.location.hash = '/libraries/'+searchClass;
46014601
return;
@@ -4743,7 +4743,7 @@ require([
47434743
'./documented-method'], function(App, DocumentedMethod) {
47444744

47454745
// Set collections
4746-
App.collections = ['allItems', 'classes', 'events', 'methods', 'properties', 'p5.sound', 'p5.dom'];
4746+
App.collections = ['allItems', 'classes', 'events', 'methods', 'properties', 'p5.sound'];
47474747

47484748
// Get json API data
47494749
var data = referenceData;
@@ -4767,9 +4767,6 @@ require([
47674767
if (m.name == "p5.sound") {
47684768
App.sound.module = m;
47694769
}
4770-
else if (m.name == "p5.dom") {
4771-
App.dom.module = m;
4772-
}
47734770
});
47744771

47754772

@@ -4803,12 +4800,6 @@ require([
48034800
if (el.module === "p5.sound") {
48044801
App.sound.items.push(el);
48054802
}
4806-
else if (el.module === "p5.dom" || el.module === 'DOM') {
4807-
if (el.class === 'p5.dom') {
4808-
el.class = 'p5';
4809-
}
4810-
App.dom.items.push(el);
4811-
}
48124803
}
48134804
});
48144805

0 commit comments

Comments
 (0)