[PATCH inputproto] Add minimal asciidoc syntax

Matt Dew marcoz at osource.org
Mon Mar 21 20:40:41 PDT 2011


On 03/20/2011 05:14 PM, Peter Hutterer wrote:
> On Fri, Mar 18, 2011 at 11:45:17AM -0400, Gaetan Nadon wrote:
>> On Fri, 2011-03-18 at 10:07 +1000, Peter Hutterer wrote:
>>
>>> I don't disagree and I certainly haven't use asciidoc in anything more
>>> complex than a man page. just one comment that I found from a quick
>>> search,
>>> suggesting that olink _may_ be possible in asciidoc.
>>> http://groups.google.com/group/asciidoc/browse_thread/thread/4ff80242da4a3634
>>>
>>> btw, git uses asciidoc and has some extensive asciidoc.conf. might be
>>> worthwhile to get some tips and tricks from there.
>>
>> Thanks for the pointer.
>>
>> We may be victim of the pendulum syndrome. The "too many formats"
>> replaced
>> with "one size fits all".
>>
>> It would be better for the project if there were some consistency in the
>> chosen format.
>> It should not be "random" or based on what the developer happens to be
>> more
>> familiar with.
>>
>> Some heuristics based on content type, size, etc...
>>
>> Perhaps doxygen should also be considered in some cases.
>> I have not given any thoughts yet, but protocols are heavy on public api
>> so they seem to be good candidates. Having the code and the docs in the
>> source
>> could go a long way in terms keeping them in sync.
>
> one thing I'd like to point out here is that protocol is that it has a
> speficic way of describing and formatting things. I don't know if that would
> translate quite as well to doxygen (at least when using doxygen commands).
> this includes the LISTofFOOBAR descriptions, etc.
> just one thing to watch out for
>
> Cheers,
>    Peter

does anyone know?

1) verify the asciidoc olinking.
2) can the outputs of asciidoc and doxbook be styled together (IWO: can 
the html files be told to use the same .css file and can the pdf, txt, 
ps and epub's be generated to look similar follow the same styling
3)  can we link between asciidoc/docbook and doxygen?  I'd like to be 
able to reference the doxygen generated API stuff from the 
docbook/asciidoc docs.

They're on my TODO list, but if anyone already knows,  it'd save a bit 
of time.

thanks,
Matt


More information about the xorg-devel mailing list