Plaintext documentation

[Arran Cudbard-Bell]

On Jun 24, 2011, at 10:14 AM, Brian Candler wrote:

> On Thu, Jun 23, 2011 at 10:54:38PM +0200, Arran Cudbard-Bell wrote:
>> Wouldn't it be wonderful if there was a system where users and developers
>> could both contribute content, quickly and easily, without having to learn
>> GIT, in a format that closely resembles plaintext.
> 
> markdown is wonderful, especially the [pandoc] variant. There's also a wiki
> called [gitit] built on pandoc.  The backend is git, but users don't know
> this.  It lets you do extremely cool things like downloading wiki pages as
> PDFs, and viewing wiki pages as slideshows.
> 
> [pandoc]: http://johnmacfarlane.net/pandoc/
> [gitit]: http://gitit.net/
> 
> reStructuredText comes a close second.

Yeah looks like it's a pretty good equivalent to gollum. Unfortunately, clicking the 'history' link on the home page doesn't exactly fill me with confidence that it'll be any less buggy :(.

I think a better idea would be to add 'pandoc' support to Gollum. It looks like there's already a wrapper of the Haskell library for this [http://rubygems.org/gems/pandoc-ruby]. Pandoc can also do PDF conversions so it's likely the library responsible 

Then when people changed the format of a page, gollum could pass the old content through pandoc before writing it out in the new page. This would fix a bunch of issues for us with the crappy mediawiki parser (Wiki Cloth).

I'll take a look at it over the weekend if I get time. Or if you know ruby and want to have a crack at it yourself my fork of gollum is here [git://github.com/arr2036/gollum.git]. Just check it out and merge your changes to make sure it works with the FR wiki's file handling stuff (it's slightly different for Mediawiki compatibility).

Cheers,
Arran

> 
> Cheers,
> 
> Brian.
> -
> List info/subscribe/unsubscribe? See http://www.freeradius.org/list/devel.html

Arran Cudbard-Bell
a.cudbardb at freeradius.org

RADIUS - Half the complexity of Diameter