On Tuesday, 28 April 2015 01:09:19 UTC+1, Lex Trotman wrote: > > On 28 April 2015 at 09:38, Gaetano Giunta <[email protected] <javascript:>> > wrote: > > I am thinking of moving the documentation for a php library from docbook > to > > asciidoc as default format, in large part because asciidoc is > transparently > > handled by gitHub, while docbook is not. > > > > I have so fart converted the docbook version using the docbook2asciidoc > xslt > > from oreillymedia, and the results look pretty good, except for one big > > missing thing: all the descriptions of code functions, which were > properly > > tagged in docbook using funcsynopsis elements, are now just plain > > paragraphs. > > > > I have done some cursory google search, and it seems that asciidoc has > no > > equivalent, which could be used to document the method calls in an api > in a > > structured way (return type, method name, paramateres with their types). > > Am I missing something? > > I'm afraid not, asciidoc does not generate funcsynopsis and friends. > Obviously it works for you, since you already use it, but note that in > general funcsynopsis only supports C like languages. > > Indeed. Getting it to generate something readable for php meant I had to apply custom xslt. Luckily it was easy to add them on top of the standard dockbook xsl.
> > Are there useful workarouds? > > I usually use source blocks for interface definitions, this has the > advantage that it supports non-C languages, ie any that has a > highlighter. But it isn't structured. > > Thanks for the tip > Cheers > Lex > > > > > Thanks > > Gaetano > > > -- You received this message because you are subscribed to the Google Groups "asciidoc" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/asciidoc. For more options, visit https://groups.google.com/d/optout.
