Difference between revisions of "GSoC/2013/Activity Help"

Revision as of 08:49, 25 July 2013

Introduction

This page presents the status of the project "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

Work done so far

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

Reference

Sugar clone: https://github.com/callkalpa/sugar/tree/activity_help

@@ Line 18: / Line 18: @@
 * 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
-* Update current help content and submit them to Pootle to be translated
+* Send current help content to Pootle be translated
 * Write help for activities
 == Reference ==
 * Sugar clone: https://github.com/callkalpa/sugar/tree/activity_help