Features/Activity Help

Summary

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

Owner

• Name: 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

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 discussion tab for this feature