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:
| Which presumably means its a 'how to use' instance.

Right. A refentry is a higher-level structure, more akin to an article
or a chapter. In Unix references, there's generally one refentry per
"topic" (command, function, etc.) but that doesn't seem to address your
need for inline markup.

| The tdg examples appear way out (tdg\html\refentry.html)
| (no formatted output Norm?)

There's no formatted output in TDG for any of the elements that are
"page level". It could be done, of course, with images or something,
but at that level the designs vary so widely that it wasn't deemed
useful or necessary.

| 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.

|   <command moreinfo="none">xf86GetFlipPixels()</command>

That's a function, not a command.

|   <arg choice="opt" rep="norepeat">-flippixels</arg>

This is the odd part, -flippixels is clearly an option that you would
pass to the, um, xinit (?) program, but xf86GetFlipPixels must return
whether or not that option was set.

-flippixels is not properly an argument to xf86GetFlipPixels().

                                        Be seeing you,

Norman Walsh <ndw@nwalsh.com>      | The main difference between living
http://www.oasis-open.org/docbook/ | people and fictitious characters
Chair, DocBook Technical Committee | is that the writer takes great
                                   | pains to give the characters
                                   | coherence and inner unity, whereas
                                   | living people may go to extremes
                                   | of incoherence because their
                                   | physical existence holds them
                                   | together.--Hugo Von Hofmannsthal

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

Powered by eList eXpress LLC