Features/Introduction Tutorial - Revision history

Sascha silbe: /* Documentation */ tutorius.org is got grabbed :-/

2012-03-06T16:42:22Z

Documentation: tutorius.org is got grabbed :-/

← Older revision		Revision as of 12:42, 6 March 2012
Line 118:		Line 118:
	*http://docs.google.com/Doc?docid=0ARkLUElWcqxDZGdkOWo3c2ZfOWdqeGtyZmY2&hl=en#Components_2405436521573161_98 (Tutorius Architecture)		*http://docs.google.com/Doc?docid=0ARkLUElWcqxDZGdkOWo3c2ZfOWdqeGtyZmY2&hl=en#Components_2405436521573161_98 (Tutorius Architecture)

	* http://www.tutorius.org (Website for the project that ended on December 2009)		* <nowiki>http://www.tutorius.org</nowiki> (Website for the project that ended on December 2009; now owned by a domain grabber)

	== Source Code ==		== Source Code ==

ErickLavoie: /* Documentation */

2010-04-26T13:53:56Z

Documentation

← Older revision		Revision as of 09:53, 26 April 2010
Line 119:		Line 119:

	* http://www.tutorius.org (Website for the project that ended on December 2009)		* http://www.tutorius.org (Website for the project that ended on December 2009)

			== Source Code ==

			* http://git.sugarlabs.org/projects/tutorius

			Forks of sugar components:
			* http://git.sugarlabs.org/projects/sugar-toolkit/repos/sugar-toolkit-tutorius
			* http://git.sugarlabs.org/projects/sugar/repos/tutorius
			* http://git.sugarlabs.org/projects/sugar-jhbuild/repos/tutorius

	== Release Notes ==		== Release Notes ==

ErickLavoie: /* Current status */

2010-04-26T13:50:04Z

Current status

← Older revision		Revision as of 09:50, 26 April 2010
Line 19:		Line 19:

	== Current status ==		== Current status ==
	* Targeted release: ~~0.90~~		* Targeted release: Undefined
	* Last updated: 03-13-2010		* Last updated: 04-26-2010
	* Percentage of completion: ~~10%~~		* Percentage of completion: Suspended

			Note: Due to a higher than expected work requirement at the master level, I'll be suspending work on Tutorius indefinitely. I'll leave the page here, so that the idea is still available. Should anybody want to have more information on how Tutorius was working, I'll be glad to share.

	== Detailed Description ==		== Detailed Description ==

ErickLavoie: /* Scope */

2010-03-14T05:21:50Z

Scope

← Older revision		Revision as of 01:21, 14 March 2010
Line 42:		Line 42:

	== Scope ==		== Scope ==
	Most of the work has already been done as part of the Tutorius project that ended on December 2009. However, there is still some work to do before the existing system can be ~~reliably~~ integrated to Sugar. The modifications to Sugar as well as the work to be done is outlined below.		Most of the work has already been done as part of the Tutorius project that ended on December 2009. However, there is still some work to do before the existing system can reliably be integrated to Sugar. The modifications to Sugar as well as the work to be done is outlined below.

	=== Sugar Modifications ===		=== Sugar Modifications ===

ErickLavoie: /* Detailed Description */

2010-03-14T05:20:36Z

Detailed Description

← Older revision		Revision as of 01:20, 14 March 2010
Line 28:		Line 28:
	The proposal aims at giving an overview of the Frame, the different Views, the Journal, Browse and Write in a single tutorial.		The proposal aims at giving an overview of the Frame, the different Views, the Journal, Browse and Write in a single tutorial.

	The tutorial should be stored ~~in the user home directory, alongside any activity data,~~ as an XML file representing the execution states of the tutorial.		The tutorial should be stored as an XML file representing the execution states of the tutorial.

	Translation of the tutorial should be made using the gettext convention by storing translations of the tutorial strings along side the XML file using the gettext schema (.po, .pot, .mo files).		Translation of the tutorial should be made using the gettext convention by storing translations of the tutorial strings along side the XML file using the gettext schema (.po, .pot, .mo files).

ErickLavoie: /* Tasks */

2010-03-14T05:18:54Z

Tasks

← Older revision		Revision as of 01:18, 14 March 2010
Line 77:		Line 77:
	# Write documentation for the translation team		# Write documentation for the translation team

	The only risky item is the creation of a reliable Overlay for the different Views. For a technical description of what it involves, see [[Features/Introduction_Tutorial/Overlay]]. Any help from GTK gurus in the community is ~~welcomed~~ as our last attempt at this was unsuccessful.		The only risky item is the creation of a reliable Overlay for the different Views. For a technical description of what it involves, see [[Features/Introduction_Tutorial/Overlay]]. Any help from GTK gurus in the community is welcome, as our last attempt at this was unsuccessful.

	==UI Design==		==UI Design==

