Sugar Labs - User contributions [en]

HTML5 activities

2013-06-26T18:27:58Z

Suraj ks: /* GSoC Timeline progress */

= Principles =
The objective of this work is to allow developers to write activities for Sugar using only HTML5 and JavaScript (no need to write Python code). HTML5 activities could be hosted on Sugar side-by-side with "standard" Python activities. Specifically HTML5 will be displayed on the Sugar Home view like any other activities. HTML5 activities could benefit from common Sugar features (Sugar UI, Datastore/journal, telepathy, ...) like any other activities. Finally there should be no visual difference from the user perspective between a Python activity and a HTML5 activity.
HTML5 activities could be named "Sugar Web Activity".

HTML5 activities will be run via a WebKit instance. A JavaScript framework will expose Sugar Features to HTML5 activities. Specifically, this framework will allow to use HTML controls matching the Sugar widgets look&feel and will expose common and customized activity toolbars. The framework will also expose API for handling Telepathy (communication and collaboration between multiple Sugar machine) and Datastore (Sugar Journal reading and writing).

The following schema sum up HTML5 activities functional architecture.

[[File:SugarWebApp Architecture.svg|400px|center]]
Because it will force independence from Gtk/Python, HTML5 activities is a first step toward Sugar on Android.

= History =
The very first Web Activity is [http://activities.sugarlabs.org//en-US/sugar/addon/4411 Wikipedia]. Wikipedia is a Python activity embedding a WebView to display HTML Wikipedia pages. Searching and browsing is available from a standard Python toolbar. Clicking on a toolbar button change the current HTML viewed page or launch an history command (previous/next). To communicate from HTML to Python, Wikipedia embed an [https://git.sugarlabs.org/wikipedia/wikipedia/blobs/master/activity.py HTTP Server]. When a hyperlink is clicked in the HTML page it call the HTTP server then run Python code.

[http://activities.sugarlabs.org/en-US/sugar/addon/4612 Foodchain] is another attempt to write HTML5 activities. In FoodChain there is no embedded HTTP Server. Communication from Python to JavaScript use the WebKit "[https://git.sugarlabs.org/foodchain-activity/master/blobs/master/enyo.py execute_script]" command. Communication from JavaScript to Python use the WebKit "[https://git.sugarlabs.org/foodchain-activity/master/blobs/master/html/sugar.js console.log]" function with a hack on the WebKit "console-message". In both way of communication, all data exchange between Python and JavaScript are converted in JSON.
Two others activities use the same framework: [http://activities.sugarlabs.org/en-US/sugar/addon/4647 Grid paint] and [http://activities.sugarlabs.org/en-US/sugar/addon/4659 Abecedarium]. The framework is described [http://en.flossmanuals.net/make-your-own-sugar-activities/developing-sugar-activities-using-html5/ here].

= Current works =
HTML5 activities has been choose [http://meeting.sugarlabs.org/sugar-meeting/meetings/2013-04-22T14:04:27] as a feature for Sugar 0.100.
HTML5 activities will be build on WebKit2 but if time permits we will implement compatibility with previous releases running WebKit1.
HTML5 activities is accepted a project for [[Summer of Code/2013]].

A technical architecture is described [http://developer.sugarlabs.org/web-architecture.md.html here].
The procedure to create a web activity using from a common template is described [http://shell.sugarlabs.org/~buildbot/docs/activity.md.html here].

Some interesting discussion around this subject in the community:
* Sugar Web Architecture [http://lists.sugarlabs.org/archive/sugar-devel/2013-June/043518.html]
* Sugar Web UI [http://lists.sugarlabs.org/archive/sugar-devel/2013-June/043519.html]
* Localization [http://lists.sugarlabs.org/archive/sugar-devel/2013-June/043466.html]
* Renaming HTML --> Web [http://lists.sugarlabs.org/archive/sugar-devel/2013-May/043400.html]
* Running HTML5 activity on other platforms [http://lists.sugarlabs.org/archive/sugar-devel/2013-June/043422.html]
* How to deploy framework in the activity [http://lists.sugarlabs.org/archive/sugar-devel/2013-May/043335.html]
* Datastore API [http://lists.sugarlabs.org/archive/sugar-devel/2013-May/043303.html][http://lists.sugarlabs.org/archive/sugar-devel/2013-May/thread.html]
* Unit Testing [http://lists.sugarlabs.org/archive/sugar-devel/2013-May/043151.html]
* Webkit1/Webkit2 compatibility [http://lists.sugarlabs.org/archive/sugar-devel/2013-May/043166.html]

= TODO List =
See TODO list of the project on [https://github.com/sugarlabs/roadmap/issues/8].

= GSoC Timeline progress =
* Week 1: Working sugar-build environment, create a new activity [https://github.com/surajgillespie/myactivity]
* Week 2: Develop the RadioButton and CheckBox in Sugar HTML UI, sample here: [https://github.com/surajgillespie/CheckboxRadio], start a new Sugar HTML API
* Week 3: Start developing the Sugar Activity Palette

Summer of Code/2013

2013-06-10T19:53:16Z

Suraj ks: /* Infraestructure */

[[Summer of Code/2013/Application|A draft copy of our application]]

The proposals were moved to http://wiki.sugarlabs.org/go/GSoC/2013/Proposals

= Approved Projects=

__TOC__

== Sugar Core ==

=== Sugar Framework for writing activity in full HTML5 ===

[[File:Sugarhtml5.png|300px]]

The objective is to develop a JavaScript framework allowing to write Sugar activities in full HTML5/JavaScript. The framework will expose to JavaScript an API to call Sugar features:
* Journal/Datastore,
* Collaboration/Telepathy,
* Toolbar handling,
* Sugar look&feel - for example via a CSS style sheet usable on HTML controls
* Access to Sugar settings (buddy name, colors, current language, ...),
* View source.
Like PhoneGap/Cordova, the framework will come with a template to develop and package easily a new HTML5 activity. A basic tutorial will be include too.
The work could be inspired by the work done with Enyo Framework in [http://booki.flossmanuals.net/make-your-own-sugar-activities/_draft/_v/1.0/developing-sugar-activities-using-html5/ 1]. By the way, the resulting framework should be JavaScript framework agnostic (no need for jQuery, Enyo, ...). More on this works [[HTML5 activities|here]].

''Mentor'': [mailto:lionel@olpc-france.org Lionel Laské]

''Co-Mentor'': Daniel Narvaez

Level: Advanced

Benefits to the Student: A chance to learn from touching almost every corner of an advanced system.

Benefits to the Community: We'll greatly expand the reach of the project by opening the door to JavaScript programmers. Plus it will force us to clean up our APIs.

Student: Suraj

Wiki:

=== Project sharing website ===

Create a Project Hosting Site similar to the Scratch website where kids can share the projects they have created using various Sugar Activities. The site should foster collaboration and sharing of projects. The Web Site should be built using a free web framework so that it can be installed at deployment sites. Some features include:

* Ability to engage and connect with friends and classmates using various Social Networking sites/techniques.
* Ability to post projects from various Sugar Activities (ex: Turtle Blocks, Etoys, Memorize, Physics, etc.)
* Separate landing pages for different audiences (kids, teachers, parents, etc.)
* Section to share kid created art from projects
* Ability for users to create galleries (of their own projects, favorite projects, subject specific topics, etc.)
* Ability to have “private classroom spaces”
* Tools to support community management of the site
* Multi-language support

''Contact'': [[User:MrSteve]]

''Co-mentor'': [[User:dogi]]

Level: Advanced

Benefits to the Student: Learn more about web services

Benefits to the Community: We need more mechanisms for sharing ideas and work. This is low-hanging fruit.

Student: Rahul Gaur

Wiki:

=== Implement help mechanism for activities using Mallard ===

[http://projectmallard.org/ Mallard] is a mark-up language that makes it easy to provide user help. It would be a nice feature to add Mallard-like help to activities, accessed through a mechanism similar to the view source mechanism. We need to sort through two issues: integration into Sugar and integration into our i18n / L10n system.

''Contact'': [[User:Walter]]

''Co-mentor'': [[User:Aneesh Dogra]]

''Co-mentor'': [[User:Francis]]

Student: Kalpa Welivitigoda

Wiki page: http://wiki.sugarlabs.org/go/GSoC/2013/MallardHelp

Level: Advanced

Benefits to the Student: Learn about lots of cool tools.

Benefits to the Community: Most of our help is in the wiki and in English. This will enable us to reach our users more directly and in their first language.

=== Social Sugar ===

Design and Develop GUI components that can help Sugar to reflect user's social interactions from external platforms. A perfect target can be the Group-View that shows user's friends and their shared activities [http://wiki.sugarlabs.org/go/Human_Interface_Guidelines/The_Laptop_Experience/Zoom_Metaphor#Groups], but it _could_ also show social information about these friends, IE social networks or sharing platforms publications. This would also give this zoom-level added value.

Community members are already working on the backend component to support this feature [http://lists.sugarlabs.org/archive/sugar-devel/2013-March/042055.html]. This is also a great opportunity to complement other GSoC-2013 proposals.

''Contact'': [[User:tch]]

Level: Intermediate

Benefits to the Student: (a) Learn about Sugar's core, UI Design and web services and (b) interact with community members and other GSoC participants.

Benefits to the Community: Social interaction is a key element in the learning process, therefore we should promote this.

Student: Akshit Khurana

Wiki:

== Sugar Activities ==

=== Python export functionality for Turtle Blocks ===

A goal of Turtle Blocks is not just to get children programming, but to launch them out of block world into text-based languages where they can develop more sophisticated programs. While Turtle Blocks is written in Python and can be extended by importing Python modules, it currently exports only in its native block language and in Logo. For this project, we'd want to enable a Python export option so that programmers can take their Turtle projects and extend them into full-fledged Python projects. The hypothesis is that this would lead more children to grow their programming skills beyond simple block programs.

''Contact'': [[User:Walter]]

''Co-mentor'': Tony Forster

Level: Advanced

Benefits to the Student: Lots of good Python hacking involved

Benefits to the Community: We'll have a vehicle for studying whether or not we can bring students of programming from block worlds to text-based programming and debugging.

Student: Marion Zepf

Wiki:

=== Add recording to Music Keyboard activity ===

[[File:Music keyboard screenshot.png]]

Music Keyboard activity uses part of TamTamMini code to play sounds. Should be good add the capability of record the played sound.

Requires familiarity with Python.

''Contact'': [[User:Godiard]]

Level: Beginner

Benefits to the Student: Learn about python and music libraries (csound)

Benefits to the Community: More shared spaces for expression is aligned with our pedagogical goals.

'''More information ''' http://wiki.sugarlabs.org/go/Activities/MusicKeyboard

Student: Anna Rudkovskaya

Wiki:

=== ASL Open Video Chat ===

Open Video Chat is an Free/Open Source video conferencing activity for the XO laptop. This project was originally started in March 2010 with funding from the National Technical Institute for the Deaf in Rochester NY.

'''Focus'''

The primary focus of Open Video Chat is to provide streaming video at frame rates that are suitable for communicating with sign language. This ends up being somewhere between 20 and 30 frames per second.

'''Current Features'''
* 20 FPS video
* preview window
* text chat

'''Desired Features'''
*RTP protocol implementation
*faster frame rate (30+ FPS)
*audio
*higher resolution video

IRC
* The contributors of Open Video Chat frequent #rit-foss on freenode

''Contact'': [[User:decause]]

Level: Intermediate/Advanced

Benefits to the Student: Learn about gstreamer video pipelines. Learn about sugar networking stack and services (Telepathy). Learn about Python and Sugar UI.

Benefits to the Community: The Video/Text chat software is nearly complete (90%), it just needs to be ported to latest version of sugar and include new telepathy bindings.

Source Code: [https://github.com/FOSSRIT/Open-Video-chat Github Repository]
Activity Page: [http://activities.sugarlabs.org/en-US/sugar/addon/4305 A.SL.O]

Student: Casey DeLorme

Wiki:

== Infrastructure ==

=== Translation Server ===

Student: Erik Price

Wiki:

Summer of Code/2013

2013-06-10T19:50:42Z

Suraj ks: /* Approbed Projects */

[[Summer of Code/2013/Application|A draft copy of our application]]

The proposals were moved to http://wiki.sugarlabs.org/go/GSoC/2013/Proposals

= Approved Projects=

__TOC__

== Sugar Core ==

=== Sugar Framework for writing activity in full HTML5 ===

[[File:Sugarhtml5.png|300px]]

The objective is to develop a JavaScript framework allowing to write Sugar activities in full HTML5/JavaScript. The framework will expose to JavaScript an API to call Sugar features:
* Journal/Datastore,
* Collaboration/Telepathy,
* Toolbar handling,
* Sugar look&feel - for example via a CSS style sheet usable on HTML controls
* Access to Sugar settings (buddy name, colors, current language, ...),
* View source.
Like PhoneGap/Cordova, the framework will come with a template to develop and package easily a new HTML5 activity. A basic tutorial will be include too.
The work could be inspired by the work done with Enyo Framework in [http://booki.flossmanuals.net/make-your-own-sugar-activities/_draft/_v/1.0/developing-sugar-activities-using-html5/ 1]. By the way, the resulting framework should be JavaScript framework agnostic (no need for jQuery, Enyo, ...). More on this works [[HTML5 activities|here]].

''Mentor'': [mailto:lionel@olpc-france.org Lionel Laské]

''Co-Mentor'': Daniel Narvaez

Level: Advanced

Benefits to the Student: A chance to learn from touching almost every corner of an advanced system.

Benefits to the Community: We'll greatly expand the reach of the project by opening the door to JavaScript programmers. Plus it will force us to clean up our APIs.

Student: Suraj

Wiki:

=== Project sharing website ===

Create a Project Hosting Site similar to the Scratch website where kids can share the projects they have created using various Sugar Activities. The site should foster collaboration and sharing of projects. The Web Site should be built using a free web framework so that it can be installed at deployment sites. Some features include:

* Ability to engage and connect with friends and classmates using various Social Networking sites/techniques.
* Ability to post projects from various Sugar Activities (ex: Turtle Blocks, Etoys, Memorize, Physics, etc.)
* Separate landing pages for different audiences (kids, teachers, parents, etc.)
* Section to share kid created art from projects
* Ability for users to create galleries (of their own projects, favorite projects, subject specific topics, etc.)
* Ability to have “private classroom spaces”
* Tools to support community management of the site
* Multi-language support

''Contact'': [[User:MrSteve]]

''Co-mentor'': [[User:dogi]]

Level: Advanced

Benefits to the Student: Learn more about web services

Benefits to the Community: We need more mechanisms for sharing ideas and work. This is low-hanging fruit.

Student: Rahul Gaur

Wiki:

=== Implement help mechanism for activities using Mallard ===

[http://projectmallard.org/ Mallard] is a mark-up language that makes it easy to provide user help. It would be a nice feature to add Mallard-like help to activities, accessed through a mechanism similar to the view source mechanism. We need to sort through two issues: integration into Sugar and integration into our i18n / L10n system.

''Contact'': [[User:Walter]]

''Co-mentor'': [[User:Aneesh Dogra]]

''Co-mentor'': [[User:Francis]]

Student: Kalpa Welivitigoda

Wiki page: http://wiki.sugarlabs.org/go/GSoC/2013/MallardHelp

Level: Advanced

Benefits to the Student: Learn about lots of cool tools.

Benefits to the Community: Most of our help is in the wiki and in English. This will enable us to reach our users more directly and in their first language.

=== Social Sugar ===

Design and Develop GUI components that can help Sugar to reflect user's social interactions from external platforms. A perfect target can be the Group-View that shows user's friends and their shared activities [http://wiki.sugarlabs.org/go/Human_Interface_Guidelines/The_Laptop_Experience/Zoom_Metaphor#Groups], but it _could_ also show social information about these friends, IE social networks or sharing platforms publications. This would also give this zoom-level added value.

Community members are already working on the backend component to support this feature [http://lists.sugarlabs.org/archive/sugar-devel/2013-March/042055.html]. This is also a great opportunity to complement other GSoC-2013 proposals.

''Contact'': [[User:tch]]

Level: Intermediate

Benefits to the Student: (a) Learn about Sugar's core, UI Design and web services and (b) interact with community members and other GSoC participants.

Benefits to the Community: Social interaction is a key element in the learning process, therefore we should promote this.

Student: Akshit Khurana

Wiki:

== Sugar Activities ==

=== Python export functionality for Turtle Blocks ===

A goal of Turtle Blocks is not just to get children programming, but to launch them out of block world into text-based languages where they can develop more sophisticated programs. While Turtle Blocks is written in Python and can be extended by importing Python modules, it currently exports only in its native block language and in Logo. For this project, we'd want to enable a Python export option so that programmers can take their Turtle projects and extend them into full-fledged Python projects. The hypothesis is that this would lead more children to grow their programming skills beyond simple block programs.

''Contact'': [[User:Walter]]

''Co-mentor'': Tony Forster

Level: Advanced

Benefits to the Student: Lots of good Python hacking involved

Benefits to the Community: We'll have a vehicle for studying whether or not we can bring students of programming from block worlds to text-based programming and debugging.

Student: Marion Zepf

Wiki:

=== Add recording to Music Keyboard activity ===

[[File:Music keyboard screenshot.png]]

Music Keyboard activity uses part of TamTamMini code to play sounds. Should be good add the capability of record the played sound.

Requires familiarity with Python.

''Contact'': [[User:Godiard]]

Level: Beginner

Benefits to the Student: Learn about python and music libraries (csound)

Benefits to the Community: More shared spaces for expression is aligned with our pedagogical goals.

'''More information ''' http://wiki.sugarlabs.org/go/Activities/MusicKeyboard

Student: Anna Rudkovskaya

Wiki:

=== ASL Open Video Chat ===

Open Video Chat is an Free/Open Source video conferencing activity for the XO laptop. This project was originally started in March 2010 with funding from the National Technical Institute for the Deaf in Rochester NY.

'''Focus'''

The primary focus of Open Video Chat is to provide streaming video at frame rates that are suitable for communicating with sign language. This ends up being somewhere between 20 and 30 frames per second.

'''Current Features'''
* 20 FPS video
* preview window
* text chat

'''Desired Features'''
*RTP protocol implementation
*faster frame rate (30+ FPS)
*audio
*higher resolution video

IRC
* The contributors of Open Video Chat frequent #rit-foss on freenode

''Contact'': [[User:decause]]

Level: Intermediate/Advanced

Benefits to the Student: Learn about gstreamer video pipelines. Learn about sugar networking stack and services (Telepathy). Learn about Python and Sugar UI.

Benefits to the Community: The Video/Text chat software is nearly complete (90%), it just needs to be ported to latest version of sugar and include new telepathy bindings.

Source Code: [https://github.com/FOSSRIT/Open-Video-chat Github Repository]
Activity Page: [http://activities.sugarlabs.org/en-US/sugar/addon/4305 A.SL.O]

Student: Casey DeLorme

Wiki:

== Infraestructure ==

=== Translation Server ===

Student: Erik Price

Wiki:

User talk:Suraj ks

2013-04-27T07:30:12Z

Suraj ks: Created page with "checking if woorking"

checking if woorking