This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
Re: Code markup.
- To: docbook at lists dot oasis-open dot org
- Subject: Re: DOCBOOK: Code markup.
- From: Norman Walsh <ndw at nwalsh dot com>
- Date: 06 Jul 2000 09:55:45 -0400
- References: <NDBBKDFLFKGBNPJPGKDFMEMCCFAA.dave.pawson@virgin.net>
- Reply-To: docbook at lists dot oasis-open dot org
/ "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...?
<function>
| *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,
norm
--
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