ErickLavoie: /* Sugar Modifications */

2010-03-14T05:17:50Z

Sugar Modifications

← Older revision		Revision as of 01:17, 14 March 2010
Line 51:		Line 51:
	Overlays are Layouts or Windows used to draw custom graphics on top of Activities, the Frame, the Journal or any Sugar View. A more complete description for Probes and Overlays is given in the Tutorius Architecture document referred in the Documentation section.		Overlays are Layouts or Windows used to draw custom graphics on top of Activities, the Frame, the Journal or any Sugar View. A more complete description for Probes and Overlays is given in the Tutorius Architecture document referred in the Documentation section.

	The service in the sugar-session adds an Engine to execute tutorials, a registering mecanism to register and unregister Probes when Activities are started and stopped and a dbus interface to start and stop tutorials.		The tutorius service in the sugar-session adds an Engine to execute tutorials, a registering mecanism to register and unregister Probes when Activities are started and stopped and a dbus interface to start and stop tutorials.

	Those changes involve modifications of less than 100 lines of code in the existing Sugar code base to the following files:		Those changes involve modifications of less than 100 lines of code in the existing Sugar code base to the following files:

ErickLavoie: /* Sugar Modifications */

2010-03-14T05:16:43Z

Sugar Modifications

← Older revision		Revision as of 01:16, 14 March 2010
Line 53:		Line 53:
	The service in the sugar-session adds an Engine to execute tutorials, a registering mecanism to register and unregister Probes when Activities are started and stopped and a dbus interface to start and stop tutorials.		The service in the sugar-session adds an Engine to execute tutorials, a registering mecanism to register and unregister Probes when Activities are started and stopped and a dbus interface to start and stop tutorials.

	Those changes involve modifications of less than 100 lines of code in the existing Sugar code base ~~but add~~ a ~~number of new~~ files ~~and concepts~~.		Those changes involve modifications of less than 100 lines of code in the existing Sugar code base to the following files:
			* sugar:bin/sugar-session (Add the tutorius service)
			* sugar:src/jarabe/frame/frame.py (Add an Overlay and a Probe)
			* sugar:src/journal/journalactivity.py (Add a Probe)
			* sugar-toolkit:src/sugar/activity/activity.py (Add a Probe)
			* sugar-toolkit:src/sugar/graphics/window.py (Add an Overlay)

			In addition to the previous modifications:
			* The tutorius files should be found under the sugar.tutorius module.
			* Some icons will be added.
			* The tutorial will be stored under ./sugar/default/tutorius in the user home directory.

	=== Tasks ===		=== Tasks ===

ErickLavoie: /* Scope */

2010-03-14T04:59:43Z

Scope

← Older revision		Revision as of 00:59, 14 March 2010
Line 42:		Line 42:

	== Scope ==		== Scope ==
	''What work do the developers have to accomplish to complete the feature in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?''

	Most of the work has already been done as part of the Tutorius project that ended on December 2009. However, there is still some work to do before the existing system can be reliably integrated to Sugar. The modifications to Sugar as well as the work to be done is outlined below.		Most of the work has already been done as part of the Tutorius project that ended on December 2009. However, there is still some work to do before the existing system can be reliably integrated to Sugar. The modifications to Sugar as well as the work to be done is outlined below.

ErickLavoie: /* UI Design */

2010-03-14T04:57:44Z

UI Design

← Older revision		Revision as of 00:57, 14 March 2010
Line 84:		Line 84:
	http://tutorius.org/blog/wp-content/uploads/2010/03/write-300x216.png		http://tutorius.org/blog/wp-content/uploads/2010/03/write-300x216.png

	The information presented to the user will be essentially composed of bubble messages pointing at screen elements. Progress through the tutorial will be accomplished by the user clicking a next button at the bottom of the screen. Once the tutorial is over, the user will be brought back to the Desktop screen where she will be able to resume interacting with the system normally. At any time during the tutorial, the user can press the Stop button to interrupt the current tutorial and return to the ~~original~~ place ~~where~~ she was ~~at first~~.		The information presented to the user will be essentially composed of bubble messages pointing at screen elements. Progress through the tutorial will be accomplished by the user clicking a next button at the bottom of the screen. Once the tutorial is over, the user will be brought back to the Desktop screen where she will be able to resume interacting with the system normally. At any time during the tutorial, the user can press the Stop button to interrupt the current tutorial and return to the place she was when she started the tutorial.

	== How To Test ==		== How To Test ==