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

From Sugar Labs
< GSoC‎ | 2013
Jump to navigation Jump to search
Line 17: Line 17:
 
* Help file matching with the respective activity is done
 
* Help file matching with the respective activity is done
 
* Studied the internationalization process with sphinx (http://sphinx-doc.org/intl.html)
 
* Studied the internationalization process with sphinx (http://sphinx-doc.org/intl.html)
 +
* Was successful in i18n with sphinx
  
== todo ==
+
== To-do ==
  
* Implement mechanism for l10n
+
* Implement a mechanism to show help content based on the current language
 +
* Update current help content and submit them to Pootle to be translated
 
* Write help for activities
 
* Write help for activities
 +
 +
== Reference ==
 +
* Sugar clone: https://github.com/callkalpa/sugar/tree/activity_help

Revision as of 12:06, 22 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

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
  • Write help for activities

Reference