From owner-freebsd-doc Sun Jul 4 14:47:59 1999 Delivered-To: freebsd-doc@freebsd.org Received: from nothing-going-on.demon.co.uk (nothing-going-on.demon.co.uk [193.237.89.66]) by hub.freebsd.org (Postfix) with ESMTP id CDDA6150B6 for ; Sun, 4 Jul 1999 14:47:39 -0700 (PDT) (envelope-from nik@nothing-going-on.demon.co.uk) Received: (from nik@localhost) by nothing-going-on.demon.co.uk (8.9.3/8.9.2) id TAA76660; Sun, 4 Jul 1999 19:52:28 +0100 (BST) (envelope-from nik) Date: Sun, 4 Jul 1999 19:52:27 +0100 From: Nik Clayton To: Narvi Cc: freebsd-doc@freebsd.org Subject: Re: DocBook questions Message-ID: <19990704195227.A71138@catkin.nothing-going-on.org> References: Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Mailer: Mutt 0.95.4i In-Reply-To: ; from Narvi on Sun, Jul 04, 1999 at 12:14:01PM +0300 Organization: Nik at home, where there's nothing going on Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org 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 (<sys/queue.h>) or the > status marked (<sys/queue.h>) > 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 . > 2) macros - there is only the element, should macros be marked > up as functions? eg. > The macro SLIST_ENTRY declares a > structure that connects the elements in the list. Good question. Here a role attribute might be more appropriate, as , although a simple 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 . 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