Karma/Bundle layout - Revision history

BryanWB: /* Lesson */

2010-03-10T04:55:14Z

Lesson

← Older revision		Revision as of 00:55, 10 March 2010
Line 93:		Line 93:
	css/		css/
	lesson.css		lesson.css
	~~docs/~~		index.html
	~~activity text~~
	~~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:

BryanWB: /* The Main Karma Package */

2010-03-10T04:52:49Z

The Main Karma Package

← Older revision		Revision as of 00:52, 10 March 2010
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, audio, 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 )
	image/		image/
	audio/		audio/

BryanWB: /* The Main Karma Package */

2010-03-10T04:51:53Z

The Main Karma Package

← Older revision		Revision as of 00:51, 10 March 2010
Line 17:		Line 17:
	audio/		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/ ~~lesson.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

BryanWB: /* The Main Karma Package */

2009-12-14T07:00:38Z

The Main Karma Package

← Older revision		Revision as of 03:00, 14 December 2009
Line 19:		Line 19:
	bin/		bin/

	css/ ( css/ and js/ contain the code common to all examples, lessons, and karma.html )		css/ lesson.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/

BryanWB: /* Lesson */

2009-12-14T07:00:09Z

Lesson

← Older revision		Revision as of 03:00, 14 December 2009
Line 97:		Line 97:

	css/		css/
			lesson.css
	docs/		docs/
	activity text		activity text
Line 118:		Line 119:
	The following is out of date but kept for history		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' ''

BryanWB at 06:59, 14 December 2009

2009-12-14T06:59:17Z

← Older revision		Revision as of 02:59, 14 December 2009
Line 37:		Line 37:

	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 83:
	utils/		utils/
	webtoolbar.py		webtoolbar.py
			</strike>
	== Lesson ==		== Lesson ==

Line 91:		Line 91:
	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/
Line 113:		Line 113:
	*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'

BryanWB: /* The Main Karma Package */

2009-12-14T06:57:10Z

The Main Karma Package

← Older revision		Revision as of 02:57, 14 December 2009
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 )
	~~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/		bin/
Line 29:		Line 29:
	po/ Store		po/ Store
	README		README
	tests/ unit tests		tests/ unit tests

	== Karma XO bundle ==		== Karma XO bundle ==

BryanWB at 01:39, 23 November 2009

2009-11-23T01:39:16Z

← Older revision		Revision as of 21:39, 22 November 2009
Line 104:		Line 104:
	js/		js/
	lesson.js main logic of program		lesson.js main logic of program

	tests/ unit tests if u have them		tests/ unit tests if u have them
	assets/		assets/
Line 116:		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'		# 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 ==

BryanWB at 01:37, 23 November 2009

2009-11-23T01:37:54Z

@@ Line 83: / Line 83: @@
    utils/
    webtoolbar.py
 == Lesson ==
@@ Line 116: / Line 89: @@
     lesson_name/
                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/
 *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?

BryanWB: /* Karma XO bundle */

2009-11-23T01:32:11Z

Karma XO bundle

← Older revision		Revision as of 21:32, 22 November 2009
Line 35:		Line 35:
	* similar to E-Paath layout and uses the standard [[Development_Team/Almanac/Activity_Bundles\|Sugar bundle structure]]		* similar to E-Paath layout and uses the standard [[Development_Team/Almanac/Activity_Bundles\|Sugar bundle structure]]
	* It is still undecided whether karma will default to using Browse which is based on Firefox or [http://dev.laptop.org/~bobbyp/surf/Surf-106.xo Surf] which based on webkit (Safari/Chrome). Surf requires that you install the rpms for pywebkitgtk and webkitgtk		* It is still undecided whether karma will default to using Browse which is based on Firefox or [http://dev.laptop.org/~bobbyp/surf/Surf-106.xo Surf] which based on webkit (Safari/Chrome). Surf requires that you install the rpms for pywebkitgtk and webkitgtk

			The '''Below information is out-of-date'''

	activity/		activity/