Date: Sun, 4 Jul 1999 19:52:27 +0100 From: Nik Clayton <nik@nothing-going-on.demon.co.uk> To: Narvi <narvi@haldjas.folklore.ee> Cc: freebsd-doc@freebsd.org Subject: Re: DocBook questions Message-ID: <19990704195227.A71138@catkin.nothing-going-on.org> In-Reply-To: <Pine.BSF.3.96.990704111446.4929r-100000@haldjas.folklore.ee>; from Narvi on Sun, Jul 04, 1999 at 12:14:01PM %2B0300 References: <Pine.BSF.3.96.990704111446.4929r-100000@haldjas.folklore.ee>
next in thread | previous in thread | raw e-mail | index | archive | help
On Sun, Jul 04, 1999 at 12:14:01PM +0300, Narvi wrote:
> So I have read through the dpc project primer, the docbook User Guide (is
> it just me or isn't there really a port for this?) but I still have some
> questions:
>
> 1) #include header files - there is no way to mark up the fact that the
> thing at hand is a (possibly standard) header file. Should they be just
> marked up as files (<<filename>sys/queue.h</filename>>) or the
> status marked (<<filename role="C header">sys/queue.h</filename>>)
> or ????
In theory you could use the role attribute as you have done. So far I
haven't, reasoning that (a) it's probably overkill, and (b) we'd need to
come up with a long list of allowed roles, which I haven't given any
thought to.
For FDP stuff I'd recommend just using <filename>.
> 2) macros - there is only the <function> element, should macros be marked
> up as functions? eg.
> <para>The macro <function>SLIST_ENTRY</function> declares a
> structure that connects the elements in the list.</para>
Good question. Here a role attribute might be more appropriate, as
<function role="macro">, although a simple <function> is probably
sufficient.
> 3) data types, data structures and data structure elements?
In what context? In the middle of a paragraph I'd normally use
<literal>.
It might be worth asking these questions on the main DocBook mailing
list as well, davenport@berkshire.net, to see how other DocBook users
marked up the same information.
N
--
[intentional self-reference] can be easily accommodated using a blessed,
non-self-referential dummy head-node whose own object destructor severs
the links.
-- Tom Christiansen in <375143b5@cs.colorado.edu>
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19990704195227.A71138>