You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Note: if you make edits here you must restart the server to see your changes. To see changes immediately, you can edit the assets files in the dist directory, but need to copy and paste your updated work here for it to be saved.
25
-
*`data` – translation files
26
-
*`templates`
27
-
*`layouts` – default.hbs is main page template
28
-
*`pages` – Contains each of the pages of the p5 site, these get inserted in `{{> body }}` tag of default layout.
29
-
*`partials` – These are reusable pieces that can get added to any page or layout, they correspond to other `{{> filename }}` tags in the pages or default layout.
30
-
*`dist` – Where the rendered files are stored, this can be placed directly online.
25
+
*`data/` – translation files
26
+
*`templates/`
27
+
*`layouts/` – default.hbs is main page template
28
+
*`pages/` – Contains each of the pages of the p5 site, these get inserted in `{{> body }}` tag of default layout.
29
+
*`partials/` – These are reusable pieces that can get added to any page or layout, they correspond to other `{{> filename }}` tags in the pages or default layout.
30
+
*`dist/` – Where the rendered files are stored, this can be placed directly online.
31
31
*`Gruntfile.js` – This file contains all the tasks for using assemble and YAML to generate the final, static site. It uses the taskrunner [grunt](http://gruntjs.com/).
32
32
33
33
## Internationalization (i18n) and structure
34
34
35
-
### When adding a new language:
36
-
37
-
1. Duplicate `[en.yml]`(https://github.com/processing/p5.js-website/blob/master/src/data/en.yml) in `src/data` and name it `{languageabbreviation}.yml`. For example `es.yml`. See this page for [two-letter language abbreviations](https://www.abbreviations.com/acronyms/LANGUAGES2L).
38
-
2. Duplicate `[es.json]`(https://github.com/processing/p5.js-website/blob/master/src/data/reference/es.json) and name it `{languageabbreviation}.json`.
39
-
3. Add an entry with the language abbreviation [here](https://github.com/processing/p5.js-website/blob/master/Gruntfile.js#L90).
40
-
41
-
### YAML (non-reference page translation)
35
+
### Translation for all pages except Reference (YML)
42
36
43
37
* Each website page uses handlebars to access the i18n data and render. The .yml files in the `src/data` folder hold the i18n data for each language. Within the pages there are tags that look like this: `{{#i18n "MyKeyword"}}{{/i18n}}`
44
38
* MyKeyword corresponds to the key-value pair for the translation of that word or phrase. There should be a MyKeyword entry in every language file for things to render correctly.
45
39
* Each page contains YAML "front matter" at the top which includes a title and (optional) slug field. The title corresponds to the section in which to place the i18n key-value pairs. (Note: each page has only one title, so for partials within the `partials` folder, place the i18n pairs at the top level.)
46
40
* The slug corresponds to the folder in which the page will be placed. This should generally match the folder structure within the `pages` folder.
47
-
* For english version, the site will follow the same top-level hierarchy as the original site. When you switch to a different language, the permalink and file structure will include a two letter abbreviation immediately following the root url. (ex: `https://p5js.org/es/get-started/`)
48
-
49
-
### JSON (reference)
41
+
* For English version, the site will follow the same top-level hierarchy as the original site. When you switch to a different language, the permalink and file structure will include the language abbreviation immediately following the root url. (ex: `https://p5js.org/es/get-started/`)
42
+
43
+
### Translation for Reference (JSON)
50
44
51
45
* 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](https://github.com/processing/p5.js-website/blob/master/dist/reference/index.html#L130).
52
46
* 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/dist/reference/index.html#L130).
53
47
* The "p5" key in the JSON object contains individual keys for each reference entry, indexed by variable/function/object name.
54
48
* Any entries in the JSON object which are not filled in will be left in English when the page is loaded.
55
49
* 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.
56
-
57
-
### Introducción a p5.js
58
-
The repository for the book and PDF production of Introducción a p5.js can be found [here](https://github.com/processing/p5.js-getting-started-es).
59
-
60
-
## Updating the reference
50
+
* 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/developer_docs/inline_documentation.md) in the p5.js repo for information on how to contribute.
61
51
62
-
The documentation for p5.js is handled inline in the source code. See [Inline documentation](https://github.com/processing/p5.js/blob/master/developer_docs/inline_documentation.md) in the p5.js repo for information on how to contribute.
63
-
64
-
## Notes about Examples
52
+
## Notes about translating Examples
65
53
66
54
The examples are handled a bit differently from other pages.
67
-
68
55
* All examples pages are built from `src/data/examples`.
69
-
* Within the examples folder, there is a folder for each of the three languages we currently support: 'en/', 'es/', and 'zh-Hans/'. When adding a new example, first add an English version of the file to the `en/` folder, then make sure it is duplicated in the same place in all other languages, then translate for whichever languages you can. If you have created a new folder, add entries to the YAML files with the foldername as the key.
56
+
* Within the examples folder, there is a folder for each of the three languages we currently support: `en/`, `es/`, and `zh-Hans/`. When adding a new example, first add an English version of the file to the `en/` folder, then make sure it is duplicated in the same place in all other languages, then translate for whichever languages you can. If you have created a new folder, add entries to the YAML files with the foldername as the key.
70
57
* The folder, file, and numbering structure should match exactly between the different languages. Do not change the filenames. The text for the example name, description, and source code are all in the .js files in the folders.
71
58
* Assets for the examples are placed in `src/data/examples/assets`.
72
59
* Translations for the topic headers on the example index page are done in the YAML files (`src/data/*.yml`).
73
60
74
-
## Documentation
61
+
### Adding a new language
62
+
63
+
1. Duplicate `[en.yml]`(https://github.com/processing/p5.js-website/blob/master/src/data/en.yml) in `src/data` and name it `{languageabbreviation}.yml`. For example `es.yml`. See this page for [two-letter language abbreviations](https://www.abbreviations.com/acronyms/LANGUAGES2L).
64
+
2. Duplicate `[es.json]`(https://github.com/processing/p5.js-website/blob/master/src/data/reference/es.json) and name it `{languageabbreviation}.json`.
65
+
3. Add an entry with the language abbreviation [here](https://github.com/processing/p5.js-website/blob/master/Gruntfile.js#L90).
66
+
67
+
68
+
## Tools
75
69
76
70
*[Assemble](http://assemble.io/) is used to build a static site out of all the layouts and yml data.
77
71
*[grunt-assemble-i18n](https://github.com/assemble/grunt-assemble-i18n) renders a set of pages for each language specified in the gruntfile, based on the handlebars templates and yml data. There is not a lot of documentation, but this [example](https://github.com/LaurentGoderre/i18n-demo) demonstrates the functionality well.
78
72
*[assemble-contrib-permalinks](https://github.com/assemble/assemble-permalinks) allows us to customize the permalinks (file structure of the rendered static site).
79
73
80
-
## Etc
74
+
## Add yourself to contributors!
75
+
76
+
If you've contributed to this website (or any other part of the p5.js project), add yourself [here](https://github.com/processing/p5.js#contributors). Instructions to do this can be found at the bottom of the section.
81
77
82
-
* If you are using sublime text, this plugin is useful for rendering hbs files with syntax highlighting: https://github.com/jonschlinkert/sublime-markdown-extended
78
+
79
+
## Etc
80
+
* Introducción a p5.js - The repository for the book and PDF production of Introducción a p5.js can be found [here](https://github.com/processing/p5.js-getting-started-es).
0 commit comments