[Haskell-cafe] Markdown extension for Haddock as a GSoC project

[Petr Pudlák]

Hi,

It seems that during the recent suggestions about what markup to choose
(Markdown, Creole, Asciidoc, etc.), we've forgotten about one of the goals
that seem very important to me for Haskell: the ability to write *math
formulas*. I have experienced on StackExchange that just adding MathJAX to
Markdown leads to many surprising errors that can be fixed only by strange
hacks.

Personally I'd incline to choose some existing, well-established markup
language with formal specification that supports math (hopefully there is
one). Extending Haddock with new features and a syntax for math formulas
would certainly require to design such a specification, which isn't easy,
and using an existing one would simplify the process a lot. Also I believe
that newcomers to Haskell would definitely appreciate working with an
existing markup language (and I'm sure not only them) instead of having to
learn Haddock's syntax.

  Best regards,
  Petr



2013/5/2 Mateusz Kowalczyk <fuuzetsu at fuuzetsu.co.uk>

> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> On 02/05/13 06:57, Ben wrote:
> > sorry, i was only trying to make a helpful suggestion!
> >
> > just to clarify: i'm not championing asciitext (or any other
> > format) -- i only heard about it recently in a comment on
> >
> > http://www.codinghorror.com/blog/2012/10/the-future-of-markdown.html
> >
> >  i checked it out and it sounded cool, so i thought it'd be a
> > helpful pointer to whomever is working on new haddock -- they are
> > of course welcome to ignore it.  totally understand that overmuch
> > debate is not helpful (though i'm not sure it's fair to call it
> > bikeshedding, since it is a primary feature of the proposed
> > project!)
> >
> > best, ben
> >
> > On Apr 27, 2013, at 2:02 PM, Bryan O'Sullivan wrote:
> >
> >> On Sat, Apr 27, 2013 at 1:47 PM, Ben <midfield at gmail.com> wrote:
> >> asciidoc has been mentioned a few times in comments, i think it's
> >> worth looking at.
> >>
> >> This is the problem I was afraid of: for every markup syntax
> >> under the sun, someone will come along to champion it.
> >>
> >> The choice of one or N syntaxes is ultimately up to the
> >> discretion of the student, guided by their mentor. It is in our
> >> collective interest to avoid prolonging a bikeshed discussion on
> >> this, as a long inconclusive discussion risks dissuading any
> >> sensible student or mentor from wanting to pursue the project in
> >> the first place.
> >
> >
> > _______________________________________________ Haskell-Cafe
> > mailing list Haskell-Cafe at haskell.org
> > http://www.haskell.org/mailman/listinfo/haskell-cafe
> >
> These two posts are exactly why I believe that extending Haddock
> itself would be of more benefit than simply adding a Markdown
> extension to it: with addition to core features, integrating any of
> the N syntaxes that people want suddenly becomes the question of just
> writing reader and writer modules for Pandoc instead of a full project
> on marshalling yet another markup as an extension directly to Haddock.
>
> - --
> Mateusz K.
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v2.0.19 (GNU/Linux)
>
> iQIcBAEBAgAGBQJRggwfAAoJEM1mucMq2pqXHmAP/R2nHmXiNHDVqWEAoLQHSNeC
> psgcNm2hAclo6AxYprPsNHkqIUYh4HVpsc8FZw+RsAwkpUrGiaaMD/OTNB5857V+
> 296lzHNOLNvge7B77FfVTa5wx1j2M+N0+pcOzcxr8qX5opfJNOcMPPtaXqD0nMS7
> 6EsBac/pQAjOHVYOTHEpsxAbl70s/QFBa/kW6tZPJmWKdHp6c3VmL5qx9CY9lZO4
> 1QKmyKqQMhxN0hmxcFHcYsa/IsohSAFewrs6JDErShn5ffIvtkhEM0UKVCBM26G4
> Eu4Hadrv/AyoDT6UdtMgVllzY0XrykfLJ1nXzpp0QklYml0/SMmNrwqO9wfooMfF
> XKWiW2T8QWN5dFJO4kM9JA6UqpQ2uvrK6qWREL3jv8/jbEvg0WVko3zTW/BNzjF2
> /Pn/9Z1vxYEee4A3Oa0sT7NGhKqK9KRtIgdfuXvTCnctvFYBxwtGHCcKuxgHVNNM
> GIJAqMtUtwr1Kjt37Gf0F+r1TBQfOsJL7tzRPayZKYPl7uA/ugrHHnYxL5JqIyAq
> bMUqLxAsDNW2tXIPzmNi4QYPqaopaUmwAD8IPvFk9e/1vI0QnU8b1URLjt5zl3O+
> mFyWYTQd/UuaFOmOEmfLMJz+n2tRqL51LOCYcHwEjpH10WuTpX1DS3LWErcwppO5
> bUZggQ5DwewgRIfCNEfS
> =nnP/
> -----END PGP SIGNATURE-----
>
> _______________________________________________
> Haskell-Cafe mailing list
> Haskell-Cafe at haskell.org
> http://www.haskell.org/mailman/listinfo/haskell-cafe
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.haskell.org/pipermail/haskell-cafe/attachments/20130502/86202407/attachment.htm>