[PATCH RFC] protocol: add xslt stylesheet to prettify the protocol

[Pekka Paalanen]

On Thu, 23 Feb 2012 11:57:31 +0200
Tiago Vignatti <tiago.vignatti at linux.intel.com> 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, and
> >    it certainly reveals missing bits of documentation in the protocol

IIRC there was a plan to make wayland-scanner require protocol
documentation, once all protocol was documented.

> > - 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?
> 
> http://lists.freedesktop.org/archives/wayland-devel/2012-February/002168.html
> 
> 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.

Were there plans to convert documentation to docbook or something? I
recall someone at least mentioning docbook once.

In the XSLT approach I like the TOC with links approach, easily gives
an overview of the protocol. In LaTeX you would use hyperref to achieve
that.

I've been using QXmlEdit with the attached style file for reading the
protocol XML files.


Thanks,
pq
-------------- next part --------------
A non-text attachment was scrubbed...
Name: wayland.style
Type: application/octet-stream
Size: 725 bytes
Desc: not available
URL: <http://lists.freedesktop.org/archives/wayland-devel/attachments/20120223/c220e06a/attachment-0001.obj>