On 7 February 2012 22:09, Ian Lynagh <[email protected]> wrote:
> On Tue, Feb 07, 2012 at 01:55:14PM -0800, David Terei wrote:
>>
>> GHC's online documentation used to include Cabal's user guide, e.g see
>> for 7.0.4:
>>
>> As of 7.2.1 (and 7.4.1) GHC doesn't seem to include it anymore:
>>
>> I'm just wondering if this is deliberate or accidental?
>
> Cabal's userguide used to be in docbook, which our build system knows
> how to build. Now it's in markdown, which it doesn't.
>
> There's no reason in principle that we couldn't add markdown support,
> though. I don't know OTTOMH what output formats are supported, or what
> platforms the tools are available on.

It supports html 4 and 5 and latex and a few others. It's in principle
available on all platforms where ghc is available. In my experience
it's a lot easier to use than docbook (sane command line tools, no xml
stylesheet catalogues etc).

> Perhaps we should also consider converting the GHC user guide to
> markdown.

I'm quite happy so far with the switch, but ghc's user guide is
significantly bigger. The main drawback I think is there isn't good
support in markdown for cross references within a document, which the
user guide uses quite extensively. IIRC, there's some feature
suggestion tickets in the pandoc bug traker.

Duncan

_______________________________________________
Cvs-ghc mailing list
[email protected]
http://www.haskell.org/mailman/listinfo/cvs-ghc

Reply via email to