GSoC/2013/MallardHelp: Difference between revisions

(2 intermediate revisions by the same user not shown)

Line 1:

''' It was found that the objectives of the project can be achieved through the current help mechanism. Therefore Mallard was abandoned and more info on the current project is at http://wiki.sugarlabs.org/go/GSoC/2013/ActivityHelp '''

==Introduction==

Line 14:

Line 16:

==Work so far==

* 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. (This is not relevant anymore since we are using html as the final file format before Mallard conversion)

* 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.

Line 22:

Line 24:

==To-do==

* Develop a script to convert ~~Markdown~~ source files to Mallard

* Develop a script to convert html 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.~~

** This is being developed already. I'll be adding more tags as I come across them

* ~~Implement a mechanism to show~~ help in ~~each~~ activity

* Display the relevant help file in the activity (map help file with their relevant activity)

* ~~Extract strings from the~~ help ~~docs and feed them to pootle for l10n~~

* Lokalization of help content

* Write help for activities for which help is not there yet

==Reference==

@@ Line 1: / Line 1: @@
+''' It was found that the objectives of the project can be achieved through the current help mechanism. Therefore Mallard was abandoned and more info on the current project is at http://wiki.sugarlabs.org/go/GSoC/2013/ActivityHelp '''
 ==Introduction==
@@ Line 14: / Line 16: @@
 ==Work so far==
-* 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. (This is not relevant anymore since we are using html as the final file format before Mallard conversion)
 * 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.
@@ Line 22: / Line 24: @@
 ==To-do==
-* Develop a script to convert Markdown source files to Mallard
+* Develop a script to convert html 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.
+** This is being developed already. I'll be adding more tags as I come across them
-* Implement a mechanism to show help in each activity
+* Display the relevant help file in the activity (map help file with their relevant activity)
-* Extract strings from the help docs and feed them to pootle for l10n
+* Lokalization of help content
 * Write help for activities for which help is not there yet
 ==Reference==
 <references />