<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 TRANSITIONAL//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=UTF-8">
<META NAME="GENERATOR" CONTENT="GtkHTML/3.26.0">
</HEAD>
<BODY>
On Tue, 2011-03-15 at 15:29 +1000, Peter Hutterer wrote:<BR>
<BLOCKQUOTE TYPE=CITE>
<TT><FONT COLOR="#1a1a1a">Though this protocol description is mainly to be viewed as textfile, a few</FONT></TT><BR>
<TT><FONT COLOR="#1a1a1a">minor changes make it parsable for asciidoc to spit out reasonably</FONT></TT><BR>
<TT><FONT COLOR="#1a1a1a">nicely-formatted html code.</FONT></TT><BR>
<BR>
<TT><FONT COLOR="#1a1a1a">Changes include:</FONT></TT><BR>
<TT><FONT COLOR="#1a1a1a">- underline section headers with the matching lines</FONT></TT><BR>
<TT><FONT COLOR="#1a1a1a">- add linebreaks before lists to parse them as lists</FONT></TT><BR>
<TT><FONT COLOR="#1a1a1a">- change indentation level for normal text to be left-marging aligned and</FONT></TT><BR>
<TT><FONT COLOR="#1a1a1a"> for <pre> text to be indented</FONT></TT><BR>
<TT><FONT COLOR="#1a1a1a">- comment out section dividers</FONT></TT><BR>
<BR>
<TT><FONT COLOR="#1a1a1a">It's possible to run asciidoc XI2proto.txt and get some nice html output</FONT></TT><BR>
<TT><FONT COLOR="#1a1a1a">now.</FONT></TT><BR>
<BR>
</BLOCKQUOTE>
<BR>
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.<BR>
<BR>
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.<BR>
<BR>
<BR>
</BODY>
</HTML>