GSoC : Draft proposal - Improve built-in help

Shayan Md mdoshayan at gmail.com
Sun Apr 3 20:28:25 CDT 2011


On Sat, Apr 2, 2011 at 11:07 PM, Martin Geisler <mg at lazybytes.net> wrote:

> Shayan Md <mdoshayan at gmail.com> writes:
>
> > Improve built-in help:
> >
> > I am a grad student from IISc banglore. I worked on some web
> > development projects before. I am fairly good at python. I would like
> > to contribute to mercurial in this summer and also be part of Google
> > Summer of Code. I am interested in improving built-in help.
>
> That is cool! :)
>
> > Deliverables:
> >
> > * Cross linking between help topics
> > * Mange pages in built-in web help
> > * Example usage in verbose section in help
> > * Improved glossary
> > * Better mercurial web view
> >
> > 1. Improve cross linking between help topics:
> >
> >
> >    There's no linking between the help topic. When we go to /help and
> > click on a link to a topic we see built-in help of the commands. From
> > that page if we want to go to other pages we have to go back to /help.
> > This has to be removed and linking should be given to all the pages.
> >
> >   This involves changes in templates and linking them to appropriate
> >   locations
>
> There are already links between the help texts via the hg "interpreted
> text role", as it's called in Docutils. So when you write
>
>  Use :hg:`add` to add files.
>
> in the help text, then the minirst module turns it into
>
>  Use "hg add" to add files.
>
> in the ASCII art output and the doc/runrst script turns it into
>
>  Use <a href="hg.1.html#add"><tt>hg add</tt></a> to add files.
>
> in the HTML output you see in the hg.1.html file.
>
> I think it would be cool if the HTML output you see in the /help section
> of hgweb would use Docutils if available and otherwise fallback to the
> ASCII art text wrapped in <pre> tags like today.
>

Sure. Thanks for the feedback.

>
> --
> Martin Geisler
>
> Mercurial links: http://mercurial.ch/
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://selenic.com/pipermail/mercurial-devel/attachments/20110404/71587767/attachment.htm>


More information about the Mercurial-devel mailing list