Sugar Labs - User contributions [en]

Sugar Labs/Getting Involved

2018-02-28T03:09:35Z

Callkalpa: /* Developer */ Fixed the developer information URL to point to github/sugar-docs

<noinclude>{{Translations | [[Sugar_Labs/Getting_Involved|english]] | [[Sugar_Labs/Getting_Involved/lang-es|español]]}}{{TeamHeader|Sugar Labs|home=Community Home|meeting_link=Events|meeting_label=Events Calendar}}</noinclude>
__FORCETOC__
= Join Sugar Labs =

Apply for membership [[Sugar_Labs/Members|here]].

----

'''We need your help in improving how computers are used in education'''. ''You'' can take an active hand in making Sugar realize its [[Archive/Current_Events/2009-03-17#What_are_our_objectives.3F | '''vision''']]. Making [[What is Sugar?|'''Sugar''']] depends on volunteers who love to engage in authentic activities—activities that help fulfill the potentials they individually see in Sugar's vision. What do you want to see happen? What roles could you fill? Click the role of your choice in the grid below, and then, after selecting a Team or project link, follow the '''Join''' links at the top of the Team or project page (in the green or yellow linkbar) to learn how you can '''Join In'''. We depend on ''you'' getting involved!
<div class="noborder">
{| class="wikitable" cellspacing="0" cellpadding="5" width=100% style="background:#eeeeff;border:5px solid white;text-align:center;"
|-
|valign="TOP" width=33% style="border:5px solid white;"|<span class="linkgroup">[[File:Join_Educator.png|link=#Educator]]</span>

[[#Educator | Educator]]

|valign="TOP" width=33% style="border:5px solid white;" |<span class="linkgroup">[[File:Join_ContentDeveloper.png|link=#Content Writer]]</span>

[[#Content_Writer | Content Writer]]

|valign="TOP" width=33% style="border:5px solid white;"|<span class="linkgroup">[[File:Join_PeoplePerson.png|link=#People Person]]</span>

[[#People_Person | People Person]]
|-
|valign="TOP" width=33% style="border:5px solid white;"|<span class="linkgroup">[[File:Join_Developer.png|link=#Developer]]</span>

[[#Developer | Developer]]

|valign="TOP" width=33% style="border:5px solid white;"|<span class="linkgroup">[[File:Join_Designer.png|link=#Designer]]</span>

[[#Designer | Designer]]

|valign="TOP" width=33% style="border:5px solid white;"|<span class="linkgroup">[[File:Join_Translator.png|link=#Translator]]</span>

[[#Translator | Translator]]
|-
|valign="TOP" colspan="3" style="border:5px solid white;"|
'''[[What could I do in an hour?]]'''
|-
|valign="TOP" colspan="3" style="border:5px solid white;"|
'''[[Summer of Code/2017|Google Summer of Code]]''' - '''[[Ideas for Projects]]'''
|-
|valign="TOP" colspan="3" style="border:5px solid white;"|
Financial contributions are discussed on the [[Sugar Labs/Donate]] page.
|}
</div>

====Learn more====

Help us understand and improve the ability for people to contribute and become deeply involved with Sugar.
{{Iframe|See [http://planet.sugarlabs.org Planet Sugar Labs], our blog aggregator |http://planet.sugarlabs.org|900|600|1}}
* Sugar Labs [[Sugar Labs/Communication channels|Communication channels]], [[:Category:Participate |Participation pages]], [[Sugar Labs/Volunteer Funnel|Volunteer Funnel]], & [[Vacancies]],
* The One Laptop per Child [[olpc:Participate | Participation page]].
<div style="background-color:#a0ff93; border:1px solid #cdf; padding:6px 14px;">
The Sugar community is made of individuals, teams, and relationships.

We all share one thing in common: '''We want to improve how computers are used in education'''.

Join us in discussing the project on the [http://lists.sugarlabs.org/listinfo/iaep It's an Education Project] mailing list. [http://wiki.sugarlabs.org/index.php?title=Special:OpenIDLogin&returnto=Special:UserLogin Open a wiki account here] and edit this site.
</div>

{{Anchor | Educator}}

== Educator ==
[[Image:Join_Educator_BW.png|link=]]

'''Description of this role:''' Focus on Sugar's learners educational needs.

'''Skills you possess or want to learn''':
* Explaining complex ideas well, people skills, teaching through digital media, understanding of educational theories and obstacles, paedagogy, ability to communicate with and influence developers.

'''Teams/projects associated with this role''':
* | [[Education Team]] | [[Activity Team]] | [[Deployment Team]] | [[Local Labs]] |
* | [[Math4Team]] | [[Sugar on a Stick]] | [[Replacing Textbooks]]

'''Tasks typical in this role''':
* Tasks typical in this role: Lesson plans, teacher guides, text book templates/samples, articles, leverage Sugar as an ideal platform for learning, provide guidance and feedback to those working on technical aspects of Sugar, setting educational goals, educational activities.

'''Real person to help you get started''':
* If you are an educator who would like to help with Sugar, please subscribe and contact [http://lists.sugarlabs.org/listinfo/iaep iaep] at sugarlabs dot org. iaep it's an acronym of "It's an Education Project" and it is the main emails list supported by Sugar labs Systems team. IAEP helps Educators, learners, designers and programmers interact while learning the how to's to develop and sharing of their projects.

{{Anchor|ContentWriter}}

== Content Writer ==
[[Image:Join_ContentDeveloper_BW.png|link=]]

'''Description of this role:''' Communicate through words.

'''Skills you possess or want to learn''':
* Writing, editing, grammar, wordsmithing, proof-reading, explaining complex ideas well, teaching, wiki markup, technical knowledge (specific and general).
'''Teams associated with this role''':
* | [[Documentation Team]] | [[Marketing Team]] | [[Wiki Team]] | [[Deployment Team]] | [[Local Labs]] |
* | [[Math4Team]] | [[Replacing Textbooks]]
'''Tasks typical in this role''':
* Write, edit, illustrate, or program an Open Education Resource on any subject for any age in the Sugar Labs [[Replace Textbooks]] project.
* Write a [http://booki.flossmanuals.net FLOSS Manual] for your favorite activity, guides, how-tos, FAQs, knowledge base, lesson plans, teacher guides, text book templates/samples, articles, marketing material, process/methodology documents, editing, release notes.
'''Real person to help you get started''':
* If you are a content writer please subscribe and contact [http://lists.sugarlabs.org/listinfo/iaep iaep] at sugarlabs dot org. iaep it's an acronym of "It's an Education Project" and it is the main emails list supported by Sugar labs Systems team. IAEP helps Educators, learners, designers and programmers interact while learning the how to's to develop and sharing of their projects.

{{Anchor|PeoplePerson}}

== People Person ==
[[Image:Join_PeoplePerson_BW.png|link=]]

'''Description of this role:''' Communicate through one-on-one contact.

'''Skills you possess or want to learn''':
* People skills, public relations, event organization, customer service/support, enthusiasm.

'''Teams/projects associated with this role''':
* | [[Marketing Team]] | [[Documentation Team]] | [[Deployment Team]] | [[Local Labs]] |
* | [[Sugar on a Stick]] |

'''Tasks typical in this role''':
* Conferences, press releases, local events, organizing events, community management, Sugar Labs forum/IRC help/support tech, send out media/spread Sugar, encourage others to participate, cat herding.

'''Real person to help you get started''':
* If you are a people person who would like to help with Sugar Labs Project Management, please contact slobs at sugarlabs dot org.

{{Anchor|Developer}}

== Developer ==
[[Image:Join_Developer_BW.png|link=]]

'''Description of this role:''' Communicate through code.

'''Skills you possess or want to learn''':
* Python, C, GTK+, git, packaging, bug filing, tracking and testing, JavaScript, web app development, GNU/Linux system administration

'''Teams/projects associated with this role''':
* See https://github.com/sugarlabs/sugar-docs for the most current information.
* | [[Development Team]] | [[Activity Team]] | [[Platform Team]] | [[BugSquad|Testing Team]] | [[Infrastructure Team]] |
* | [[Summer of Code | Google Summer of Code]] | [[Math4Team]] | [[Development Team/Project Ideas | Project Ideas]] | [[Sugar on a Stick]] |

'''Tasks typical in this role''':
* Get the source code, test & break Sugar, design & build Sugar, file bugs, fix bugs, build packages, develop new features, test, design, develop & help maintain activities, toolchain, scripts.

'''Real people to help you get started''':
* [[Mentors]]
* If you are a developer who would like to help with Sugar, please introduce yourself at the [http://lists.sugarlabs.org/listinfo/sugar-devel sugar devel mailing list]

{{Anchor|Designer}}

== Designer ==
[[Image:Join_Designer_BW.png|link=]]

'''Description of this role:''' Communicate through images.

'''Skills you possess or want to learn''':
* Inkscape, GIMP, other vector & raster graphics tools, OpenOffice, design, usability/interaction.

'''Teams/projects associated with this role''':
* | [[Design Team|Design Team]] | [[Marketing Team]] | [[Documentation Team]] |
* | [[Math4Team]] |

'''Tasks typical in this role''':
* Sugar art work (SVG activity icons, toolbar icons), Activity image content, user interface design, publication design, web design, icons, design mock-ups, conference banners/flyers, logos, materials (t-shirts, CD covers, etc.)

'''Real person to help you get started''':
* If you are a designer who would like to help with Sugar, please subscribe and contact [http://lists.sugarlabs.org/listinfo/iaep iaep] at sugarlabs dot org. iaep it's an acronym of "It's an Education Project" and it is the main emails list supported by Sugar labs Systems team. IAEP helps Educators, learners, designers and programmers interact while learning the how to's to develop and sharing of their projects.

== Translator ==
[[Image:Join_Translator_BW.png|link=]]

'''Description of this role:''' Communicate through interpretation.

'''Skills you possess or want to learn''':
* English, Non-English native language, technical knowledge, Pootle, PO, translation.

'''Teams/projects associated with this role''':
* | [[Translation Team]] | [[Documentation Team]] | [[Wiki Team | Wiki Team]] | [[Local Labs]] | [[Replacing Textbooks]]
'''Tasks typical in this role''':
* Activity and Sugar user interface string translation, localization (l10n), internationalization (i18n), marketing materials, documents, OERs, websites, providing cultural specific feedback to other teams.
* '''Real person to help you get started''': If you are a translator who would like to help with translating Sugar, please contact translate at sugarlabs dot org.

[[Category:Participate]]

GSoC/2013/Activity Help

2017-02-21T12:26:58Z

Callkalpa: /* View help for the Activity in the help itself */ Updated the hot key combination

== Introduction ==

This page contains information about the project [[Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard|"Implement help mechanism for activities using Mallard"]]. This project is being implemented as a GSoC 2013 project.

Although the initial proposal was to use Mallard for the help mechanism, the research done and the progress of the project proved that simply using the current help content would serve the purpose. Therefore with the approval of the mentors, the implementation with Mallard is dropped.

== Objectives ==

* Implement a help mechanism to view Help in the Activity
* Support l10n for help content
* Write help for more activities
* Improve current Help Activity

== Progress ==

==== View help for the Activity in the help itself ====

Help content for the current Activity can be viewed in the Activity itself. It will pop up in a window when the user enters the key combination '''alt+shift+h'''. If there is no help content for the Activity, an error message will be written to the log. I have used the '''bundle_id''' of the Activity to match it with the corresponding help content file (in html).

[https://github.com/callkalpa/sugar/tree/activity_help GitHub repo - Sugar fork]

<gallery>
File:Activity_help_browse.png|ActivityHelp in Browse
File:Activity_help_pippy.png|ActivityHelp in Pippy
</gallery>

==== Support help content localization ====

For the [https://git.sugarlabs.org/help-activity-content help content] I have generated the POT files using [http://sphinx-doc.org/intl.html sphinx internationalization tools]. The POT files are submitted to [http://translate.sugarlabs.org/projects/help_content/ help_content] project in Pootle with the emmense support of Chris. The help content is being translated.

<gallery>
File:ActivityHelp_Read_in_Sinhala.png|Read Activity help in Sinhala
File:About_OLPC_in_Danish.png|About OLPC help in Danish
</gallery>

==== Update Help Activity ====

Help Activity was improved to so as to support localized help content. Before localization content is supported, Help Activity was released with the help content in the form of html files, static content including images, css, javascript etc. With localized help content, there will be one set of static content and different html files for each and every language that help content is localized into. I have done mainly two modifications.

[https://git.sugarlabs.org/~callkalpa/help/callkalpa-help/commits/activity_help Gitorious repo - Help Activity fork]

===== helplink file =====

helplink is a json file. It includes the '''bundle_id''' of the Activity and the name of the corresponding help content (html) file. This file will be used when viewing help content in the Activity. Following is the current version of helplink.json.

{
"org.laptop.sugar.ReadActivity": "read.html",
"org.laptop.WebActivity": "browse.html",
"org.laptop.Chat": "chat.html",
"org.laptop.Calculate": "calculate.html",
"org.eq.FotoToon": "fototoon.html",
"org.laptop.RecordActivity": "record.html",
"org.laptop.MeasureActivity": "measure.html",
"org.laptop.Oficina": "paint.html",
"org.sugarlabs.PortfolioActivity": "portfolio.html",
"org.laptop.Memorize": "memorize.html",
"org.laptop.Terminal": "terminal.html",
"org.laptop.AbiWordActivity": "write.html",
"org.laptop.TurtleArtActivity": "turtleart.html",
"org.laptop.Pippy": "pippy.html",
"org.laptop.TamTamMini": "tamtammini.html"
}

===== directory structure modification =====

To support localized content I had to change the directory structure of the help directory of the Help Activity. Following is the directory structure before,

help
-_images
-_static
-*.html (help content)

new directory structure (with localization support) - only localization of English and Sinhala are shown as en example
help
-_images
-_static
-en
-*.html (help content in English)
-si
-*.html (help content in Sinhala)

===== l10n_script.sh =====

l10n_script.sh is a bash script develop to ease the process of bundling all localized help content to be shipped with Help Activity. In Help Activity, all the help content are in '''help''' directory. This script will generate the localized html content and place them in '''help''' directory with the proper directory structure. In releasing a new version of Help Activity, the maintainer can simply copy the '''help''' directory to the Help Activity directory, bundle it and ship.

Following is a snap of the directory structure associated with the script

help
-da
-about.html
-sugar_ui.html
-en
-about.html
-gnome.html
_images
-si
-about.html
-index.html
_static
l10n_script.sh
translated_po
-da
-16_sugar_ui.po
-en
-23_gnome.po
-si
-02_index.po
-03_about.po

'''translated_po''' directory will have the translated PO files in in the appropriate language directory (those PO files are from Pootle). Running the script,

./l10n_script.sh <language code>
example: ./l10n_script.sh en

After running the script it will create the '''help''' directory and modify the html files so as to share the same '''_images''' and '''_static''' content.

==== Update current help content ====

I have been updating the current help content, making them upto date with localization supporting screen capturing (label icons of the screen captures with numbers and refer and describe the icons below in text so that it can be localized). During the review process of submitting help content to Pootle, a lot of improvements with regard to the language are being done.

[https://git.sugarlabs.org/help-activity-content Gitorius repo - help activity content]

== To-do ==

* Write help for activities
* Update current help content for some Activities including FotoToon and Record

== How to contribute ==
Help content for Help Activity are written is rst. A comprehensive guide on how to write help is presented at http://wiki.laptop.org/go/Help_Activity_refresh/0.98#About_rst_format

You may refer to the rst files of existing help content at https://git.sugarlabs.org/help-activity-content/mainline/trees/master/source

Once you are completed, you can send a merge request to https://git.sugarlabs.org/help-activity-content or send Kalpa (me) or Gonzalo a mail along with the screen captures if there are any.
* Kalpa - callkalpa [AT] gmail.com
* Gonzalo - godiard [AT] sugarlabs.org

Features/Activity Help

2013-11-07T16:51:52Z

Callkalpa:

<noinclude>
[[Category:Feature Page Incomplete]]
[[Category:Feature|.]]

</noinclude>

== Summary ==
Provides a mechanism to view help about the activity in the current locale within the activity itself.

== Owner ==
* Name: [[User:Callkalpa| Kalpa Welivitigoda]]
* Email: callkalpa [AT] gmail.com

== Current status ==
* Targeted release: (0.102)
* Last updated: (10 October 2013)
* Percentage of completion: 100%

== Detailed Description ==
This enables the user to view the help for current activity in the current locale within the activity itself. The user doesn't need to go to Help activity and find the help page for the current activity. He/she can press Ctrl+Shift+H and if there is help content for the current activity, it will pop up a window with the help content in it. This is similar to the view source pop up window in activities. If there is not help content for that particular activity, it will write an error message in the log. If help content in current locale is not available and if they are available in English, it will display the help content in English.

== Benefit to Sugar ==
This feature was developed as my Google Summer of Code project in 2013. The feature will enhance the platform by providing a way to view in activity help and in the current locale.

== Scope ==
Impact to existing sugar code: extensions/globalkey/Makefile.am src/jarabe/view/Makefile.am
New code: extensions/globalkey/viewhelp.py src/jarabe/view/viewhelp.py

==UI Design==
There is the pop up window similar to that of the view source window.

[[File:Activity help browse.png|thumbnail|none]]

== How To Test ==
I have already sent a pull requets (https://github.com/sugarlabs/sugar/pull/114). This feature needs some modifications to be made in Help activity as well. Those modifications will be available from Help 17 onwards which is to be released soon. Once you have Help 17 and the diff is applied to sugar,

1) Open an activity like Browse, Read
2) Press ctrl+shift+h, a window should pop up with the help content for that particular activity (only if the help content for that activity is already there in Help activity)

== User Experience ==
It will be convenient for the users to have the ability to view the help of the current activity within the activity itself. Otherwise the user has to load Help activity and search for help for that particular activity. Since help/support is something that is spread system wide, it is better we make it available wherever possible rather than keeping it as a separate activity. Since this feature enables to view in the current locale (only if the content is available in the current locale in Help activity), it will be more helpful for the users to read and unsderstand the content in a language that is more convenient to them.

== Dependencies ==
This feature needs some modifications to be made to Help activity. The modifications required are to be due to be included in Help 17.

== Contingency Plan ==
None. The code is complete and waiting to be reviewed.

== Documentation ==
[[GSoC/2013/ActivityHelp]]

== Release Notes ==
Supports viewing help for the current activity in the current locale inside the activity itself.

== Comments and Discussion ==

Features/Activity Help

2013-11-07T16:48:12Z

Callkalpa:

<noinclude>
[[Category:Feature Page Incomplete]]
[[Category:Feature|.]]

</noinclude>

== Summary ==
Provides a mechanism to view help about the activity in the current locale within the activity itself.

== Owner ==
* Name: [[User:Callkalpa| Kalpa Welivitigoda]]
* Email: callkalpa [AT] gmail.com

== Current status ==
* Targeted release: (0.102)
* Last updated: (10 October 2013)
* Percentage of completion: 100%

== Detailed Description ==
This enables the user to view the help for current activity in the current locale within the activity itself. The user doesn't need to go to Help activity and find the help page for the current activity. He/she can press Ctrl+Shift+H and if there is help content for the current activity, it will pop up a window with the help content in it. This is similar to the view source pop up window in activities. If there is not help content for that particular activity, it will write an error message in the log. If help content in current locale is not available and if they are available in English, it will display the help content in English.

== Benefit to Sugar ==
This feature was developed as my Google Summer of Code project in 2013. The feature will enhance the platform by providing a way to view in activity help and in the current locale.

== Scope ==
Impact to existing sugar code: extensions/globalkey/Makefile.am src/jarabe/view/Makefile.am
New code: extensions/globalkey/viewhelp.py src/jarabe/view/viewhelp.py

==UI Design==
There is the pop up window similar to that of the view source window.

[[File:Activity help browse.png|thumbnail|none]]

== How To Test ==
I have already sent a pull requets (https://github.com/sugarlabs/sugar/pull/114). This feature needs some modifications to be made in Help activity as well. Those modifications will be available from Help 17 onwards which is to be released soon. Once you have Help 17 and the diff is applied to sugar,

1) Open an activity like Browse, Read
2) Press ctrl+shift+h, a window should pop up with the help content for that particular activity (only if the help content for that activity is already there in Help activity)

== User Experience ==
It will be convenient for the users to have the ability to view the help of the current activity within the activity itself. Otherwise the user has to load Help activity and search for help for that particular activity. Since help/support is something that is spread system wide, it is better we make it available wherever possible rather than keeping it as a separate activity. Since this feature enables to view in the current locale (only if the content is available in the current locale in Help activity), it will be more helpful for the users to read and unsderstand the content in a language that is more convenient to them.

== Dependencies ==
This feature needs some modifications to be made to Help activity. The modifications required are to be due to be included in Help 17.

== Contingency Plan ==
None. The code is complete and waiting to be reviewed.

== Documentation ==
[[http://wiki.sugarlabs.org/go/GSoC/2013/ActivityHelp]]

== Release Notes ==
Supports viewing help for the current activity in the current locale inside the activity itself.

== Comments and Discussion ==

Features/Activity Help

2013-11-07T16:31:50Z

Callkalpa: Created page with "<noinclude> Category:Feature Page Incomplete . <!-- You can add categories to tie features back to real deployments/schools requesting them, for examp..."

<noinclude>
[[Category:Feature Page Incomplete]]
[[Category:Feature|.]]

</noinclude>

== Summary ==
Provides a mechanism to view help about the activity in the current locale within the activity itself.

== Owner ==
* Name: [[User:Callkalpa| Kalpa Welivitigoda]]
* Email: callkalpa [AT] gmail.com

== Current status ==
* Targeted release: (0.102)
* Last updated: (10 October 2013)
* Percentage of completion: 100%

== Detailed Description ==
This enables the user to view the help for current activity in the current locale within the activity itself. The user doesn't need to go to Help activity and find the help page for the current activity. He/she can press Ctrl+Shift+H and if there is help content for the current activity, it will pop up a window with the help content in it. This is similar to the view source pop up window in activities. If there is not help content for that particular activity, it will write an error message in the log. If help content in current locale is not available and if they are available in English, it will display the help content in English.

== Benefit to Sugar ==
This feature was developed as my Google Summer of Code project in 2013. The feature will enhance the platform by providing a way to view in activity help and in the current locale.

== Scope ==
Impact to existing sugar code: extensions/globalkey/Makefile.am src/jarabe/view/Makefile.am
New code: extensions/globalkey/viewhelp.py src/jarabe/view/viewhelp.py

==UI Design==
There is the pop up window similar to that of the view source window.

[[File:Http://wiki.sugarlabs.org/go/Activity help browse.png|thumbnail|none]]

== How To Test ==
Apply the code at https://github.com/callkalpa/sugar/tree/activity_help
== User Experience ==
''If this feature is noticeable by its target audience, how will their experiences change as a result? Describe what they will see or notice.''

== Dependencies ==
''What other packages (RPMs) depend on this package? Are there changes outside the developers' control on which completion of this feature depends? In other words, does your feature depend on completion of another feature owned by someone else or that you would need to coordinate, which might cause you to be unable to finish on time? Other upstream projects like Python?''

== Contingency Plan ==
''If you cannot complete your feature by the final development freeze, what is the backup plan? This might be as simple as "None necessary, revert to previous release behaviour." Or it might not. If your feature is not completed in time, we want to assure others that other parts of Sugar will not be in jeopardy.''

== Documentation ==
''Is there upstream documentation on this feature, or notes you have written yourself? Has this topic been discussed in the mailing list or during a meeting? Link to that material here so other interested developers can get involved.''

== Release Notes ==
''The Sugar Release Notes inform end-users about what is new in the release. An Example is [[0.84/Notes]]. The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns. If there are any such changes involved in this feature, indicate them here. You can also link to upstream documentation if it satisfies this need. This information forms the basis of the release notes edited by the release team and shipped with the release.''

== Comments and Discussion ==

* ''Link to the discussion of this feature on lists.sugarlabs.org''
* See [[{{TALKPAGENAME}}|discussion tab for this feature]]

0.102/Feature List

2013-11-07T15:41:42Z

Callkalpa: /* Proposed Features for 0.102 */

<noinclude>
[[Category:FeatureList]]
</noinclude>

== Proposed Features for 0.102 ==
These features have been proposed to the Release Manager for the Sugar 0.102 Release.
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Owner !! Complete !!Name !!Summary !!Updated
|-
| Walter || 100% || [[Features/Launch_Limits|Launch Limits]] || Provide limits to the number of open activities and number of open instances of an activity. || 4 Nov 2013
|-
| Walter || 100% || [[Features/AboutMe|Age and Gender]] || Provide a mechanism for users to specify age and gender. || 4 Nov 2013
|-
| Walter || 100% || [[Features/UpdateFavorites|Update Favorites]] || Add dbus service to update favorites.. || 4 Nov 2013
|-
| Walter || 0% || [[Features/Join Limits|Join Limits]] || Honor limits to the number of buddies who can join a shared activity. || 4 Nov 2013
|-
| Kalpa || 100% || [[Features/ActivityHelp|Activity Help]] || Display the help for the activity in the activity itself. || 7 Nov 2013
|
|}

0.102/Feature List

2013-11-07T15:33:34Z

Callkalpa: /* Proposed Features for 0.102 */ ActivityHelp added

<noinclude>
[[Category:FeatureList]]
</noinclude>

== Proposed Features for 0.102 ==
These features have been proposed to the Release Manager for the Sugar 0.102 Release.
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Owner !! Complete !!Name !!Summary !!Updated
|-
| Walter || 100% || [[Features/Launch_Limits|Launch Limits]] || Provide limits to the number of open activities and number of open instances of an activity. || 4 Nov 2013
|-
| Walter || 100% || [[Features/AboutMe|Age and Gender]] || Provide a mechanism for users to specify age and gender. || 4 Nov 2013
|-
| Walter || 100% || [[Features/UpdateFavorites|Update Favorites]] || Add dbus service to update favorites.. || 4 Nov 2013
|-
| Walter || 0% || [[Features/Join Limits|Join Limits]] || Honor limits to the number of buddies who can join a shared activity. || 4 Nov 2013
|-
| Kalpa || 50% || [[Features/ActivityHelp|Activity Help]] || Display the help for the activity in the activity itself. || 7 Nov 2013
|-
|}

GSoC/2013/Activity Help

2013-08-31T03:33:32Z

Callkalpa: /* How to contribute */

== Introduction ==

This page contains information about the project [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard "Implement help mechanism for activities using Mallard"]. This project is being implemented as a GSoC 2013 project.

Although the initial proposal was to use Mallard for the help mechanism, the research done and the progress of the project proved that simply using the current help content would serve the purpose. Therefore with the approval of the mentors, the implementation with Mallard is dropped.

== Objectives ==

* Implement a help mechanism to view Help in the Activity
* Support l10n for help content
* Write help for more activities
* Improve current Help Activity

== Progress ==

==== View help for the Activity in the help itself ====

Help content for the current Activity can be viewed in the Activity itself. It will pop up in a window when the user enters the key combination '''ctrl+shift+h'''. If there is no help content for the Activity, an error message will be written to the log. I have used the '''bundle_id''' of the Activity to match it with the corresponding help content file (in html).

[https://github.com/callkalpa/sugar/tree/activity_help GitHub repo - Sugar fork]

<gallery>
File:Activity_help_browse.png|ActivityHelp in Browse
File:Activity_help_pippy.png|ActivityHelp in Pippy
</gallery>

==== Support help content localization ====

For the [https://git.sugarlabs.org/help-activity-content help content] I have generated the POT files using [http://sphinx-doc.org/intl.html sphinx internationalization tools]. The POT files are submitted to [http://translate.sugarlabs.org/projects/help_content/ help_content] project in Pootle with the emmense support of Chris. The help content is being translated.

<gallery>
File:ActivityHelp_Read_in_Sinhala.png|Read Activity help in Sinhala
File:About_OLPC_in_Danish.png|About OLPC help in Danish
</gallery>

==== Update Help Activity ====

Help Activity was improved to so as to support localized help content. Before localization content is supported, Help Activity was released with the help content in the form of html files, static content including images, css, javascript etc. With localized help content, there will be one set of static content and different html files for each and every language that help content is localized into. I have done mainly two modifications.

[https://git.sugarlabs.org/~callkalpa/help/callkalpa-help/commits/activity_help Gitorious repo - Help Activity fork]

===== helplink file =====

helplink is a json file. It includes the '''bundle_id''' of the Activity and the name of the corresponding help content (html) file. This file will be used when viewing help content in the Activity. Following is the current version of helplink.json.

{
"org.laptop.sugar.ReadActivity": "read.html",
"org.laptop.WebActivity": "browse.html",
"org.laptop.Chat": "chat.html",
"org.laptop.Calculate": "calculate.html",
"org.eq.FotoToon": "fototoon.html",
"org.laptop.RecordActivity": "record.html",
"org.laptop.MeasureActivity": "measure.html",
"org.laptop.Oficina": "paint.html",
"org.sugarlabs.PortfolioActivity": "portfolio.html",
"org.laptop.Memorize": "memorize.html",
"org.laptop.Terminal": "terminal.html",
"org.laptop.AbiWordActivity": "write.html",
"org.laptop.TurtleArtActivity": "turtleart.html",
"org.laptop.Pippy": "pippy.html",
"org.laptop.TamTamMini": "tamtammini.html"
}

===== directory structure modification =====

To support localized content I had to change the directory structure of the help directory of the Help Activity. Following is the directory structure before,

help
-_images
-_static
-*.html (help content)

new directory structure (with localization support) - only localization of English and Sinhala are shown as en example
help
-_images
-_static
-en
-*.html (help content in English)
-si
-*.html (help content in Sinhala)

===== l10n_script.sh =====

l10n_script.sh is a bash script develop to ease the process of bundling all localized help content to be shipped with Help Activity. In Help Activity, all the help content are in '''help''' directory. This script will generate the localized html content and place them in '''help''' directory with the proper directory structure. In releasing a new version of Help Activity, the maintainer can simply copy the '''help''' directory to the Help Activity directory, bundle it and ship.

Following is a snap of the directory structure associated with the script

help
-da
-about.html
-sugar_ui.html
-en
-about.html
-gnome.html
_images
-si
-about.html
-index.html
_static
l10n_script.sh
translated_po
-da
-16_sugar_ui.po
-en
-23_gnome.po
-si
-02_index.po
-03_about.po

'''translated_po''' directory will have the translated PO files in in the appropriate language directory (those PO files are from Pootle). Running the script,

./l10n_script.sh <language code>
example: ./l10n_script.sh en

After running the script it will create the '''help''' directory and modify the html files so as to share the same '''_images''' and '''_static''' content.

==== Update current help content ====

I have been updating the current help content, making them upto date with localization supporting screen capturing (label icons of the screen captures with numbers and refer and describe the icons below in text so that it can be localized). During the review process of submitting help content to Pootle, a lot of improvements with regard to the language are being done.

[https://git.sugarlabs.org/help-activity-content Gitorius repo - help activity content]

== To-do ==

* Write help for activities
* Update current help content for some Activities including FotoToon and Record

== How to contribute ==
Help content for Help Activity are written is rst. A comprehensive guide on how to write help is presented at http://wiki.laptop.org/go/Help_Activity_refresh/0.98#About_rst_format

You may refer to the rst files of existing help content at https://git.sugarlabs.org/help-activity-content/mainline/trees/master/source

Once you are completed, you can send a merge request to https://git.sugarlabs.org/help-activity-content or send Kalpa (me) or Gonzalo a mail along with the screen captures if there are any.
* Kalpa - callkalpa [AT] gmail.com
* Gonzalo - godiard [AT] sugarlabs.org

GSoC/2013/Activity Help

2013-08-31T03:33:11Z

Callkalpa: /* How to contribute */

GSoC/2013/Activity Help

2013-08-31T03:32:40Z

Callkalpa: /* How to contribute */ updated

== Introduction ==

This page contains information about the project [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard "Implement help mechanism for activities using Mallard"]. This project is being implemented as a GSoC 2013 project.

Although the initial proposal was to use Mallard for the help mechanism, the research done and the progress of the project proved that simply using the current help content would serve the purpose. Therefore with the approval of the mentors, the implementation with Mallard is dropped.

== Objectives ==

* Implement a help mechanism to view Help in the Activity
* Support l10n for help content
* Write help for more activities
* Improve current Help Activity

== Progress ==

==== View help for the Activity in the help itself ====

Help content for the current Activity can be viewed in the Activity itself. It will pop up in a window when the user enters the key combination '''ctrl+shift+h'''. If there is no help content for the Activity, an error message will be written to the log. I have used the '''bundle_id''' of the Activity to match it with the corresponding help content file (in html).

[https://github.com/callkalpa/sugar/tree/activity_help GitHub repo - Sugar fork]

<gallery>
File:Activity_help_browse.png|ActivityHelp in Browse
File:Activity_help_pippy.png|ActivityHelp in Pippy
</gallery>

==== Support help content localization ====

For the [https://git.sugarlabs.org/help-activity-content help content] I have generated the POT files using [http://sphinx-doc.org/intl.html sphinx internationalization tools]. The POT files are submitted to [http://translate.sugarlabs.org/projects/help_content/ help_content] project in Pootle with the emmense support of Chris. The help content is being translated.

<gallery>
File:ActivityHelp_Read_in_Sinhala.png|Read Activity help in Sinhala
File:About_OLPC_in_Danish.png|About OLPC help in Danish
</gallery>

==== Update Help Activity ====

Help Activity was improved to so as to support localized help content. Before localization content is supported, Help Activity was released with the help content in the form of html files, static content including images, css, javascript etc. With localized help content, there will be one set of static content and different html files for each and every language that help content is localized into. I have done mainly two modifications.

[https://git.sugarlabs.org/~callkalpa/help/callkalpa-help/commits/activity_help Gitorious repo - Help Activity fork]

===== helplink file =====

helplink is a json file. It includes the '''bundle_id''' of the Activity and the name of the corresponding help content (html) file. This file will be used when viewing help content in the Activity. Following is the current version of helplink.json.

{
"org.laptop.sugar.ReadActivity": "read.html",
"org.laptop.WebActivity": "browse.html",
"org.laptop.Chat": "chat.html",
"org.laptop.Calculate": "calculate.html",
"org.eq.FotoToon": "fototoon.html",
"org.laptop.RecordActivity": "record.html",
"org.laptop.MeasureActivity": "measure.html",
"org.laptop.Oficina": "paint.html",
"org.sugarlabs.PortfolioActivity": "portfolio.html",
"org.laptop.Memorize": "memorize.html",
"org.laptop.Terminal": "terminal.html",
"org.laptop.AbiWordActivity": "write.html",
"org.laptop.TurtleArtActivity": "turtleart.html",
"org.laptop.Pippy": "pippy.html",
"org.laptop.TamTamMini": "tamtammini.html"
}

===== directory structure modification =====

To support localized content I had to change the directory structure of the help directory of the Help Activity. Following is the directory structure before,

help
-_images
-_static
-*.html (help content)

new directory structure (with localization support) - only localization of English and Sinhala are shown as en example
help
-_images
-_static
-en
-*.html (help content in English)
-si
-*.html (help content in Sinhala)

===== l10n_script.sh =====

l10n_script.sh is a bash script develop to ease the process of bundling all localized help content to be shipped with Help Activity. In Help Activity, all the help content are in '''help''' directory. This script will generate the localized html content and place them in '''help''' directory with the proper directory structure. In releasing a new version of Help Activity, the maintainer can simply copy the '''help''' directory to the Help Activity directory, bundle it and ship.

Following is a snap of the directory structure associated with the script

help
-da
-about.html
-sugar_ui.html
-en
-about.html
-gnome.html
_images
-si
-about.html
-index.html
_static
l10n_script.sh
translated_po
-da
-16_sugar_ui.po
-en
-23_gnome.po
-si
-02_index.po
-03_about.po

'''translated_po''' directory will have the translated PO files in in the appropriate language directory (those PO files are from Pootle). Running the script,

./l10n_script.sh <language code>
example: ./l10n_script.sh en

After running the script it will create the '''help''' directory and modify the html files so as to share the same '''_images''' and '''_static''' content.

==== Update current help content ====

I have been updating the current help content, making them upto date with localization supporting screen capturing (label icons of the screen captures with numbers and refer and describe the icons below in text so that it can be localized). During the review process of submitting help content to Pootle, a lot of improvements with regard to the language are being done.

[https://git.sugarlabs.org/help-activity-content Gitorius repo - help activity content]

== To-do ==

* Write help for activities
* Update current help content for some Activities including FotoToon and Record

== How to contribute ==
Help content for Help Activity are written is rst. A comprehensive guide on how to write help is presented at http://wiki.laptop.org/go/Help_Activity_refresh/0.98#About_rst_format

You may refer to the rst files of existing help content at https://git.sugarlabs.org/help-activity-content/mainline/trees/master/source

Once you are completed, you can send a merge request to https://git.sugarlabs.org/help-activity-content or send Kalpa (me) or Gonzalo a mail along with the screen captures if there are any.
Kalpa - callkalpa@gmail.com
Gonzalo - godiard@sugarlabs.org

GSoC/2013/Activity Help

2013-08-31T03:24:48Z

Callkalpa: How to contribute

GSoC/2013/Activity Help

2013-08-31T03:23:52Z

Callkalpa: /* l10n_script.sh */ l10n_script.sh updated

GSoC/2013/Activity Help

2013-08-31T03:10:46Z

Callkalpa: /* Progress */ l10n_script.sh

== Introduction ==

This page contains information about the project [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard "Implement help mechanism for activities using Mallard"]. This project is being implemented as a GSoC 2013 project.

Although the initial proposal was to use Mallard for the help mechanism, the research done and the progress of the project proved that simply using the current help content would serve the purpose. Therefore with the approval of the mentors, the implementation with Mallard is dropped.

== Objectives ==

* Implement a help mechanism to view Help in the Activity
* Support l10n for help content
* Write help for more activities
* Improve current Help Activity

== Progress ==

==== View help for the Activity in the help itself ====

Help content for the current Activity can be viewed in the Activity itself. It will pop up in a window when the user enters the key combination '''ctrl+shift+h'''. If there is no help content for the Activity, an error message will be written to the log. I have used the '''bundle_id''' of the Activity to match it with the corresponding help content file (in html).

[https://github.com/callkalpa/sugar/tree/activity_help GitHub repo - Sugar fork]

<gallery>
File:Activity_help_browse.png|ActivityHelp in Browse
File:Activity_help_pippy.png|ActivityHelp in Pippy
</gallery>

==== Support help content localization ====

For the [https://git.sugarlabs.org/help-activity-content help content] I have generated the POT files using [http://sphinx-doc.org/intl.html sphinx internationalization tools]. The POT files are submitted to [http://translate.sugarlabs.org/projects/help_content/ help_content] project in Pootle with the emmense support of Chris. The help content is being translated.

<gallery>
File:ActivityHelp_Read_in_Sinhala.png|Read Activity help in Sinhala
File:About_OLPC_in_Danish.png|About OLPC help in Danish
</gallery>

==== Update Help Activity ====

Help Activity was improved to so as to support localized help content. Before localization content is supported, Help Activity was released with the help content in the form of html files, static content including images, css, javascript etc. With localized help content, there will be one set of static content and different html files for each and every language that help content is localized into. I have done mainly two modifications.

[https://git.sugarlabs.org/~callkalpa/help/callkalpa-help/commits/activity_help Gitorious repo - Help Activity fork]

===== helplink file =====

helplink is a json file. It includes the '''bundle_id''' of the Activity and the name of the corresponding help content (html) file. This file will be used when viewing help content in the Activity. Following is the current version of helplink.json.

{
"org.laptop.sugar.ReadActivity": "read.html",
"org.laptop.WebActivity": "browse.html",
"org.laptop.Chat": "chat.html",
"org.laptop.Calculate": "calculate.html",
"org.eq.FotoToon": "fototoon.html",
"org.laptop.RecordActivity": "record.html",
"org.laptop.MeasureActivity": "measure.html",
"org.laptop.Oficina": "paint.html",
"org.sugarlabs.PortfolioActivity": "portfolio.html",
"org.laptop.Memorize": "memorize.html",
"org.laptop.Terminal": "terminal.html",
"org.laptop.AbiWordActivity": "write.html",
"org.laptop.TurtleArtActivity": "turtleart.html",
"org.laptop.Pippy": "pippy.html",
"org.laptop.TamTamMini": "tamtammini.html"
}

===== directory structure modification =====

To support localized content I had to change the directory structure of the help directory of the Help Activity. Following is the directory structure before,

help
-_images
-_static
-*.html (help content)

new directory structure (with localization support) - only localization of English and Sinhala are shown as en example
help
-_images
-_static
-en
-*.html (help content in English)
-si
-*.html (help content in Sinhala)

===== l10n_script.sh =====

l10n_script.sh is a bash script develop to ease the process of bundling all localized help content to be shipped with Help Activity. In Help Activity, all the help content are in '''help''' directory. This script will generate the localized html content and place them in '''help''' directory with the proper directory structure. In releasing a new version of Help Activity, the maintainer can simply copy the '''help''' directory to the Help Activity directory, bundle it and ship.

Following is a snap of the directory structure associated with the script

help
l10n_script.sh
translated_po
-si
-02_index.po
-03_about.po
-da
-16_sugar_ui.po
-en
-23_gnome.po

==== Update current help content ====

I have been updating the current help content, making them upto date with localization supporting screen capturing (label icons of the screen captures with numbers and refer and describe the icons below in text so that it can be localized). During the review process of submitting help content to Pootle, a lot of improvements with regard to the language are being done.

[https://git.sugarlabs.org/help-activity-content Gitorius repo - help activity content]

== To-do ==

* Write help for activities
* Update current help content for some Activities including FotoToon and Record

GSoC/2013/Activity Help

2013-08-31T02:58:30Z

Callkalpa: /* Support help content localization */ added About OLPC help in Danish

== Introduction ==

This page contains information about the project [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard "Implement help mechanism for activities using Mallard"]. This project is being implemented as a GSoC 2013 project.

Although the initial proposal was to use Mallard for the help mechanism, the research done and the progress of the project proved that simply using the current help content would serve the purpose. Therefore with the approval of the mentors, the implementation with Mallard is dropped.

== Objectives ==

* Implement a help mechanism to view Help in the Activity
* Support l10n for help content
* Write help for more activities
* Improve current Help Activity

== Progress ==

==== View help for the Activity in the help itself ====

Help content for the current Activity can be viewed in the Activity itself. It will pop up in a window when the user enters the key combination '''ctrl+shift+h'''. If there is no help content for the Activity, an error message will be written to the log. I have used the '''bundle_id''' of the Activity to match it with the corresponding help content file (in html).

[https://github.com/callkalpa/sugar/tree/activity_help GitHub repo - Sugar fork]

<gallery>
File:Activity_help_browse.png|ActivityHelp in Browse
File:Activity_help_pippy.png|ActivityHelp in Pippy
</gallery>

==== Support help content localization ====

For the [https://git.sugarlabs.org/help-activity-content help content] I have generated the POT files using [http://sphinx-doc.org/intl.html sphinx internationalization tools]. The POT files are submitted to [http://translate.sugarlabs.org/projects/help_content/ help_content] project in Pootle with the emmense support of Chris. The help content is being translated.

<gallery>
File:ActivityHelp_Read_in_Sinhala.png|Read Activity help in Sinhala
File:About_OLPC_in_Danish.png|About OLPC help in Danish
</gallery>

==== Update Help Activity ====

Help Activity was improved to so as to support localized help content. Before localization content is supported, Help Activity was released with the help content in the form of html files, static content including images, css, javascript etc. With localized help content, there will be one set of static content and different html files for each and every language that help content is localized into. I have done mainly two modifications.

[https://git.sugarlabs.org/~callkalpa/help/callkalpa-help/commits/activity_help Gitorious repo - Help Activity fork]

===== helplink file =====

helplink is a json file. It includes the '''bundle_id''' of the Activity and the name of the corresponding help content (html) file. This file will be used when viewing help content in the Activity. Following is the current version of helplink.json.

{
"org.laptop.sugar.ReadActivity": "read.html",
"org.laptop.WebActivity": "browse.html",
"org.laptop.Chat": "chat.html",
"org.laptop.Calculate": "calculate.html",
"org.eq.FotoToon": "fototoon.html",
"org.laptop.RecordActivity": "record.html",
"org.laptop.MeasureActivity": "measure.html",
"org.laptop.Oficina": "paint.html",
"org.sugarlabs.PortfolioActivity": "portfolio.html",
"org.laptop.Memorize": "memorize.html",
"org.laptop.Terminal": "terminal.html",
"org.laptop.AbiWordActivity": "write.html",
"org.laptop.TurtleArtActivity": "turtleart.html",
"org.laptop.Pippy": "pippy.html",
"org.laptop.TamTamMini": "tamtammini.html"
}

===== directory structure modification =====

To support localized content I had to change the directory structure of the help directory of the Help Activity. Following is the directory structure before,

help
-_images
-_static
-*.html (help content)

new directory structure (with localization support) - only localization of English and Sinhala are shown as en example
help
-_images
-_static
-en
-*.html (help content in English)
-si
-*.html (help content in Sinhala)

==== Update current help content ====

I have been updating the current help content, making them upto date with localization supporting screen capturing (label icons of the screen captures with numbers and refer and describe the icons below in text so that it can be localized). During the review process of submitting help content to Pootle, a lot of improvements with regard to the language are being done.

[https://git.sugarlabs.org/help-activity-content Gitorius repo - help activity content]

== To-do ==

* Write help for activities
* Update current help content for some Activities including FotoToon and Record

File:About OLPC in Danish.png

2013-08-31T02:57:57Z

Callkalpa: "About OLPC" help content in Danish

"About OLPC" help content in Danish

GSoC/2013/Activity Help

2013-08-24T16:25:24Z

Callkalpa: Update current help content

== Introduction ==

This page contains information about the project [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard "Implement help mechanism for activities using Mallard"]. This project is being implemented as a GSoC 2013 project.

Although the initial proposal was to use Mallard for the help mechanism, the research done and the progress of the project proved that simply using the current help content would serve the purpose. Therefore with the approval of the mentors, the implementation with Mallard is dropped.

== Objectives ==

* Implement a help mechanism to view Help in the Activity
* Support l10n for help content
* Write help for more activities
* Improve current Help Activity

== Progress ==

==== View help for the Activity in the help itself ====

Help content for the current Activity can be viewed in the Activity itself. It will pop up in a window when the user enters the key combination '''ctrl+shift+h'''. If there is no help content for the Activity, an error message will be written to the log. I have used the '''bundle_id''' of the Activity to match it with the corresponding help content file (in html).

[https://github.com/callkalpa/sugar/tree/activity_help GitHub repo - Sugar fork]

<gallery>
File:Activity_help_browse.png|ActivityHelp in Browse
File:Activity_help_pippy.png|ActivityHelp in Pippy
</gallery>

==== Support help content localization ====

For the [https://git.sugarlabs.org/help-activity-content help content] I have generated the POT files using [http://sphinx-doc.org/intl.html sphinx internationalization tools]. The POT files are submitted to [http://translate.sugarlabs.org/projects/help_content/ help_content] project in Pootle with the emmense support of Chris. The help content is being translated.

<gallery>
File:ActivityHelp_Read_in_Sinhala.png|Read Activity help in Sinhala
</gallery>

==== Update Help Activity ====

Help Activity was improved to so as to support localized help content. Before localization content is supported, Help Activity was released with the help content in the form of html files, static content including images, css, javascript etc. With localized help content, there will be one set of static content and different html files for each and every language that help content is localized into. I have done mainly two modifications.

[https://git.sugarlabs.org/~callkalpa/help/callkalpa-help/commits/activity_help Gitorious repo - Help Activity fork]

===== helplink file =====

helplink is a json file. It includes the '''bundle_id''' of the Activity and the name of the corresponding help content (html) file. This file will be used when viewing help content in the Activity. Following is the current version of helplink.json.

{
"org.laptop.sugar.ReadActivity": "read.html",
"org.laptop.WebActivity": "browse.html",
"org.laptop.Chat": "chat.html",
"org.laptop.Calculate": "calculate.html",
"org.eq.FotoToon": "fototoon.html",
"org.laptop.RecordActivity": "record.html",
"org.laptop.MeasureActivity": "measure.html",
"org.laptop.Oficina": "paint.html",
"org.sugarlabs.PortfolioActivity": "portfolio.html",
"org.laptop.Memorize": "memorize.html",
"org.laptop.Terminal": "terminal.html",
"org.laptop.AbiWordActivity": "write.html",
"org.laptop.TurtleArtActivity": "turtleart.html",
"org.laptop.Pippy": "pippy.html",
"org.laptop.TamTamMini": "tamtammini.html"
}

===== directory structure modification =====

To support localized content I had to change the directory structure of the help directory of the Help Activity. Following is the directory structure before,

help
-_images
-_static
-*.html (help content)

new directory structure (with localization support) - only localization of English and Sinhala are shown as en example
help
-_images
-_static
-en
-*.html (help content in English)
-si
-*.html (help content in Sinhala)

==== Update current help content ====

I have been updating the current help content, making them upto date with localization supporting screen capturing (label icons of the screen captures with numbers and refer and describe the icons below in text so that it can be localized). During the review process of submitting help content to Pootle, a lot of improvements with regard to the language are being done.

[https://git.sugarlabs.org/help-activity-content Gitorius repo - help activity content]

== To-do ==

* Write help for activities
* Update current help content for some Activities including FotoToon and Record

GSoC/2013/Activity Help

2013-08-24T16:10:24Z

Callkalpa: /* Introduction */

GSoC/2013/Activity Help

2013-08-24T16:09:15Z

Callkalpa: Read Help in Sinhala

== Introduction ==

This page presents the status of the project [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard "Implement help mechanism for activities using Mallard"]. This project is being implemented as a GSoC 2013 project.

Although the initial proposal was to use Mallard for the help mechanism, the research done and the progress of the project proved that simply using the current help content would serve the purpose. Therefore with the approval of the mentors, the implementation with Mallard is dropped.

== Objectives ==

* Implement a help mechanism to view Help in the Activity
* Support l10n for help content
* Write help for more activities
* Improve current help activity

== Progress ==

==== View help for the Activity in the help itself ====

Help content for the current Activity can be viewed in the Activity itself. It will pop up in a window when the user enters the key combination '''ctrl+shift+h'''. If there is no help content for the Activity, an error message will be written to the log. I have used the '''bundle_id''' of the Activity to match it with the corresponding help content file (in html).

[https://github.com/callkalpa/sugar/tree/activity_help GitHub repo]

<gallery>
File:Activity_help_browse.png|ActivityHelp in Browse
File:Activity_help_pippy.png|ActivityHelp in Pippy
</gallery>

==== Support help content localization ====

For the [https://git.sugarlabs.org/help-activity-content help content] I have generated the POT files using [http://sphinx-doc.org/intl.html sphinx internationalization tools]. The POT files are submitted to [http://translate.sugarlabs.org/projects/help_content/ help_content] project in Pootle with the emmense support of Chris. The help content is being translated.

<gallery>
File:ActivityHelp_Read_in_Sinhala.png|Read Activity help in Sinhala
</gallery>

==== Update Help activity ====

Help activity was improved to so as to support localized help content. Before localization content is supported, Help activity was released with the help content in the form of html files, static content including images, css, javascript etc. With localized help content, there will be one set of static content and different html files for each and every language that help content is localized into. I have done mainly two modifications.

===== helplink file =====

helplink is a json file. It includes the '''bundle_id''' of the Activity and the name of the corresponding help content (html) file. This file will be used when viewing help content in the Activity. Following is the current version of helplink.json.

{
"org.laptop.sugar.ReadActivity": "read.html",
"org.laptop.WebActivity": "browse.html",
"org.laptop.Chat": "chat.html",
"org.laptop.Calculate": "calculate.html",
"org.eq.FotoToon": "fototoon.html",
"org.laptop.RecordActivity": "record.html",
"org.laptop.MeasureActivity": "measure.html",
"org.laptop.Oficina": "paint.html",
"org.sugarlabs.PortfolioActivity": "portfolio.html",
"org.laptop.Memorize": "memorize.html",
"org.laptop.Terminal": "terminal.html",
"org.laptop.AbiWordActivity": "write.html",
"org.laptop.TurtleArtActivity": "turtleart.html",
"org.laptop.Pippy": "pippy.html",
"org.laptop.TamTamMini": "tamtammini.html"
}

===== directory structure modification =====

==== Update current help content ====

* Implemented a Gtk window to view help in the activity
* Help file matching with the respective activity is done
* Studied the internationalization process with sphinx (http://sphinx-doc.org/intl.html)
* Was successful in i18n with sphinx
* Update current help content (Work in progress: https://git.sugarlabs.org/~callkalpa/help-activity-content/callkalpas-mainline/commits/content_update)

== To-do ==

* Implement a mechanism to show help content based on the current language
* Send current help content to Pootle be translated
* Write help for activities

File:ActivityHelp Read in Sinhala.png

2013-08-24T16:07:57Z

Callkalpa: Read Activity help in Sinhala language

Read Activity help in Sinhala language

GSoC/2013/Activity Help

2013-08-24T16:04:43Z

Callkalpa: helplink.json

== Introduction ==

This page presents the status of the project [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard "Implement help mechanism for activities using Mallard"]. This project is being implemented as a GSoC 2013 project.

Although the initial proposal was to use Mallard for the help mechanism, the research done and the progress of the project proved that simply using the current help content would serve the purpose. Therefore with the approval of the mentors, the implementation with Mallard is dropped.

== Objectives ==

* Implement a help mechanism to view Help in the Activity
* Support l10n for help content
* Write help for more activities
* Improve current help activity

== Progress ==

==== View help for the Activity in the help itself ====

Help content for the current Activity can be viewed in the Activity itself. It will pop up in a window when the user enters the key combination '''ctrl+shift+h'''. If there is no help content for the Activity, an error message will be written to the log. I have used the '''bundle_id''' of the Activity to match it with the corresponding help content file (in html).

[https://github.com/callkalpa/sugar/tree/activity_help GitHub repo]

<gallery>
File:Activity_help_browse.png|ActivityHelp in Browse
File:Activity_help_pippy.png|ActivityHelp in Pippy
</gallery>

==== Support help content localization ====

For the [https://git.sugarlabs.org/help-activity-content help content] I have generated the POT files using [http://sphinx-doc.org/intl.html sphinx internationalization tools]. The POT files are submitted to [http://translate.sugarlabs.org/projects/help_content/ help_content] project in Pootle with the emmense support of Chris. The help content is being translated.

==== Update Help activity ====

Help activity was improved to so as to support localized help content. Before localization content is supported, Help activity was released with the help content in the form of html files, static content including images, css, javascript etc. With localized help content, there will be one set of static content and different html files for each and every language that help content is localized into. I have done mainly two modifications.

===== helplink file =====

helplink is a json file. It includes the '''bundle_id''' of the Activity and the name of the corresponding help content (html) file. This file will be used when viewing help content in the Activity. Following is the current version of helplink.json.

{
"org.laptop.sugar.ReadActivity": "read.html",
"org.laptop.WebActivity": "browse.html",
"org.laptop.Chat": "chat.html",
"org.laptop.Calculate": "calculate.html",
"org.eq.FotoToon": "fototoon.html",
"org.laptop.RecordActivity": "record.html",
"org.laptop.MeasureActivity": "measure.html",
"org.laptop.Oficina": "paint.html",
"org.sugarlabs.PortfolioActivity": "portfolio.html",
"org.laptop.Memorize": "memorize.html",
"org.laptop.Terminal": "terminal.html",
"org.laptop.AbiWordActivity": "write.html",
"org.laptop.TurtleArtActivity": "turtleart.html",
"org.laptop.Pippy": "pippy.html",
"org.laptop.TamTamMini": "tamtammini.html"
}

===== directory structure modification =====

==== Update current help content ====

* Implemented a Gtk window to view help in the activity
* Help file matching with the respective activity is done
* Studied the internationalization process with sphinx (http://sphinx-doc.org/intl.html)
* Was successful in i18n with sphinx
* Update current help content (Work in progress: https://git.sugarlabs.org/~callkalpa/help-activity-content/callkalpas-mainline/commits/content_update)

== To-do ==

* Implement a mechanism to show help content based on the current language
* Send current help content to Pootle be translated
* Write help for activities

GSoC/2013/Activity Help

2013-08-24T15:48:37Z

Callkalpa: /* Progress */ support for help content localization updated

GSoC/2013/Activity Help

2013-08-24T15:44:14Z

Callkalpa: Updated screen captures for ActivityHelp

File:Activity help pippy.png

2013-08-24T15:39:32Z

Callkalpa: ActivityHelp in Pippy

ActivityHelp in Pippy

File:Activity help browse.png

2013-08-24T15:29:36Z

Callkalpa: Help content display in Browse Activity

Help content display in Browse Activity

GSoC/2013/Activity Help

2013-07-25T12:49:35Z

Callkalpa:

GSoC/2013/Activity Help

2013-07-22T17:06:33Z

Callkalpa:

GSoC/2013/Activity Help

2013-07-15T07:01:48Z

Callkalpa:

GSoC/2013/Activity Help

2013-07-15T06:58:55Z

Callkalpa: /* Work so far */

GSoC/2013/MallardHelp

2013-07-10T18:19:36Z

Callkalpa:

''' It was found that the objectives of the project can be achieved through the current help mechanism. Therefore Mallard was abandoned and more info on the current project is at http://wiki.sugarlabs.org/go/GSoC/2013/ActivityHelp '''

==Introduction==

This page presents the status of the project "Implement help mechanism for activities using Mallard" <ref>Implement help mechanism for activities using Mallard [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard]</ref>. This project is being implemented as a GSoC 2013 project.

Following is a representation of the desired process.

[[Image:MallardHelpStructure.png]]

In the current help system, the source docs are only of rst. This projects expands it to be either rst, markdown or html. Ultimately the doc will be converted to html using pandoc before converting to Mallard. Mallard is a topic oriented help documentation system. The help for each activity will be displayed in a pop up window (similar to view source) once the shortcut key is pressed.

The help maintainer is to take care of the process upto generating the final html file. The final html file will only be shipped with sugar so as to avoid any additional dependencies and to avoid any slowness. To display the help, a new Gtk Window will be implemented and shipped with sugar core. The help maintainer will be using pandoc, html to mallard script and yelp's xslt conversion before he commit the final html file.

==Work so far==

* Help content<ref>Help content of the Help activity [https://git.sugarlabs.org/help-activity-content]</ref> of the Help activity which is in rst has been converted to Markdown. The conversion was done using pandoc<ref>pandoc [http://johnmacfarlane.net/pandoc/]</ref>. The Markdown files are push at a fork<ref>Markdown files of the current help content [https://git.sugarlabs.org/~callkalpa/help-activity-content/callkalpa-help-activity-content]</ref> of the help-activity-content. (This is not relevant anymore since we are using html as the final file format before Mallard conversion)

* A python script<ref>HTML to mallard conversion script [https://git.sugarlabs.org/mallardhelp/mallardhelp]</ref> to convert from html to mallard is being developed.

* A Gtk Window is implemented with WebKit to display the help for each activity. The shortcut key is [Alt][Shift]h

==To-do==

* Develop a script to convert html source files to Mallard
** This is being developed already. I'll be adding more tags as I come across them
* Display the relevant help file in the activity (map help file with their relevant activity)
* Lokalization of help content
* Write help for activities for which help is not there yet

==Reference==
<references />

GSoC/2013/Activity Help

2013-07-10T18:11:32Z

Callkalpa: Created page with "== Introduction == This page presents the status of the project [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard "Imple..."

Summer of Code/2013

2013-07-10T17:48:05Z

Callkalpa: /* Implement help mechanism for activities using Mallard */

[[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, ...).

''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 KS

Wiki: http://wiki.sugarlabs.org/go/HTML5_activities

=== 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: [[User:Rahul Gaur ]]

Wiki: http://wiki.sugarlabs.org/go/Summer_of_Code/2013/moksaya

=== 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/ActivityHelp

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: http://wiki.sugarlabs.org/go/Summer_of_Code/2013/Social_Sugar_project

== Sugar Activities ==

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

[[File:TurtleArt.svg]] [[File:Pippy.svg]]

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: [[Summer of Code/2013/Turtle Blocks Python export project]]

=== 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: [http://wiki.sugarlabs.org/go/Summer_of_Code/2013/Open_Video_Chat GSoC 2013 Open Video Chat]

== Infrastructure ==

=== Translation Server ===

This project aims to create a server/client setup to establish a consistent way of translating arbitrary text using several different machine translation backends. It provides a single interface to many different translation services, simplifying the process of adding reliable machine translation to Sugar activities.

'''Wiki''': [http://wiki.sugarlabs.org/go/Summer_of_Code/2013/Translation_Server]

'''Student''': Erik Price

'''Mentors''': [[User:Aneesh Dogra]] [[User:Walter]]

'''Source''': [https://github.com/boredomist/translate]

'''Bug tracker''': [https://github.com/boredomist/translate/issues?state=open]

GSoC/2013/MallardHelp

2013-07-08T13:15:53Z

Callkalpa: /* To-do */

==Introduction==

This page presents the status of the project "Implement help mechanism for activities using Mallard" <ref>Implement help mechanism for activities using Mallard [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard]</ref>. This project is being implemented as a GSoC 2013 project.

Following is a representation of the desired process.

[[Image:MallardHelpStructure.png]]

In the current help system, the source docs are only of rst. This projects expands it to be either rst, markdown or html. Ultimately the doc will be converted to html using pandoc before converting to Mallard. Mallard is a topic oriented help documentation system. The help for each activity will be displayed in a pop up window (similar to view source) once the shortcut key is pressed.

The help maintainer is to take care of the process upto generating the final html file. The final html file will only be shipped with sugar so as to avoid any additional dependencies and to avoid any slowness. To display the help, a new Gtk Window will be implemented and shipped with sugar core. The help maintainer will be using pandoc, html to mallard script and yelp's xslt conversion before he commit the final html file.

==Work so far==

* Help content<ref>Help content of the Help activity [https://git.sugarlabs.org/help-activity-content]</ref> of the Help activity which is in rst has been converted to Markdown. The conversion was done using pandoc<ref>pandoc [http://johnmacfarlane.net/pandoc/]</ref>. The Markdown files are push at a fork<ref>Markdown files of the current help content [https://git.sugarlabs.org/~callkalpa/help-activity-content/callkalpa-help-activity-content]</ref> of the help-activity-content. (This is not relevant anymore since we are using html as the final file format before Mallard conversion)

* A python script<ref>HTML to mallard conversion script [https://git.sugarlabs.org/mallardhelp/mallardhelp]</ref> to convert from html to mallard is being developed.

* A Gtk Window is implemented with WebKit to display the help for each activity. The shortcut key is [Alt][Shift]h

==To-do==

* Develop a script to convert html source files to Mallard
** This is being developed already. I'll be adding more tags as I come across them
* Display the relevant help file in the activity (map help file with their relevant activity)
* Lokalization of help content
* Write help for activities for which help is not there yet

==Reference==
<references />

GSoC/2013/MallardHelp

2013-07-08T13:11:09Z

Callkalpa: /* Work so far */

==Introduction==

This page presents the status of the project "Implement help mechanism for activities using Mallard" <ref>Implement help mechanism for activities using Mallard [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard]</ref>. This project is being implemented as a GSoC 2013 project.

Following is a representation of the desired process.

[[Image:MallardHelpStructure.png]]

In the current help system, the source docs are only of rst. This projects expands it to be either rst, markdown or html. Ultimately the doc will be converted to html using pandoc before converting to Mallard. Mallard is a topic oriented help documentation system. The help for each activity will be displayed in a pop up window (similar to view source) once the shortcut key is pressed.

The help maintainer is to take care of the process upto generating the final html file. The final html file will only be shipped with sugar so as to avoid any additional dependencies and to avoid any slowness. To display the help, a new Gtk Window will be implemented and shipped with sugar core. The help maintainer will be using pandoc, html to mallard script and yelp's xslt conversion before he commit the final html file.

==Work so far==

* Help content<ref>Help content of the Help activity [https://git.sugarlabs.org/help-activity-content]</ref> of the Help activity which is in rst has been converted to Markdown. The conversion was done using pandoc<ref>pandoc [http://johnmacfarlane.net/pandoc/]</ref>. The Markdown files are push at a fork<ref>Markdown files of the current help content [https://git.sugarlabs.org/~callkalpa/help-activity-content/callkalpa-help-activity-content]</ref> of the help-activity-content. (This is not relevant anymore since we are using html as the final file format before Mallard conversion)

* A python script<ref>HTML to mallard conversion script [https://git.sugarlabs.org/mallardhelp/mallardhelp]</ref> to convert from html to mallard is being developed.

* A Gtk Window is implemented with WebKit to display the help for each activity. The shortcut key is [Alt][Shift]h

==To-do==

* Develop a script to convert Markdown source files to Mallard
** Up to now the current plan is to use html as an intermediate format. It will be easy to convert markdown or rst to html, it is straight forward with pandoc. Next a xml parser will be used and the mallard file will be written. At the moment I am reading about xml parsing in python.
* Implement a mechanism to show help in each activity
* Extract strings from the help docs and feed them to pootle for l10n
* Write help for activities for which help is not there yet

==Reference==
<references />

GSoC/2013/MallardHelp

2013-07-08T13:09:41Z

Callkalpa: /* Introduction */

==Introduction==

This page presents the status of the project "Implement help mechanism for activities using Mallard" <ref>Implement help mechanism for activities using Mallard [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard]</ref>. This project is being implemented as a GSoC 2013 project.

Following is a representation of the desired process.

[[Image:MallardHelpStructure.png]]

In the current help system, the source docs are only of rst. This projects expands it to be either rst, markdown or html. Ultimately the doc will be converted to html using pandoc before converting to Mallard. Mallard is a topic oriented help documentation system. The help for each activity will be displayed in a pop up window (similar to view source) once the shortcut key is pressed.

The help maintainer is to take care of the process upto generating the final html file. The final html file will only be shipped with sugar so as to avoid any additional dependencies and to avoid any slowness. To display the help, a new Gtk Window will be implemented and shipped with sugar core. The help maintainer will be using pandoc, html to mallard script and yelp's xslt conversion before he commit the final html file.

==Work so far==

* Help content<ref>Help content of the Help activity [https://git.sugarlabs.org/help-activity-content]</ref> of the Help activity which is in rst has been converted to Markdown. The conversion was done using pandoc<ref>pandoc [http://johnmacfarlane.net/pandoc/]</ref>. The Markdown files are push at a fork<ref>Markdown files of the current help content [https://git.sugarlabs.org/~callkalpa/help-activity-content/callkalpa-help-activity-content]</ref> of the help-activity-content.

* A python script<ref>HTML to mallard conversion script [https://git.sugarlabs.org/mallardhelp/mallardhelp]</ref> to convert from html to mallard is being developed.

* A Gtk Window is implemented with WebKit to display the help for each activity. The shortcut key is [Alt][Shift]h

==To-do==

* Develop a script to convert Markdown source files to Mallard
** Up to now the current plan is to use html as an intermediate format. It will be easy to convert markdown or rst to html, it is straight forward with pandoc. Next a xml parser will be used and the mallard file will be written. At the moment I am reading about xml parsing in python.
* Implement a mechanism to show help in each activity
* Extract strings from the help docs and feed them to pootle for l10n
* Write help for activities for which help is not there yet

==Reference==
<references />

GSoC/2013/MallardHelp

2013-07-08T12:25:59Z

Callkalpa: /* Work so far */ ViewHelp window implemented

==Introduction==

This page presents the status of the project "Implement help mechanism for activities using Mallard" <ref>Implement help mechanism for activities using Mallard [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard]</ref>. This project is being implemented as a GSoC 2013 project.

Following is a representation of the desired process.

[[Image:MallardHelpStructure.png]]

In the current help system, the source docs are only of rst. This projects expands it to be either rst, markdown or html. Ultimately the doc will be converted to html using pandoc before converting to Mallard. Mallard is a topic oriented help documentation system. The help for each activity will be displayed in a pop up window (just as view source) once the shortcut key is pressed.

==Work so far==

* Help content<ref>Help content of the Help activity [https://git.sugarlabs.org/help-activity-content]</ref> of the Help activity which is in rst has been converted to Markdown. The conversion was done using pandoc<ref>pandoc [http://johnmacfarlane.net/pandoc/]</ref>. The Markdown files are push at a fork<ref>Markdown files of the current help content [https://git.sugarlabs.org/~callkalpa/help-activity-content/callkalpa-help-activity-content]</ref> of the help-activity-content.

* A python script<ref>HTML to mallard conversion script [https://git.sugarlabs.org/mallardhelp/mallardhelp]</ref> to convert from html to mallard is being developed.

* A Gtk Window is implemented with WebKit to display the help for each activity. The shortcut key is [Alt][Shift]h

==To-do==

* Develop a script to convert Markdown source files to Mallard
** Up to now the current plan is to use html as an intermediate format. It will be easy to convert markdown or rst to html, it is straight forward with pandoc. Next a xml parser will be used and the mallard file will be written. At the moment I am reading about xml parsing in python.
* Implement a mechanism to show help in each activity
* Extract strings from the help docs and feed them to pootle for l10n
* Write help for activities for which help is not there yet

==Reference==
<references />

GSoC/2013/MallardHelp

2013-07-08T12:23:42Z

Callkalpa: /* Introduction */ process image and description added

==Introduction==

This page presents the status of the project "Implement help mechanism for activities using Mallard" <ref>Implement help mechanism for activities using Mallard [http://wiki.sugarlabs.org/go/Summer_of_Code/2013#Implement_help_mechanism_for_activities_using_Mallard]</ref>. This project is being implemented as a GSoC 2013 project.

Following is a representation of the desired process.

[[Image:MallardHelpStructure.png]]

In the current help system, the source docs are only of rst. This projects expands it to be either rst, markdown or html. Ultimately the doc will be converted to html using pandoc before converting to Mallard. Mallard is a topic oriented help documentation system. The help for each activity will be displayed in a pop up window (just as view source) once the shortcut key is pressed.

==Work so far==

* Help content<ref>Help content of the Help activity [https://git.sugarlabs.org/help-activity-content]</ref> of the Help activity which is in rst has been converted to Markdown. The conversion was done using pandoc<ref>pandoc [http://johnmacfarlane.net/pandoc/]</ref>. The Markdown files are push at a fork<ref>Markdown files of the current help content [https://git.sugarlabs.org/~callkalpa/help-activity-content/callkalpa-help-activity-content]</ref> of the help-activity-content.

* A python script<ref>HTML to mallard conversion script [https://git.sugarlabs.org/mallardhelp/mallardhelp]</ref> to convert from html to mallard is being developed.

==To-do==

* Develop a script to convert Markdown source files to Mallard
** Up to now the current plan is to use html as an intermediate format. It will be easy to convert markdown or rst to html, it is straight forward with pandoc. Next a xml parser will be used and the mallard file will be written. At the moment I am reading about xml parsing in python.
* Implement a mechanism to show help in each activity
* Extract strings from the help docs and feed them to pootle for l10n
* Write help for activities for which help is not there yet

==Reference==
<references />

File:MallardHelpStructure.png

2013-07-08T12:07:00Z

Callkalpa: Proposed mechanism to implement Mallard Help as a GSoC 2013 project

Proposed mechanism to implement Mallard Help as a GSoC 2013 project

GSoC/2013/MallardHelp

2013-06-21T16:41:38Z

Callkalpa: /* Work so far */

GSoC/2013/MallardHelp

2013-06-13T15:05:25Z

Callkalpa:

GSoC/2013/MallardHelp

2013-06-10T14:20:56Z

Callkalpa: Initiation of the page

Summer of Code/2012/autorpmgen

2012-02-17T05:07:43Z

Callkalpa: /* You and the community */

<noinclude>{{TOCright}}
[[Category:2012 GSoC applications]]
[[Category:GSoC]]
</noinclude>

== About You ==
#What is your name? Kalpa Pathum Welivitigoda
#What is your email address? callkalpa@gmail.com
#What is your Sugar Labs wiki username? [[User:Callkalpa|Callkalpa]]
#What is your IRC nickname? callkalpa
#What is your primary language? English
#Where are you located, and what hours do you tend to work? I am located in Sri Lanka (GMT + 0530h), work hours can be varied as required and willing to work at night as well.
#Have you participated in an open-source project before?
#* http://fedoraproject.org/wiki/User:Callkalpa
#* http://wiki.sugarlabs.org/go/User:Callkalpa
#* http://openhatch.org/people/callkalpa/

== About your project ==
#What is the name of your project? autorpmgen
#Describe your project in 10-20 sentences. What are you making? Who are you making it for, and why do they need it? What technologies (programming languages, etc.) will you be using?
#*I am going to make a tool which will automatically build the rpm packages for the existing sugar activities. It builds new rpms as new activities are submitted or new updates are issued for existing activities. And there will be a separate repo established for those rpms.
#*At the time of writing there are almost 400 sugar activities. Projects like sugar on a stick have widen the community for these activities (like they can be used by Fedora users as well). Still that is possible only for the packages that are packaged for Fedora (making the rpm, going through the review process and all that). What I am trying to do is spread it even more. People who want to use activities on their Fedora box will just add the repo and install them. There's no need for them to be approved for Fedora repo. This is true for any other rpm based distro. Further there is no need of maintainers who need to follow the development and build new rpms. (Currently there are packaged activities for Fedora where there are no further rpm issues due to lack of maintainers). It is even better to extend this to other package managing systems as well like deb. But I have no experience with that at the time of writing so I will for now just stick to rpm.
#*The idea is to maintain a ini file like file for each activity and generate the spec file out from that and finally generate the rpm. There is [http://wiki.meego.com/Spectacle Spectacle], a tool to generate spec out of a ini file and [http://rm-rf.ca/tito Tito] which can be used to build rpm from the spec file.
#What is the timeline for development of your project? The Summer of Code work period is 7 weeks long, May 23 - August 10; tell us what you will be working on each week.
#* 1st and 2nd week : Generate ini file (details extracted from the activity.info file in each activity and from other sources related)
#* 3rd week : generate spec file from the ini file
#* 4th and 5th week : generate rpm from the spec
#* 6th week : establish a repo for the rpms
#* 7th week : implement the new activity submission and update submission feature
#* ''Here I have outlined my schedule only for coding. Evaluations will be there and the schedule is subjected to undergo changes as necessary. For generating the ini file and rpm, I have allocated two weeks each and this is with a safety time margin. I don't think they will take that long to implement.''
#Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant.
#*I've been packaging some of the sugar activities for Fedora which is directly related to the core of this proposal. I started with Ruler about 6 months ago with the guidance of [[User:pbrobinson|Peter Robinson]]. Since then I have been maintaining and co-maintaining around 10 packages associated with sugar activities. I am familiar with python and bash scripting as well.
#** Packages I maintain/co-maintain at Fedora: https://admin.fedoraproject.org/pkgdb/users/packages/callkalpa

== You and the community ==
1. If your project is successfully completed, what will its impact be on the Sugar Labs community? Give 3 answers, each 1-3 paragraphs in length. The first one should be yours. The other two should be answers from members of the Sugar Labs community, at least one of whom should be a Sugar Labs GSoC mentor. Provide email contact information for non-GSoC mentors.
:*autorpmgen will enable students who doesn't have a xo lap to experience ALL the sugar activities which are currently available on their rpm based distro box. Further it will be beneficial to projects like Sugar on a Stick which is based on Fedora. SoaS will also include more and more sugar activities in future of course will be beneficial to students who even doesn't have a rpm based distro box. They can just plug their USB stick and get the full experience. Activities will be exposed to a more wide community of students, teachers and developers which in turn will result in more and more feedback and ultimately the activities will get better and better and will more suit the needs. That is we are reaching more students with better quality products. --[[User:Callkalpa|Callkalpa]]
:*It is great to see so many Sugar activities being packaged... certainly will make life easier for the maintainers and those pulling together distros. I question the assertion that this will help nonSugar users without an accompanying effort to add the glue to launch Sugar activities outside of Sugar. A number of activities, e.g., Turtle Art, support this, but it is atypical. Perhaps a modeule that can get distributed with the RPMs that detects whether or not the Sugar environment is available and added replacement methods in the case it is not? We need to think this through. --[[User:Walter|Walter]] 11:41, 16 February 2012 (EST)

2. What will you do if you get stuck on your project and your mentor isn't around?
:*First of all I try myself and next I seek for help in other source such as mailing lists, irc (#sugar #fedora-devel on freenode) and past GSoCers of Sugar Labs. I firmly believe that always there will be some path where I can get the information I need.
3. How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?
:*It is mainly my [http://www.kalpapathum.blogspot.com| blog] that I intend to use as the medium to inform the rest of the world on my progress. About the problems and questions, I will be using the specific developer resources and mailing lists and irc as well.

== Miscellaneous ==
#We want to make sure that you can set up a development environment before the summer starts.
#* [http://callkalpa.fedorapeople.org/sugar-devel.png here is the link to the screenshot]
#What is your t-shirt size? (Yes, we know Google asks for this already; humor us.)
#* Medium
#Describe a great learning experience you had as a child.
#* I woudld like to mention about my entrance to the world of programming. I started with GWBASIC on those good old days and gradually improved through Visual Basic, python, C and java. I prefer to learn and explore things by myself and I am thankful to my parents for allowing me to do what I have an interest on. From childhood to this point, it was a great learning experience in terms of programming and other aspects as well. Even in the event of getting the sugar development environment work properly I came across some issues which I tried my self and blogged [http://kalpapathum.blogspot.com/2012/02/sugar-jhbuild-update-bundlemodule-has.html here]. It is always happy to follow trial and error method when there are no other possible alternatives visible or reachable.
#Is there anything else we should have asked you or anything else that we should know that might make us like you or your project more?
#* I have got a xo lap myself thanks to [[User:pbrobinson|pbrobinson]]

User:Callkalpa

2012-02-16T16:02:07Z

Callkalpa: added a short intro on my work with sugar

Hi I am Kalpa Welivitigoda from Sri Lanka. My work with sugar has been involved with packaging sugar activities for Fedora. The list is [https://admin.stg.fedoraproject.org/pkgdb/users/packages/callkalpa here].

User:Callkalpa

2012-02-16T15:53:58Z

Callkalpa:

Hi I am Kalpa Welivitigoda from Sri Lanka. My work with sugar has been to package sugar activities for Fedora.

Summer of Code/2012/autorpmgen

2012-02-16T15:50:16Z

Callkalpa: /* About You */

<noinclude>{{TOCright}}
[[Category:2012 GSoC applications]]
[[Category:GSoC]]
</noinclude>

== About You ==
#What is your name? Kalpa Pathum Welivitigoda
#What is your email address? callkalpa@gmail.com
#What is your Sugar Labs wiki username? [[User:Callkalpa|Callkalpa]]
#What is your IRC nickname? callkalpa
#What is your primary language? English
#Where are you located, and what hours do you tend to work? I am located in Sri Lanka (GMT + 0530h), work hours can be varied as required and willing to work at night as well.
#Have you participated in an open-source project before?
#* http://fedoraproject.org/wiki/User:Callkalpa
#* http://wiki.sugarlabs.org/go/User:Callkalpa
#* http://openhatch.org/people/callkalpa/

== About your project ==
#What is the name of your project? autorpmgen
#Describe your project in 10-20 sentences. What are you making? Who are you making it for, and why do they need it? What technologies (programming languages, etc.) will you be using?
#*I am going to make a tool which will automatically build the rpm packages for the existing sugar activities. It builds new rpms as new activities are submitted or new updates are issued for existing activities. And there will be a separate repo established for those rpms.
#*At the time of writing there are almost 400 sugar activities. Projects like sugar on a stick have widen the community for these activities (like they can be used by Fedora users as well). Still that is possible only for the packages that are packaged for Fedora (making the rpm, going through the review process and all that). What I am trying to do is spread it even more. People who want to use activities on their Fedora box will just add the repo and install them. There's no need for them to be approved for Fedora repo. This is true for any other rpm based distro. Further there is no need of maintainers who need to follow the development and build new rpms. (Currently there are packaged activities for Fedora where there are no further rpm issues due to lack of maintainers). It is even better to extend this to other package managing systems as well like deb. But I have no experience with that at the time of writing so I will for now just stick to rpm.
#*The idea is to maintain a ini file like file for each activity and generate the spec file out from that and finally generate the rpm. There is [http://wiki.meego.com/Spectacle Spectacle], a tool to generate spec out of a ini file and [http://rm-rf.ca/tito Tito] which can be used to build rpm from the spec file.
#What is the timeline for development of your project? The Summer of Code work period is 7 weeks long, May 23 - August 10; tell us what you will be working on each week.
#* 1st and 2nd week : Generate ini file (details extracted from the activity.info file in each activity and from other sources related)
#* 3rd week : generate spec file from the ini file
#* 4th and 5th week : generate rpm from the spec
#* 6th week : establish a repo for the rpms
#* 7th week : implement the new activity submission and update submission feature
#* ''Here I have outlined my schedule only for coding. Evaluations will be there and the schedule is subjected to undergo changes as necessary. For generating the ini file and rpm, I have allocated two weeks each and this is with a safety time margin. I don't think they will take that long to implement.''
#Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant.
#*I've been packaging some of the sugar activities for Fedora which is directly related to the core of this proposal. I started with Ruler about 6 months ago with the guidance of [[User:pbrobinson|Peter Robinson]]. Since then I have been maintaining and co-maintaining around 10 packages associated with sugar activities. I am familiar with python and bash scripting as well.
#** Packages I maintain/co-maintain at Fedora: https://admin.fedoraproject.org/pkgdb/users/packages/callkalpa

== You and the community ==
#If your project is successfully completed, what will its impact be on the Sugar Labs community? Give 3 answers, each 1-3 paragraphs in length. The first one should be yours. The other two should be answers from members of the Sugar Labs community, at least one of whom should be a Sugar Labs GSoC mentor. Provide email contact information for non-GSoC mentors.
#*autorpmgen will enable students who doesn't have a xo lap to experience ALL the sugar activities which are currently available on their rpm based distro box. Further it will be beneficial to projects like Sugar on a Stick which is based on Fedora. SoaS will also include more and more sugar activities in future of course will be beneficial to students who even doesn't have a rpm based distro box. They can just plug their USB stick and get the full experience. Activities will be exposed to a more wide community of students, teachers and developers which in turn will result in more and more feedback and ultimately the activities will get better and better and will more suit the needs. That is we are reaching more students with better quality products.
#What will you do if you get stuck on your project and your mentor isn't around?
#*First of all I try myself and next I seek for help in other source such as mailing lists, irc (#sugar #fedora-devel on freenode) and past GSoCers of Sugar Labs. I firmly believe that always there will be some path where I can get the information I need.
#How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?
#*It is mainly my [http://www.kalpapathum.blogspot.com| blog] that I intend to use as the medium to inform the rest of the world on my progress. About the problems and questions, I will be using the specific developer resources and mailing lists and irc as well.

== Miscellaneous ==
#We want to make sure that you can set up a development environment before the summer starts.
#* [http://callkalpa.fedorapeople.org/sugar-devel.png here is the link to the screenshot]
#What is your t-shirt size? (Yes, we know Google asks for this already; humor us.)
#* Medium
#Describe a great learning experience you had as a child.
#* I woudld like to mention about my entrance to the world of programming. I started with GWBASIC on those good old days and gradually improved through Visual Basic, python, C and java. I prefer to learn and explore things by myself and I am thankful to my parents for allowing me to do what I have an interest on. From childhood to this point, it was a great learning experience in terms of programming and other aspects as well. Even in the event of getting the sugar development environment work properly I came across some issues which I tried my self and blogged [http://kalpapathum.blogspot.com/2012/02/sugar-jhbuild-update-bundlemodule-has.html here]. It is always happy to follow trial and error method when there are no other possible alternatives visible or reachable.
#Is there anything else we should have asked you or anything else that we should know that might make us like you or your project more?
#* I have got a xo lap myself thanks to [[User:pbrobinson|pbrobinson]]

User:Callkalpa

2012-02-16T15:32:03Z

Callkalpa: Created page with "This is a sample page."

This is a sample page.

Development Team/Contacts

2012-02-16T15:31:16Z

Callkalpa: /* People */

<noinclude>{{GoogleTrans-en}}{{TeamHeader|Development Team|roadmap_link={{Upcoming Stable Release}}/Roadmap}}</noinclude>

== Coordinator ==
{{:Development Team/Coordinator}}

== IRC channel ==

Sugar developers hang out on irc.freenode.net, #sugar channel.

== People ==
* [[User:Erikos|Simon Schampijer]]
* [[User:Walter|Walter Bender]]
* [[User:svankiE|Horacio Bertorello]]
* [[User:Callkalpa|Kalpa Welivitigoda]]

[[Category:Development Team]]
[[Category:Contact]]

User:Kalpa Pathum Welivitigoda

2012-02-16T15:27:13Z

Callkalpa: Created page with "This is a sample page."

This is a sample page.

Summer of Code/2012/autorpmgen

2012-02-16T07:21:09Z

Callkalpa: /* Miscellaneous */

<noinclude>{{TOCright}}
[[Category:2012 GSoC applications]]
[[Category:GSoC]]
</noinclude>

== About You ==
#What is your name? Kalpa Pathum Welivitigoda
#What is your email address? callkalpa@gmail.com
#What is your Sugar Labs wiki username?
#What is your IRC nickname? callkalpa
#What is your primary language? English
#Where are you located, and what hours do you tend to work? I am located in Sri Lanka (GMT + 0530h), work hours can be varied as required and willing to work at night as well.
#Have you participated in an open-source project before?
#* http://fedoraproject.org/wiki/User:Callkalpa
#* http://openhatch.org/people/callkalpa/

== About your project ==
#What is the name of your project? autorpmgen
#Describe your project in 10-20 sentences. What are you making? Who are you making it for, and why do they need it? What technologies (programming languages, etc.) will you be using?
#*I am going to make a tool which will automatically build the rpm packages for the existing sugar activities. It builds new rpms as new activities are submitted or new updates are issued for existing activities. And there will be a separate repo established for those rpms.
#*At the time of writing there are almost 400 sugar activities. Projects like sugar on a stick have widen the community for these activities (like they can be used by Fedora users as well). Still that is possible only for the packages that are packaged for Fedora (making the rpm, going through the review process and all that). What I am trying to do is spread it even more. People who want to use activities on their Fedora box will just add the repo and install them. There's no need for them to be approved for Fedora repo. This is true for any other rpm based distro. Further there is no need of maintainers who need to follow the development and build new rpms. (Currently there are packaged activities for Fedora where there are no further rpm issues due to lack of maintainers). It is even better to extend this to other package managing systems as well like deb. But I have no experience with that at the time of writing so I will for now just stick to rpm.
#*The idea is to maintain a ini file like file for each activity and generate the spec file out from that and finally generate the rpm. There is [http://wiki.meego.com/Spectacle Spectacle], a tool to generate spec out of a ini file and [http://rm-rf.ca/tito Tito] which can be used to build rpm from the spec file.
#What is the timeline for development of your project? The Summer of Code work period is 7 weeks long, May 23 - August 10; tell us what you will be working on each week.
#* 1st and 2nd week : Generate ini file (details extracted from the activity.info file in each activity and from other sources related)
#* 3rd week : generate spec file from the ini file
#* 4th and 5th week : generate rpm from the spec
#* 6th week : establish a repo for the rpms
#* 7th week : implement the new activity submission and update submission feature
#* ''Here I have outlined my schedule only for coding. Evaluations will be there and the schedule is subjected to undergo changes as necessary. For generating the ini file and rpm, I have allocated two weeks each and this is with a safety time margin. I don't think they will take that long to implement.''
#Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant.
#*I've been packaging some of the sugar activities for Fedora which is directly related to the core of this proposal. I started with Ruler about 6 months ago with the guidance of [[User:pbrobinson|Peter Robinson]]. Since then I have been maintaining and co-maintaining around 10 packages associated with sugar activities. I am familiar with python and bash scripting as well.
#** Packages I maintain/co-maintain at Fedora: https://admin.fedoraproject.org/pkgdb/users/packages/callkalpa

== You and the community ==
#If your project is successfully completed, what will its impact be on the Sugar Labs community? Give 3 answers, each 1-3 paragraphs in length. The first one should be yours. The other two should be answers from members of the Sugar Labs community, at least one of whom should be a Sugar Labs GSoC mentor. Provide email contact information for non-GSoC mentors.
#*autorpmgen will enable students who doesn't have a xo lap to experience ALL the sugar activities which are currently available on their rpm based distro box. Further it will be beneficial to projects like Sugar on a Stick which is based on Fedora. SoaS will also include more and more sugar activities in future of course will be beneficial to students who even doesn't have a rpm based distro box. They can just plug their USB stick and get the full experience. Activities will be exposed to a more wide community of students, teachers and developers which in turn will result in more and more feedback and ultimately the activities will get better and better and will more suit the needs. That is we are reaching more students with better quality products.
#What will you do if you get stuck on your project and your mentor isn't around?
#*First of all I try myself and next I seek for help in other source such as mailing lists, irc (#sugar #fedora-devel on freenode) and past GSoCers of Sugar Labs. I firmly believe that always there will be some path where I can get the information I need.
#How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?
#*It is mainly my [http://www.kalpapathum.blogspot.com| blog] that I intend to use as the medium to inform the rest of the world on my progress. About the problems and questions, I will be using the specific developer resources and mailing lists and irc as well.

== Miscellaneous ==
#We want to make sure that you can set up a development environment before the summer starts.
#* [http://callkalpa.fedorapeople.org/sugar-devel.png here is the link to the screenshot]
#What is your t-shirt size? (Yes, we know Google asks for this already; humor us.)
#* Medium
#Describe a great learning experience you had as a child.
#* I woudld like to mention about my entrance to the world of programming. I started with GWBASIC on those good old days and gradually improved through Visual Basic, python, C and java. I prefer to learn and explore things by myself and I am thankful to my parents for allowing me to do what I have an interest on. From childhood to this point, it was a great learning experience in terms of programming and other aspects as well. Even in the event of getting the sugar development environment work properly I came across some issues which I tried my self and blogged [http://kalpapathum.blogspot.com/2012/02/sugar-jhbuild-update-bundlemodule-has.html here]. It is always happy to follow trial and error method when there are no other possible alternatives visible or reachable.
#Is there anything else we should have asked you or anything else that we should know that might make us like you or your project more?
#* I have got a xo lap myself thanks to [[User:pbrobinson|pbrobinson]]

Summer of Code/2012/autorpmgen

2012-02-10T04:42:53Z

Callkalpa: /* You and the community */

<noinclude>{{TOCright}}
[[Category:2012 GSoC applications]]
[[Category:GSoC]]
</noinclude>

== About You ==
#What is your name? Kalpa Pathum Welivitigoda
#What is your email address? callkalpa@gmail.com
#What is your Sugar Labs wiki username?
#What is your IRC nickname? callkalpa
#What is your primary language? English
#Where are you located, and what hours do you tend to work? I am located in Sri Lanka (GMT + 0530h), work hours can be varied as required and willing to work at night as well.
#Have you participated in an open-source project before?
#* http://fedoraproject.org/wiki/User:Callkalpa
#* http://openhatch.org/people/callkalpa/

== About your project ==
#What is the name of your project? autorpmgen
#Describe your project in 10-20 sentences. What are you making? Who are you making it for, and why do they need it? What technologies (programming languages, etc.) will you be using?
#*I am going to make a tool which will automatically build the rpm packages for the existing sugar activities. It builds new rpms as new activities are submitted or new updates are issued for existing activities. And there will be a separate repo established for those rpms.
#*At the time of writing there are almost 400 sugar activities. Projects like sugar on a stick have widen the community for these activities (like they can be used by Fedora users as well). Still that is possible only for the packages that are packaged for Fedora (making the rpm, going through the review process and all that). What I am trying to do is spread it even more. People who want to use activities on their Fedora box will just add the repo and install them. There's no need for them to be approved for Fedora repo. This is true for any other rpm based distro. Further there is no need of maintainers who need to follow the development and build new rpms. (Currently there are packaged activities for Fedora where there are no further rpm issues due to lack of maintainers). It is even better to extend this to other package managing systems as well like deb. But I have no experience with that at the time of writing so I will for now just stick to rpm.
#*The idea is to maintain a ini file like file for each activity and generate the spec file out from that and finally generate the rpm. There is [http://wiki.meego.com/Spectacle Spectacle], a tool to generate spec out of a ini file and [http://rm-rf.ca/tito Tito] which can be used to build rpm from the spec file.
#What is the timeline for development of your project? The Summer of Code work period is 7 weeks long, May 23 - August 10; tell us what you will be working on each week.
#* 1st and 2nd week : Generate ini file (details extracted from the activity.info file in each activity and from other sources related)
#* 3rd week : generate spec file from the ini file
#* 4th and 5th week : generate rpm from the spec
#* 6th week : establish a repo for the rpms
#* 7th week : implement the new activity submission and update submission feature
#* ''Here I have outlined my schedule only for coding. Evaluations will be there and the schedule is subjected to undergo changes as necessary. For generating the ini file and rpm, I have allocated two weeks each and this is with a safety time margin. I don't think they will take that long to implement.''
#Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant.
#*I've been packaging some of the sugar activities for Fedora which is directly related to the core of this proposal. I started with Ruler about 6 months ago with the guidance of [[User:pbrobinson|Peter Robinson]]. Since then I have been maintaining and co-maintaining around 10 packages associated with sugar activities. I am familiar with python and bash scripting as well.
#** Packages I maintain/co-maintain at Fedora: https://admin.fedoraproject.org/pkgdb/users/packages/callkalpa

== You and the community ==
#If your project is successfully completed, what will its impact be on the Sugar Labs community? Give 3 answers, each 1-3 paragraphs in length. The first one should be yours. The other two should be answers from members of the Sugar Labs community, at least one of whom should be a Sugar Labs GSoC mentor. Provide email contact information for non-GSoC mentors.
#*autorpmgen will enable students who doesn't have a xo lap to experience ALL the sugar activities which are currently available on their rpm based distro box. Further it will be beneficial to projects like Sugar on a Stick which is based on Fedora. SoaS will also include more and more sugar activities in future of course will be beneficial to students who even doesn't have a rpm based distro box. They can just plug their USB stick and get the full experience. Activities will be exposed to a more wide community of students, teachers and developers which in turn will result in more and more feedback and ultimately the activities will get better and better and will more suit the needs. That is we are reaching more students with better quality products.
#What will you do if you get stuck on your project and your mentor isn't around?
#*First of all I try myself and next I seek for help in other source such as mailing lists, irc (#sugar #fedora-devel on freenode) and past GSoCers of Sugar Labs. I firmly believe that always there will be some path where I can get the information I need.
#How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?
#*It is mainly my [http://www.kalpapathum.blogspot.com| blog] that I intend to use as the medium to inform the rest of the world on my progress. About the problems and questions, I will be using the specific developer resources and mailing lists and irc as well.

== Miscellaneous ==
#We want to make sure that you can set up a development environment before the summer starts. Please send us a link to a screenshot of your Sugar development environment with the following modification: when you hover over the XO-person icon in the middle of Home view, the drop-down text should have your email in place of "Restart." See the image on the right for an example. It's normal to need assistance with this, so please visit our IRC channel, #sugar on irc.freenode.net, and ask for help.
#What is your t-shirt size? (Yes, we know Google asks for this already; humor us.)
#Describe a great learning experience you had as a child.
#Is there anything else we should have asked you or anything else that we should know that might make us like you or your project more?

Summer of Code/2012/autorpmgen

2012-02-10T04:41:53Z

Callkalpa: /* You and the community */

<noinclude>{{TOCright}}
[[Category:2012 GSoC applications]]
[[Category:GSoC]]
</noinclude>

== About You ==
#What is your name? Kalpa Pathum Welivitigoda
#What is your email address? callkalpa@gmail.com
#What is your Sugar Labs wiki username?
#What is your IRC nickname? callkalpa
#What is your primary language? English
#Where are you located, and what hours do you tend to work? I am located in Sri Lanka (GMT + 0530h), work hours can be varied as required and willing to work at night as well.
#Have you participated in an open-source project before?
#* http://fedoraproject.org/wiki/User:Callkalpa
#* http://openhatch.org/people/callkalpa/

== About your project ==
#What is the name of your project? autorpmgen
#Describe your project in 10-20 sentences. What are you making? Who are you making it for, and why do they need it? What technologies (programming languages, etc.) will you be using?
#*I am going to make a tool which will automatically build the rpm packages for the existing sugar activities. It builds new rpms as new activities are submitted or new updates are issued for existing activities. And there will be a separate repo established for those rpms.
#*At the time of writing there are almost 400 sugar activities. Projects like sugar on a stick have widen the community for these activities (like they can be used by Fedora users as well). Still that is possible only for the packages that are packaged for Fedora (making the rpm, going through the review process and all that). What I am trying to do is spread it even more. People who want to use activities on their Fedora box will just add the repo and install them. There's no need for them to be approved for Fedora repo. This is true for any other rpm based distro. Further there is no need of maintainers who need to follow the development and build new rpms. (Currently there are packaged activities for Fedora where there are no further rpm issues due to lack of maintainers). It is even better to extend this to other package managing systems as well like deb. But I have no experience with that at the time of writing so I will for now just stick to rpm.
#*The idea is to maintain a ini file like file for each activity and generate the spec file out from that and finally generate the rpm. There is [http://wiki.meego.com/Spectacle Spectacle], a tool to generate spec out of a ini file and [http://rm-rf.ca/tito Tito] which can be used to build rpm from the spec file.
#What is the timeline for development of your project? The Summer of Code work period is 7 weeks long, May 23 - August 10; tell us what you will be working on each week.
#* 1st and 2nd week : Generate ini file (details extracted from the activity.info file in each activity and from other sources related)
#* 3rd week : generate spec file from the ini file
#* 4th and 5th week : generate rpm from the spec
#* 6th week : establish a repo for the rpms
#* 7th week : implement the new activity submission and update submission feature
#* ''Here I have outlined my schedule only for coding. Evaluations will be there and the schedule is subjected to undergo changes as necessary. For generating the ini file and rpm, I have allocated two weeks each and this is with a safety time margin. I don't think they will take that long to implement.''
#Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant.
#*I've been packaging some of the sugar activities for Fedora which is directly related to the core of this proposal. I started with Ruler about 6 months ago with the guidance of [[User:pbrobinson|Peter Robinson]]. Since then I have been maintaining and co-maintaining around 10 packages associated with sugar activities. I am familiar with python and bash scripting as well.
#** Packages I maintain/co-maintain at Fedora: https://admin.fedoraproject.org/pkgdb/users/packages/callkalpa

== You and the community ==
#If your project is successfully completed, what will its impact be on the Sugar Labs community? Give 3 answers, each 1-3 paragraphs in length. The first one should be yours. The other two should be answers from members of the Sugar Labs community, at least one of whom should be a Sugar Labs GSoC mentor. Provide email contact information for non-GSoC mentors.
#*autorpmgen will enable students who doesn't have a xo lap to experience ALL the sugar activities which are currently available on their rpm based distro box. Further it will be beneficial to projects like Sugar on a Stick which is based on Fedora. SoaS will also include more and more sugar activities in future of course will be beneficial to students who even doesn't have a rpm based distro box. They can just plug their USB stick and get the full experience. Activities will be exposed to a more wide community of students, teachers and developers which in turn will result in more and more feedback and ultimately the activities will get better and better and will more suit the needs. That is we are reaching more students with better quality products.
#What will you do if you get stuck on your project and your mentor isn't around?
#*First of all I try myself and next I seek for help in other source such as mailing lists, irc (#sugar #fedora-devel on freenode) and past GSoCers of Sugar Labs. I firmly believe that always there will be some path where I can get the information I need.
#How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?
#*It is mainly me [[http://www.kalpapathum.blogspot.com| blog]] that I intend to use as the medium to inform the rest of the world on my progress. About the problems and questions, I will be using the specific developer resources and mailing lists and irc as well.

== Miscellaneous ==
#We want to make sure that you can set up a development environment before the summer starts. Please send us a link to a screenshot of your Sugar development environment with the following modification: when you hover over the XO-person icon in the middle of Home view, the drop-down text should have your email in place of "Restart." See the image on the right for an example. It's normal to need assistance with this, so please visit our IRC channel, #sugar on irc.freenode.net, and ask for help.
#What is your t-shirt size? (Yes, we know Google asks for this already; humor us.)
#Describe a great learning experience you had as a child.
#Is there anything else we should have asked you or anything else that we should know that might make us like you or your project more?