Line 9: |
Line 9: |
| | | |
| ROOT/ ( ROOT is not actually a directory name, it just labels the top-level of this package ) | | ROOT/ ( ROOT is not actually a directory name, it just labels the top-level of this package ) |
− | assets/ ( images, sounds, and text common to karma.html, examples, and the lessons ) | + | assets/ ( images, audio, and text common to karma.html, examples, and the lessons for the launch page for all lessons ) |
− | images/ | + | image/ |
− | sounds/ | + | audio/ |
| locale_name/ | | locale_name/ |
− | images/ | + | image/ |
| locale_name.json ( karma actually needs the .po file to be converted to .json ) | | locale_name.json ( karma actually needs the .po file to be converted to .json ) |
− | sounds/ | + | audio/ |
| AUTHORS ( Should include names of everyone that has contributed to Karma main package ) | | AUTHORS ( Should include names of everyone that has contributed to Karma main package ) |
− | bin/
| + | css/ ( css/ and js/ contain the code common to all examples, lessons ) |
− |
| |
− | css/ ( css/ and js/ contain the code common to all examples, lessons, and karma.html ) | |
| COPYING ( Licensing information, should default to MIT License ? how distinguish b/w code licensing and content licensing ) | | COPYING ( Licensing information, should default to MIT License ? how distinguish b/w code licensing and content licensing ) |
| docs/ | | docs/ |
Line 25: |
Line 23: |
| index.html ( The starting page for accessing Karma lessons, should include links to the examples, known as the CHAKRA ) | | index.html ( The starting page for accessing Karma lessons, should include links to the examples, known as the CHAKRA ) |
| js/ ( css/ and js/ contain the code common to all examples, lessons, and karma.html ) | | js/ ( css/ and js/ contain the code common to all examples, lessons, and karma.html ) |
− | lessons/ ( this is the workspace for creating new Karma lessons )
| |
− | package.json describes this package as a [http://narwhaljs.org/packages-howto.html commonjs package]
| |
− | po/ Store
| |
| README | | README |
− | tests/ unit tests | + | tests/ unit tests |
| | | |
| == Karma XO bundle == | | == Karma XO bundle == |
Line 37: |
Line 32: |
| | | |
| The '''Below information is out-of-date''' | | The '''Below information is out-of-date''' |
− | | + | <strike> |
| activity/ | | activity/ |
| activity.info (activity info file) | | activity.info (activity info file) |
Line 83: |
Line 78: |
| utils/ | | utils/ |
| webtoolbar.py | | webtoolbar.py |
− | | + | </strike> |
| == Lesson == | | == Lesson == |
| | | |
Line 91: |
Line 86: |
| assets/ | | assets/ |
| {langCode}/ (files specific to langCode: en-US, en, es-MX, es, ....) and not the default locale | | {langCode}/ (files specific to langCode: en-US, en, es-MX, es, ....) and not the default locale |
− | images/ | + | image/ |
− | sounds/ | + | audio/ |
− | svgs/ | + | svg/ |
− | videos/ | + | video/ |
| | | |
| css/ | | css/ |
− | docs/
| + | lesson.css |
− | activity text
| + | index.html |
− | lesson plan
| |
− | teachers note
| |
− | index.html | |
| js/ | | js/ |
| lesson.js main logic of program | | lesson.js main logic of program |
− | | + | kDoc.html (viewer for lesson plan and teacher's Note) |
− | tests/ unit tests if u have them | + | lessonPlan.html |
− | assets/
| + | teachersNote.html |
− | index.html
| + | start.html (start page) |
− | js/
| + | |
− | | |
| | | |
| *Notes: | | *Notes: |
| # {langCode} represents the lang code and country code | | # {langCode} represents the lang code and country code |
− | # which will be the template language for aseets/docs/* ?, English suggested | + | # which will be the template language for assets/docs/* ?, English suggested |
| # suggestion: rename assets/{langCode}/docs/ to docs/{langCode}/ . This is based that at this moment there are no other kind of files under assets/ than 'docs' | | # suggestion: rename assets/{langCode}/docs/ to docs/{langCode}/ . This is based that at this moment there are no other kind of files under assets/ than 'docs' |
| | | |
| + | The following is out of date but kept for history |
| <strike> | | <strike> |
| + | |
| == Reading, Game and Exercise == | | == Reading, Game and Exercise == |
| ''consist of a single 'reading', 'game' or 'exercise' '' | | ''consist of a single 'reading', 'game' or 'exercise' '' |