Date: Tue, 11 May 1999 08:15:47 -0400 (EDT) From: John Baldwin <jobaldwi@vt.edu> To: nclayton@lehman.com Cc: Kevin Lo <kevlo@hello.com.tw>, freebsd-doc@FreeBSD.ORG, Nik Clayton <nik@nothing-going-on.demon.co.uk>, John Baldwin <jobaldwi@vt.edu> Subject: Re: FAQ team. Message-ID: <XFMail.990511081547.jobaldwi@vt.edu> In-Reply-To: <19990511103045.P14492@lehman.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On 11-May-99 nclayton@lehman.com wrote: > On Mon, May 10, 1999 at 06:59:56PM -0400, John Baldwin wrote: >> On 10-May-99 Nik Clayton wrote: >> > Not yet. I haven't looked seriously at DocBook 3.1 yet, which is what >> > we'll do the FAQ in. 3.1 has a new qandaset element (and subelements) >> > for marking up FAQs. >> >> Do we want to change /usr/doc/share/sgml/freebsd.dtd to use 3.1 and get rid >> of >> the FAQ* entries from it or would you rather move the FreeBSD specifics out >> into another file that freebsd.dtd and freebsd-faq.dtd (or >> freebsd-31.dtd or something) include? > > I'm not quite sure I understand. > > I'm going to get a repository copy done of freebsd.dtd to > freebsd-docbook-300.dtd. Then I'll update the catalog file to point to > that for the FPI "-//FreeBSD//DTD DocBook V3.0-Based Extension//EN". > > Then I'll create freebsd-docbook-310.dtd, based on DocBook 3.1, and > create an FPI for that, which will probably be > > "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" > > That way we can have 3.0 and 3.1 based documents co-existing in the > tree. As soon as that's done we can then use both DTDs without fear of > them clashing. I will strip the FAQ* elements out of both DTDs. Works for me, that was my second idea, except that I was figuring we could have a SGML file that we included into both of them that held all of the extensions common to both, e.g. prompt entitites, so that you only had to change one file to update both DTD's. You could call it freebsd.ent and then the two freebsd.dtd's would reduce to something like: <!-- Pull in the original DTD --> <!ENTITY % orig-docbook PUBLIC "-//Davenport//DTD DocBook V3.0//EN"> %orig-docbook; <!-- Pull in FreeBSD extensions --> <!ENTITY % freebsd-extensions SYSTEM "freebsd.ent"> %freebsd-extensions; Since you have stuff both before and after the orig-docbook lines in freebsd.dtd I suppose you might have to create two files, freebsd-pre.ent and freebsd-post.ent or something similar. Then all you would have to change for freebsd-docbook-310.dtd simply by changing the FPI for orig-docbook. If it is too much hassle and the FreeBSD extensions are nailed down and not going to change, then don't worry about it, 'twas just a suggestion. :) >> > If anyone wants to experiment with this, here's a very quick sample of >> > how it might be used. Make sure you've got the docbook-310 port >> > installed for this. Notice how one question can have several answers >> > attached to it. This could be very useful for including multiple answers >> > depending on the FreeBSD version in use; you could use the "os" attribute >> > to differentiate between them. >> >> Spiffy. Would we be better off doing it by hand or by using the >> linuxdoc-to-handbook script you referred to earlier? > > I wouldn't recommend doing it by hand. Look at > > http://www.freebsd.org/cgi/cvsweb.cgi/doc/en/handbook/Attic/README?rev=1.66 > > for an idea of how I did the Handbook. Ok, thanks. > Note that I've not (yet) finalised the directory tree I want to use for > doc/*, because I hadn't considered character encoding in my last message. > I'll be writing a message to -doc about this soon, inviting further comment. > > N --- John Baldwin <jobaldwi@vt.edu> -- http://members.freedomnet.com/~jbaldwin/ PGP Key: http://members.freedomnet.com/~jbaldwin/pgpkey.asc "Power Users Use the Power to Serve!" - http://www.freebsd.org 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?XFMail.990511081547.jobaldwi>