[Sugar-devel] [GSoC] Implement help mechanism for activities using Mallard - Update

[Kalpa Welivitigoda]

On Mon, Jun 10, 2013 at 6:19 PM, Gonzalo Odiard <gonzalo at laptop.org> wrote:

> Ok.
>
> You need look at a mechanism to generate the index.
>

Since markdown is only for the source, I don't think it is necessary, an
index would be useful when we are going to display the help using Mallard.
What do you think Gonzalo?


> Right now, index.markdown is almost empty, probably because was not used a
> rst standard,
> but a sphinx extension:
>
>
> https://git.sugarlabs.org/~callkalpa/help-activity-content/callkalpa-help-activity-content/blobs/4ef6675c1322b8a5ab7e37dfaade498a9edd6bc8/source/index.markdown
>
> Also, we need a method to generate the html content (a script is ok)
>

It can be done from pandoc itself and pandoc is available in stable repos
of many popular distros (including fedora). That will be useful.


> Can you create a page in the wiki, like [1]
> to document your work?
>

Hope this would do http://wiki.sugarlabs.org/go/GSoC/2013/MallardHelp
I will keep on adding more info as I progress.


>
> Gonzalo
>
>
> [1] http://wiki.laptop.org/go/Help_Activity_refresh/0.98
>
>
>
> On Mon, Jun 10, 2013 at 8:57 AM, Kalpa Welivitigoda <callkalpa at gmail.com>wrote:
>
>> Hi,
>>
>> After the initial discussion I had with Gonzalo last Monday, we agreed to
>> use Markdown [1] as the base for the source Help files. Existing help
>> content [2] is in rst and they needs to be converted to Markdown. I've used
>> pandoc [3] to convert those rts source files to Markdown and has pushed
>> them to a fork [4] the repo. So  the developers can either use rst or
>> Markdown to write their source help files.
>>
>> [1] http://daringfireball.net/projects/markdown/
>> [2] https://git.sugarlabs.org/help-activity-content
>> [3] http://johnmacfarlane.net/pandoc/
>> [4]
>> https://git.sugarlabs.org/~callkalpa/help-activity-content/callkalpa-help-activity-content
>>
>>
>> --
>> Best Regards,
>>
>> Kalpa Welivitigoda
>> Junior Treasurer | Electrical Engineering Society
>> Undergraduate | Department of Electrical Engineering
>> University of Moratuwa
>> Sri Lanka
>> http://about.me/callkalpa
>>
>> --
>> You received this message because you are subscribed to the Google Groups
>> "Sugar GSoC" group.
>> To unsubscribe from this group and stop receiving emails from it, send an
>> email to sugar-gsoc+unsubscribe at googlegroups.com.
>> For more options, visit https://groups.google.com/groups/opt_out.
>>
>>
>>
>
>  --
> You received this message because you are subscribed to the Google Groups
> "Sugar GSoC" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to sugar-gsoc+unsubscribe at googlegroups.com.
> For more options, visit https://groups.google.com/groups/opt_out.
>
>
>



-- 
Best Regards,

Kalpa Welivitigoda
Junior Treasurer | Electrical Engineering Society
Undergraduate | Department of Electrical Engineering
University of Moratuwa
Sri Lanka
http://about.me/callkalpa
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sugarlabs.org/archive/sugar-devel/attachments/20130610/8c2298c6/attachment.html>