OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]

Subject: Re: DOCBOOK: Code markup.

/ "Dave Pawson" <dave.pawson@virgin.net> was heard to say:
|      | My need is to talk about an instance use of a function, its params
|      | its return values etc.
|      |
|      | How about
|      | <para> <cmdsynopsis sepchar=" ">
|      No reason to put the cmdsynopsis inside a para if you don't want to.
| Fine, one level less of markup.
|      |   <command moreinfo="none">xf86GetFlipPixels()</command>
|      That's a function, not a command.
| For which the markup is...?


| *were* it a command with an argument
| would <command> xfreeGetFlipPixels</command<arg
| choice="optional"> -flippexels</arg>
| be the right markup?
| (still wanting to learn)

Yes, inside a cmdsynopsis.

See, e.g., http://docbook.org/tdg/html/cmdsynopsis.html

                                        Be seeing you,

Norman Walsh <ndw@nwalsh.com>      | The perfect man has no method; or
http://www.oasis-open.org/docbook/ | rather the best of methods, which
Chair, DocBook Technical Committee | is the method of
                                   | no-method.--Shih-T'ao

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]

Powered by eList eXpress LLC