Karma/Bundle layout: Difference between revisions

Line 83:

utils/

webtoolbar.py

~~== Karma lesson bundle ==~~

~~''consists of multiple lesson in a single bundle''~~

* common jquery and css files in a single folder

* The '''karma''' utility script can be used to generate a lesson bundle with accompanying main menu and ''search'' (probably some sort of sitemap)

~~bundle_name/~~

~~assets/~~

~~default/ ( default as in the default locale)~~

~~docs/~~

~~images/~~

~~sounds/~~

~~default.po~~

~~en-US/~~

~~docs/~~

~~images/~~

~~sounds/~~

~~default.po~~

~~chakra/ ( for all sub-pages of the chakra, e.g. grade1.html )~~

~~css/ ( common css files (e.g. jquery.jgrowl.css and menu.css ) )~~

~~index.html ( Common gateway to access the lessons in the bundle known as the Chakra)~~

~~js/ ( common javascript / jquery files )~~

~~lessons/ ( directory for all the lessons )~~

~~lesson_name1/~~

~~lesson_name2/~~

== Lesson ==

Line 116:

Line 89:

lesson_name/

~~index.html ( lesson menu with iFrame for reading.html, css and js are common files, they are inside../css/ and ../js/ respectively)~~

~~tutorial/ ( contains files related to the tutorial )~~

~~game/ ( contains files related to the game )~~

~~exercise/ ( contains files related to the exercise )~~

assets/

{langCode}/ (files specific to langCode: en-US, en, es-MX, es, ....)

{langCode}/ (files specific to langCode: en-US, en, es-MX, es, ....) and not the default locale

docs/

images/

activity text

sounds/

lesson plan

svgs/

teachers note

videos/

css/

docs/

activity text

lesson plan

teachers note

index.html

js/

lesson.js main logic of program

tests/ unit tests if u have them

assets/

index.html

js/

*Notes:

Line 132:

Line 116:

# 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'

== Reading, Game and Exercise ==

''consist of a single 'reading', 'game' or 'exercise' ''

Line 168:

Line 153:

# {type} represents 'game' or 'exercise' or 'reading'

# does docs/ is used?

</stike>

@@ Line 83: / Line 83: @@
    utils/
    webtoolbar.py
-== Karma lesson bundle ==
-''consists of multiple lesson in a single bundle''
-* common jquery and css files in a single folder
-* The '''karma''' utility script can be used to generate a lesson bundle with accompanying main menu and ''search'' (probably some sort of sitemap)
-  bundle_name/
-              assets/
-                      default/              ( default as in the default locale)
-                              docs/
-                              images/
-                              sounds/
-                              default.po
-                      en-US/
-                              docs/
-                              images/
-                              sounds/
-                              default.po
-              chakra/                  ( for all sub-pages of the chakra, e.g. grade1.html )
-              css/                     ( common css files (e.g. jquery.jgrowl.css and menu.css ) )
-              index.html          ( Common gateway to access the lessons in the bundle known as the Chakra)
-              js/                      ( common javascript / jquery files )
-              lessons/                 ( directory for all the lessons )
-                     lesson_name1/
-                     lesson_name2/
 == Lesson ==
@@ Line 116: / Line 89: @@
     lesson_name/
-              index.html               ( lesson menu with iFrame for reading.html, css and js are common files, they are inside../css/ and ../js/ respectively)
-              tutorial/                 ( contains files related to the tutorial )
-              game/                    ( contains files related to the game )
-              exercise/                ( contains files related to the exercise )
                assets/
-                   {langCode}/         (files specific to langCode: en-US, en, es-MX, es, ....)
+                      {langCode}/         (files specific to langCode: en-US, en, es-MX, es, ....) and not the default locale
-                           docs/
+                      images/
-                               activity text
+                      sounds/
-                               lesson plan
+                      svgs/
-                               teachers note
+                      videos/
+              css/
+              docs/
+                      activity text
+                      lesson plan
+                      teachers note
+              index.html
+              js/
+                  lesson.js      main logic of program
+              tests/             unit tests if u have them
+                    assets/
+                    index.html
+                    js/
 *Notes:
@@ Line 132: / Line 116: @@
 # 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'
+<strike>
 == Reading, Game and Exercise ==
 ''consist of a single 'reading', 'game' or 'exercise' ''
@@ Line 168: / Line 153: @@
 # {type} represents 'game' or 'exercise' or 'reading'
 # does docs/ is used?
+</stike>