Difference between revisions of "GSoC/2013/MallardHelp"
Jump to navigation
Jump to search
| Line 6: | Line 6: | ||
* 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. | * 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== | ==To-do== | ||
Revision as of 12:41, 21 June 2013
Introduction
This page presents the status of the project "Implement help mechanism for activities using Mallard" [1]. This project is being implemented as a GSoC 2013 project.
Work so far
- Help content[2] of the Help activity which is in rst has been converted to Markdown. The conversion was done using pandoc[3]. The Markdown files are push at a fork[4] of the help-activity-content.
- A python script[5] 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