Sugar Labs

Karma/Bundle layout: Difference between revisions

← Older edit
BryanWB (talk | contribs)
359 edits
BryanWB (talk | contribs)
359 edits
 
(8 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, 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>
== 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 ==
== Lesson ==


Line 116: Line 84:


   lesson_name/
   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/
               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/
                      image/
                              activity text
                      audio/
                              lesson plan
                      svg/
                              teachers note     
                      video/
             
              css/
                    lesson.css
              index.html           
              js/
                  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 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>


== Reading, Game and Exercise ==
== Reading, Game and Exercise ==
Line 168: Line 146:
# {type} represents 'game' or 'exercise' or 'reading'
# {type} represents 'game' or 'exercise' or 'reading'
# does docs/ is used?
# does docs/ is used?
</stike>
Retrieved from "https://wiki.sugarlabs.org/go/Karma/Bundle_layout"