[PATCH inputproto] Add minimal asciidoc syntax

[Gaetan Nadon]

On Tue, 2011-03-15 at 15:29 +1000, Peter Hutterer wrote:

> Though this protocol description is mainly to be viewed as textfile, a
> few
> minor changes make it parsable for asciidoc to spit out reasonably
> nicely-formatted html code.
> 
> Changes include:
> - underline section headers with the matching lines
> - add linebreaks before lists to parse them as lists
> - change indentation level for normal text to be left-marging aligned
> and
>   for <pre> text to be indented
> - comment out section dividers
> 
> It's possible to run asciidoc XI2proto.txt and get some nice html
> output
> now.
> 


Nothing wrong with the patch itself, but there is a conflict in
documentation strategy. We have half the protos in docbook format and
half in text format. The rest of X.Org is in docbook format. I am not
trying to say it is better, but having all the docs in one format is
better than having multiple formats like we used to have before the
conversion.

I don't want to start a debate on docbook vs asciidoc but shouldn't all
protos be documented with the same technology? I see them as the
chapters of one book (conceptually speaking) rather than discrete
entities. The driver to merge the protos is a hint that they form a
cohesive whole and therefore should be documented in a likewise fashion.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.x.org/archives/xorg-devel/attachments/20110315/c49cef6f/attachment.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: This is a digitally signed message part
URL: <http://lists.x.org/archives/xorg-devel/attachments/20110315/c49cef6f/attachment.pgp>