[PATCH RFC] protocol: add xslt stylesheet to prettify the protocol
peter.hutterer at who-t.net
Thu Feb 23 03:20:33 PST 2012
On 23/02/12 19:57 , Tiago Vignatti wrote:
> On 02/23/2012 07:58 AM, Peter Hutterer wrote:
>> Includes rudimentary styling only.
>> Signed-off-by: Peter Hutterer<peter.hutterer at who-t.net>
>> A few things to note:
>> - I'm not a designer
>> - Having a html version of the protocol makes it a lot easier to read,
>> it certainly reveals missing bits of documentation in the protocol
>> - the .css file is the one from wayland.freedesktop.org, someone could
>> easily fix it to prettify the result a bit.
> I concur we need a prettier way to read the protocol. But what do you
> think about the idea of dumping the whole protocol in a separate section
> of main.tex instead?
largely depends on what you expect the canonical source to be. shouldn't
be that hard to knock up another xslt that converts the xml into latex.
> the protocol could be printed out there verbatim or with more
> descriptions instead; depends what we want. My point is, given we have
> already to maintain main.tex, then we should try to centralize the
> documentation and not have another document just hanging around.
note that the xslt is just the conversion, the html would be read-only
and re-generated whenever the protocol changes. I'm definitely not
suggesting that the html be a source.
More information about the wayland-devel