Date: Wed, 25 Apr 2001 21:25:10 -0700 From: Dima Dorfman <dima@unixfreak.org> To: bmah@FreeBSD.ORG Cc: Nik Clayton <nik@FreeBSD.ORG>, doc@FreeBSD.ORG Subject: Re: rel.current entity for www/en a la Handbook Message-ID: <20010426042510.736893E2A@bazooka.unixfreak.org> In-Reply-To: <200104260336.f3Q3al231164@bmah-freebsd-0.cisco.com>; from bmah@FreeBSD.ORG on "Wed, 25 Apr 2001 20:36:47 -0700"
next in thread | previous in thread | raw e-mail | index | archive | help
bmah@FreeBSD.ORG (Bruce A. Mah) writes: > If memory serves me right, Dima Dorfman wrote: > > > How are you including the committers and manpages entities right now? > > Ideally, we would have something.ent which both relnotes and doc/ > > stuff would include; it'd contain things like rel.current, os, etc. > > This is a problem, however, because doc/ may not be accessable when > > relnotes are compiled. If the latter isn't true (i.e., the existence > > of doc/ is guaranteed), then having a generic entities file for this > > stuff would be nice. > > I need doc/ to build RENOTESng anyways, so availability is not a problem > (as you deduced, I am getting the committer and manpage entries from > there). Let me try expressing the problem again.... > > At this point in time, there is only one FAQ, one Handbook, and so on. > So these documents have only a single notion of what &rel.current; > should be (right now, it's 4.3-RELEASE). > > [ relnotes are branched ] Doh! I still have a problem realizing that relnotes are branched. Sorry :-/ Anyway, this problem isn't that hard to get around. Basically, we would have a global.ent file that defines rel.current to "4.3". Regular docs (Handbook, FAQ, et al) will do: <!ENTITY % global SYSTEM "path/to/global.ent"> %global; which will give a rel.current value of 4.3. We would also have a relnotes-specific entities file, which will define rel.current to "4.3" or "5.0" depending on the branch. Relnotes will do: <!ENTITY % relnotes.ents SYSTEM "path/to/relnotes-specific.ent"> %relnotes.ents; <!ENTITY % global SYSTEM "path/to/global.ent"> %global; which will give a rel.current value of whatever is in relnotes-specific.ent (assuming it defines it; it will default to whatever is in global.ent). I checked this, and SGML seems to DTRT in this kind of situation. global.ent can also define other things in terms of rel.current, and it will still have the right value. global.ent can define things like rel.current, os, and some of the other goodies I saw in your example. It doesn't need to define things like release.type (or whatever the name was; value was "snapshot" or "release"), since the regular docs don't care. But these are details which can be worked out later. The problem as I see it is that we don't just have doc/ and src/release: we have www/, too, which also needs rel.current et al (this thread was originally about www/, actually). Having doc/ doesn't imply having www/, and having www/ doesn't imply having doc/. And I can't think of a way to solve this one without replicating rel.current in, say, doc/share/sgml/global.ent and www/en/includes.sgml. Ideas? (I know this isn't strictly related to relnotes.) Thanks, Dima Dorfman dima@unixfreak.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?20010426042510.736893E2A>