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

[Mateusz Kowalczyk]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 28/04/13 11:57, Joe Nash wrote:
> On 28 Apr 2013 11:33, "Mateusz Kowalczyk" <fuuzetsu at fuuzetsu.co.uk>
> wrote:
>>> 
>>> If the flexibility of having it pandoc compatible is a desired 
>>> feature, can this not be achieved through implementing markdown
>>> for haddock as well? Depending on what haddock specific
>>> features were required to be added to the superset, it may
>>> require only minimal changes to an existing markdown
>>> reader/writer in pandoc already.
>> It can, but the restriction comment applies here as well.
> 
> Does it? If it is suitable to write in another markup and convert
> to haddock with pandoc, why is it more restrictive to write in
> another markup and convert to pandoc-markdown? Have I missed a
> point here?
> 
Extending core Haddock allows us to:
1. Write in any of the Pandoc supported formats, including Markdown
2. Convert it to pure Haddock. This can then be converted back into a
different format if need be.

Extending Haddock with a Markdown extension allows us to:
1. Write the documentation in any of Pandoc supported formats
(including our new Markdown)
2. Convert it from a Pandoc supported format to our Markdown extension
as Haddock isn't expressive enough as is to be used.

It's a question of being able to go from `Many formats <-> Pandoc <->
Many formats' and `Markdown extension <-> Pandoc <-> Many formats'.
> I think these are starting to form two projects with tangential,
> but slightly differing goals. It would be interesting to see the
> results if we diverged here and a proposal was submitted for both
> ideas.
> 
I think the goal is still the same: in the end, people will be able to
use Markdown to document their code. The means of achieving the goal
would give us a different final product that achieves the goal in a
slightly different way.


- -- 
Mateusz K.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.19 (GNU/Linux)

iQIcBAEBAgAGBQJRfQWCAAoJEM1mucMq2pqXSDYQAJDgstjhoDNctcvbQ6OagkOe
TVrJ6V7jmSKHYHsQQziGAeEOmXgZ18UX5TEu5w+ZJ//Yf3zCulhMzAjy+jOqGFPY
nOJM5kZL6e7udf/rfmrD8r4GKb3yQAvufJIVLZ8UmMZ3vCAqbOiUs7cKOVcgsoD/
nVs11ySfYfLrF64RGcMqJ6Y9AZMcv05UOOSI3aM++0rj96/34TWRwC5XvQqG08Y+
8eEB0FZijpKFRwMS8eSrTvCTx93pZkRJpMuHawT19zmylvqoME5WCBkeiXrGUuXE
VpYAU5ZZxkW03l65yHb8Ir6IB4kTvD09NprhReR5MRf0J4lbL7TX5WZhP/3APFPk
on8gPn4XGqVyn93Y9GplfCCOGr6A1271xEwqOF5YV7Y6NkI/c+SBcPGitgBBE1SO
03BIjr02S9wUtk+Su3szXZ0rmU5/zTLgCAcH2aG1MfbV7tDTKrL6m/J80wjzNULQ
nhfHPvqEtT/iH6G2BmyLTSuNUgakDYzA10LPRIuxgoCBaZr9mGcJ6wye/xWx6tud
RcuG1a8BS02Xau+zPFKgbdp1UQ8sRW2wiqPsbvwHVMoXvJ1j8ro+Xcxv0+vmar67
tWnYRHH4WgG209j1mX3ssj0gWcFUaFHrPYR9Gpv154NxdOEFq32w9eZO1pXndo8f
zW9RmOLRpqh30fX3E2iX
=0um2
-----END PGP SIGNATURE-----