Protocol documentation

Peter Hutterer peter.hutterer at who-t.net
Mon Dec 2 18:59:16 PST 2013


On Wed, Nov 27, 2013 at 02:16:55PM -0800, Kristian Høgsberg wrote:
> 
> On Tue, Nov 26, 2013 at 02:25:42PM +0100, Jonny Lamb wrote:
> > Hi.
> > 
> > I have recently been working on some Wayland protocol stuff and found
> > referring to the XML tiresome. Telepathy's D-Bus protocol has a parser
> > which outputs pretty HTML from the XML[0] so I took said parser and
> > modified it for the Wayland XML format:
> > 
> >    core Wayland protocol (as of 5a019e3)
> >    http://people.collabora.co.uk/~jonny/wayland/
> > 
> >    Weston protocol extensions (as of bf3c1c6)
> >    http://people.collabora.co.uk/~jonny/weston/
> > 
> > I find this is a lot easier on the eye. Hopefully someone will also find
> > it of some use. The hacked up parser code is in git[1].
> > 
> > Cheerio,
> 
> I think that looks nice and I'm not too attached to publican... it's
> certainly a big hammer (with many deps) for waylands needs.  I do like
> the option to output PDFs though.  Either way, this is certainly
> useful and we could put it up on wayland.freedesktop.org.

fwiw, publican supports a Common_Content/css/overrides.css file that can
override the default formatting to make it a bit easier to read. And a bit
of fancy xslt should make it possible to get a cross-reference table into
the current doc. but yeah, I'm getting rather sick of publican getting in
the way more than actually helping with all this.

Cheers,
   Peter



More information about the wayland-devel mailing list