Karma/Bundle layout: Difference between revisions

Line 118:

''consists of a single lesson''

lesson_name/

index.html ( lesson menu with iFrame for ~~lesson.html )~~

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

reading.html ~~( valid html5 -- markup only includes visual elements~~ and ~~links in other resources~~, ~~no inline code or styling~~ )

reading/ ( contains files related to the reading )

~~exercise.html~~ ( ~~=||=~~ )

game/ ( contains files related to the game )

game~~.html~~ ( ~~=||=~~ )

exercise/ ( contains files related to the exercise )

~~css~~/~~reading.css~~ ( ~~css~~ files ~~-- specific~~ to the ~~lesson~~ )

assets/

~~css~~/~~exercise.css~~ ( ~~css~~ files -- ~~specific~~ to ~~the~~ exercise )

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

css/~~game~~.css ( css files -- specific to the ~~game~~ )

docs/

js/~~reading~~.js ( javascript controlling logic for the lesson )

activity text

~~js/exercise.js ( javascript controlling logic for the exercise )~~

lesson plan

~~js/game.js ( javascript controlling logic for the game )~~

teachers note

*Notes:

# {langCode} represents the lang code and country code

# which will be the template language for aseets/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'

== Reading, Game and Exercise ==

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

{type}/

index.html (valid html5 -- markup only includes visual elements and links in other resources, no inline code or styling )

css/{type}.css ( css files -- specific to the lesson )

js/{type}.js ( javascript controlling logic for the lesson )

po/ ( translation files )

ne-NP.po # example translation file for Nepal - Nepali

ne-NP.po ( example translation file for Nepal - Nepali )

sp-ES.po # example translation file for traditional Spanish

sp-ES.po ( example translation file for traditional Spanish )

{langCode}.po ( translation file )

assets/

generic/ # for language independent assets (e.g. arrows, background images, etc.)

generic/ ( for language independent assets (e.g. arrows, background images, etc.) )

images/

~~reading/~~

preview.jpg ( screenshot for Chakra )

~~exercise/~~

~~game/~~

preview.jpg # screenshot for Chakra

sounds/

videos/

Line 147:

Line 157:

videos/

docs/

~~activity text~~

~~lesson plan~~

~~teachers note~~

en/

images/

Line 155:

Line 162:

videos/

docs/

{langCode}/

images/

sounds/

videos/

docs/

* Notes

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

# does docs/ is used?

@@ Line 118: / Line 118: @@
 ''consists of a single lesson''
-  lesson_name/
+   lesson_name/
-               index.html               ( lesson menu with iFrame for lesson.html )
+               index.html               ( lesson menu with iFrame for reading.html, css and js are common files, they are inside../css/ and ../js/ respectively)
-              reading.html              ( valid html5 -- markup only includes visual elements and links in other resources, no inline code or styling )
+               reading/                 ( contains files related to the reading )
-               exercise.html            ( =||= )
+               game/                    ( contains files related to the game )
-               game.html                ( =||= )
+               exercise/                ( contains files related to the exercise )
-               css/reading.css           ( css files   -- specific to the lesson )
+               assets/
-               css/exercise.css         ( css files   -- specific to the exercise )
+                   {langCode}/         (files specific to langCode: en-US, en, es-MX, es, ....)
-               css/game.css             ( css files   -- specific to the game )
+                           docs/
-               js/reading.js             ( javascript controlling logic for the lesson )
+                               activity text
-              js/exercise.js           ( javascript controlling logic for the exercise )
+                               lesson plan
-              js/game.js               ( javascript controlling logic for the game )
+                               teachers note
+*Notes:
+# {langCode} represents the lang code and country code
+# which will be the template language for aseets/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'
+== Reading, Game and Exercise ==
+''consist of a single 'reading', 'game' or 'exercise' ''
+ {type}/
+              index.html               (valid html5 -- markup only includes visual elements and links in other resources, no inline code or styling )
+               css/{type}.css           ( css files   -- specific to the lesson )
+               js/{type}.js             ( javascript controlling logic for the lesson )
                po/                      ( translation files )
-                   ne-NP.po             # example translation file for Nepal - Nepali
+                   ne-NP.po             ( example translation file for Nepal - Nepali )
-                   sp-ES.po             # example translation file for traditional Spanish
+                   sp-ES.po             ( example translation file for traditional Spanish )
+                  {langCode}.po        ( translation file )
                assets/
-                      generic/          # for language independent assets (e.g. arrows, background images, etc.)
+                      generic/          ( for language independent assets (e.g. arrows, background images, etc.) )
                          images/
-                           reading/
+                             preview.jpg  ( screenshot for Chakra  )
-                           exercise/
-                           game/
-                             preview.jpg # screenshot for Chakra
                          sounds/
                          videos/
@@ Line 147: / Line 157: @@
                          videos/
                          docs/
-                             activity text
-                             lesson plan
-                             teachers note
                       en/
                          images/
@@ Line 155: / Line 162: @@
                          videos/
                          docs/
+                     {langCode}/
+                        images/
+                        sounds/
+                        videos/
+                        docs/
+* Notes
+# {type} represents 'game' or 'exercise' or 'reading'
+# does docs/ is used?