62
edits
Changes
GSoC/2013/Activity Help (view source)
Revision as of 08:26, 21 February 2017
, 08:26, 21 February 2017→View help for the Activity in the help itself: Updated the hot key combination
== Introduction ==
== 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.
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.
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.
==== View help for the Activity in the help itself ====
==== 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).
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]
[https://github.com/callkalpa/sugar/tree/activity_help GitHub repo - Sugar fork]
<gallery>
<gallery>
File:ActivityHelp_Read_in_Sinhala.png|Read Activity help in Sinhala
File:ActivityHelp_Read_in_Sinhala.png|Read Activity help in Sinhala
File:About_OLPC_in_Danish.png|About OLPC help in Danish
</gallery>
</gallery>
-si
-si
-*.html (help content in Sinhala)
-*.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 ====
==== Update current help content ====
* Write help for activities
* Write help for activities
* Update current help content for some Activities including FotoToon and Record
* 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