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: "Dave Pawson" <dave dot pawson at virgin dot net>
- Date: Tue, 27 Jun 2000 19:33:10 +0100
- Reply-To: docbook at lists dot oasis-open dot org
Juan R. Migoya
Sent: 25 June 2000 12:12
Check te <refentry> element. Perhaps you find more options
there to play
with.
Again, its a 'maybe', described as
<quote>RefEntry -- A reference page (originally a UNIX man-style reference
page)</quote>
Which presumably means its a 'how to use' instance.
The tdg examples appear way out (tdg\html\refentry.html)
(no formatted output Norm?)
My need is to talk about an instance use of a function, its params
its return values etc.
How about
<para> <cmdsynopsis sepchar=" ">
<command moreinfo="none">xf86GetFlipPixels()</command>
<arg choice="opt" rep="norepeat">-flippixels</arg>
<!-- one of (sbr group arg command) -->
</cmdsynopsis>
<para>Returns <computeroutput>TRUE</computeroutput> if -flippixels is
present on the command line, and <computeroutput>FALSE</computeroutput>
otherwise</para></para>
Which, as you said ;-), I found via that command.
Regards, DaveP
Dave Pawson wrote:
> In one of the documents I'm doing, I have 'descriptions'
> of whats happening.
> E.g.
> <p><tt>Bool xf86GetFlipPixels()</tt></p>
> <p>Returns <tt>TRUE</tt> if <tt>-flippixels</tt> is
> present on the command line, and <tt>FALSE</tt> otherwise.</p>
> <p><tt>const char *xf86GetServerName()</tt></p>
> <p>Returns the name of the X server from the command line.</p>
>
> This is marked up ~according to the linuxdoc DTD :-)
>
> I've no intention of working on it in this DTD,
> but when I get it across to docbook (x)
> I'd like to know how it should be marked up.
>
> funcdef ok for the function names,
> funcparams for -flippixels is my initial guess, I'd like it
> confirming please.
> I have the distinct feeling that they are related to function
> definitions rather than descriptions since they are part of
funcsynopsis
> , or am I being too pedantic?
>
> Any assistance appreciated.