Re: [Haskell-cafe] haddock as a markdown preprocessor

On Sat, 2008-02-23 at 01:28 +, Duncan Coutts wrote: > Basically I'd like to know what tool (that is packaged on every linux > distro) do I use to convert a docbook .xml file to xhtml. I took a quick > look on the FAQ linked from docbook.org/help and could not immediately > find what standard

Re: [Haskell-cafe] haddock as a markdown preprocessor

On Fri, 2008-02-22 at 07:21 -0800, Keith Fahlgren wrote: > On 2/21/08 3:57 PM, Duncan Coutts wrote: > > Consequently there is no support in > > Cabal etc for those kinds of documentation. GHC, Cabal and c2hs amongst > > others use docbook but it's a horrible format to write and the tools to > > pr

Re: [Haskell-cafe] haddock as a markdown preprocessor

On Fri, Feb 22, 2008 at 10:57 AM, Reinier Lamers <[EMAIL PROTECTED]> wrote: > [...] > Of course, the source code includes comments that specify what > functions do, and so provide a bit of API documentation. But such > comments should contain as little formatting as possible to keep them > readabl

Re: [Haskell-cafe] haddock as a markdown preprocessor

Op 22-feb-2008, om 1:54 heeft Conal Elliott het volgende geschreven: The goal redesigning for composability is that we get more for less. Haddock can focus on its speciality, namely hyperlinked Haskell code documentation, and pandoc on its, namely human- writable and -readable prose with mo

Re: [Haskell-cafe] haddock as a markdown preprocessor

Hi Yitzchak, About "-- |", "-- ^", and "-- $doc", we might call them "markup meta-directives", since they delimit the text to be preprocessed and then produced as markup. The meta-directives and the "-- " line prefixes would be removed in the process. As for producing machine-readable API metada

Re: [Haskell-cafe] haddock as a markdown preprocessor

On 2/21/08 3:57 PM, Duncan Coutts wrote: > Consequently there is no support in > Cabal etc for those kinds of documentation. GHC, Cabal and c2hs amongst > others use docbook but it's a horrible format to write and the tools to > process it are very finicky (we apparently have to hard code paths to

Re: [Haskell-cafe] haddock as a markdown preprocessor

Conal Elliott wrote: > Pare the Haddock markup language down to > very few markup directives, say just 'foo' and > "Foo.Bar". Other critical ones: -- | This shows which syntax this text describes. -- ^ So does this. Less critical, but usually not provided by general markup languages: -- $doc A

Re: [Haskell-cafe] haddock as a markdown preprocessor

On Thu, Feb 21, 2008 at 5:37 PM, Duncan Coutts <[EMAIL PROTECTED]> wrote: > So the advantage of passing the rest through uninterpreted is that > markdown then interprets it and we get lots of cool markup for free, the > disadvantage is that we get lots more markup that I don't > understand! :-) T

Re: [Haskell-cafe] haddock as a markdown preprocessor

On Thu, 2008-02-21 at 16:54 -0800, Conal Elliott wrote: > I guess there was some confusion about the haddock-as-preprocessor > idea. Here's another try: > > Pare the Haddock markup language down to very few markup directives, > say just 'foo' and "Foo.Bar". (Of course, Haddock continues to read

Re: [Haskell-cafe] haddock as a markdown preprocessor

I guess there was some confusion about the haddock-as-preprocessor idea. Here's another try: Pare the Haddock markup language down to very few markup directives, say just 'foo' and "Foo.Bar". (Of course, Haddock continues to read and process type signatures and module import & export specs.) Com

Re: [Haskell-cafe] haddock as a markdown preprocessor

On Thu, 2008-02-21 at 13:12 +, Alistair Bayley wrote: > On 21/02/2008, Duncan Coutts <[EMAIL PROTECTED]> wrote: > > > > To be honest I like the fact that haddock's markup is really simple and > > perhaps somewhat restrictive. A great improvement though would be to > > make it easy to extract

Re: [Haskell-cafe] haddock as a markdown preprocessor

David Menendez wrote: > Markdown is not really a presentation format. > It's an authoring format Its primary design goal is to be easy to read, not easy to parse. That's why I consider it a presentation format, Anyway, it's not suitable for use as API markup. The whole point is that you want to

Re: [Haskell-cafe] haddock as a markdown preprocessor

On Thu, Feb 21, 2008 at 12:54 PM, Yitzchak Gale <[EMAIL PROTECTED]> wrote: > Duncan Coutts wrote: > >> To be honest I like the fact that haddock's markup is really simple and > >> perhaps somewhat restrictive. A great improvement though would be... > > >> a generic backend that spits out > >>

Re: [Haskell-cafe] haddock as a markdown preprocessor

Duncan Coutts wrote: >> To be honest I like the fact that haddock's markup is really simple and >> perhaps somewhat restrictive. A great improvement though would be... >> a generic backend that spits out >> the info that haddock gathers in a machine readable format. Alistair Bayley wrote: > I

Re: [Haskell-cafe] haddock as a markdown preprocessor

2008/2/21, Conal Elliott <[EMAIL PROTECTED]>: > There was a chat today on #haskell (15:08 to 16:10) about evolving haddock. > I'd like to get comments. > > The goal is to get the full functionality of a general purpose, > programmer-friendly markup language like markdown. One example is image >

Re: [Haskell-cafe] haddock as a markdown preprocessor

On 21/02/2008, Duncan Coutts <[EMAIL PROTECTED]> wrote: > > To be honest I like the fact that haddock's markup is really simple and > perhaps somewhat restrictive. A great improvement though would be to > make it easy to extract the docs from haddock in a nice format so that > the could be re-us

Re: [Haskell-cafe] haddock as a markdown preprocessor

On Wed, 2008-02-20 at 16:43 -0800, Conal Elliott wrote: > There was a chat today on #haskell (15:08 to 16:10) about evolving > haddock. I'd like to get comments. > > The goal is to get the full functionality of a general purpose, > programmer-friendly markup language like markdown. One example

[Haskell-cafe] haddock as a markdown preprocessor

There was a chat today on #haskell (15:08 to 16:10) about evolving haddock. I'd like to get comments. The goal is to get the full functionality of a general purpose, programmer-friendly markup language like markdown. One example is image embedding.