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.


Check te <refentry> element. Perhaps you find more options there to play
with.

Regards,

Juan R. Migoya

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.


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


Powered by eList eXpress LLC