GSoC/2013/MallardHelp

From Sugar Labs
Jump to navigation Jump to search

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

Reference

  1. Implement help mechanism for activities using Mallard [1]
  2. Help content of the Help activity [2]
  3. pandoc [3]
  4. Markdown files of the current help content [4]
  5. HTML to mallard conversion script [5]