Karma/Bundle layout: Difference between revisions
No edit summary |
|||
| (7 intermediate revisions by the same user not shown) | |||
| 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, | assets/ ( images, audio, and text common to karma.html, examples, and the lessons for the launch page for all lessons ) | ||
image/ | |||
audio/ | |||
locale_name/ | locale_name/ | ||
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 ) | ||
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 ) | ||
css/ ( css/ and js/ contain the code common to all examples, lessons ) | |||
css/ | |||
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 ) | ||
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 | ||
image/ | |||
audio/ | |||
svg/ | |||
video/ | |||
css/ | css/ | ||
lesson.css | |||
index.html | |||
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) | |||
lessonPlan.html | |||
teachersNote.html | |||
start.html (start page) | |||
*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 | # 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' '' | ||