Date: Wed, 25 Apr 2001 10:44:00 +0100 From: Nik Clayton <nik@freebsd.org> To: www@freebsd.org, dd@freebsd.org Cc: doc@freebsd.org Subject: Re: rel.current entity for www/en a la Handbook Message-ID: <20010425104400.A81151@canyon.nothing-going-on.org> In-Reply-To: <20010425080356.D33653E2C@bazooka.unixfreak.org>; from dima@unixfreak.org on Wed, Apr 25, 2001 at 01:03:56AM -0700 References: <20010425080356.D33653E2C@bazooka.unixfreak.org>
next in thread | previous in thread | raw e-mail | index | archive | help
--dDRMvlgZJXvWKvBx Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Wed, Apr 25, 2001 at 01:03:56AM -0700, Dima Dorfman wrote: > In order to simplify trasitioning from one release to another, I think > the web site could use an entity similar to &rel.current; that the > Handbook uses. From looking at includes.sgml it looks like something > like this has been attempted (see a.latest.ann and a.latest.not > entities), but died off (the aforementioned entities still point to > 3.4!). Makes sense. <snip> > Any objections to me committing this some time this week? A couple of comments on the patch; > +<!-- The currently released version of FreeBSD. This value is used to > + create some links on web sites and such, so do NOT change it until > + it's really release time, and don't forget to update a similar > + definition in the Handbook. --> > +<!ENTITY rel.current '4.3'> > + > <!-- Short names for various anchor points --> > -<!ENTITY a.latest.not '<a href=3D"&base/releases/3.4R/notes.html">'> > -<!ENTITY a.latest.ann '<a href=3D"&base/releases/3.4R/announce.html">'> > +<!ENTITY a.latest.not '<a href=3D"&base/releases/&rel.current;R/notes.ht= ml">'> > +<!ENTITY a.latest.ann '<a href=3D"&base/releases/&rel.current;R/announce= .html">'> > +<!ENTITY a.latest.errata '<a href=3D"&base/releases/&rel.current;R/errat= a.html">'> I think we should standardise these across the doc/ and www/ trees. As it stands, I'm not happy with a.latest.not and a.latest.ann, those should be spelled out in full (a.latest.notes, a.latest.announce). There's a "problem" with your entity definitions. You haven't included the ';' at the end of "&base". This won't generate an error, because the SGML parser 'knows' that '/' is not a valid character in an entity name, so it closes it for you, but it's questionable practice, and may confuse people who know less about SGML wondering why we use ';' in some cases and not in others. Best to be completely consistent. Rather than being anchors, perhaps they should just be URLs, so the lines become something like <!ENTITY u.latest.notes '&base;/releases/&rel.current;R/notes.html'> ... Perhaps "u.release." would be a better 'root' for the entity names? > <!-- macro for webbuild paper -->=20 > Index: index.sgml > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > RCS file: /st/src/FreeBSD/www/en/index.sgml,v > retrieving revision 1.110 > diff -u -r1.110 index.sgml > --- index.sgml 2001/04/22 05:22:04 1.110 > +++ index.sgml 2001/04/25 02:45:01 > @@ -131,13 +131,13 @@ > <td> > <table width=3D"100%" cellpadding=3D2 cellspacing=3D0 = border=3D0 bgcolor=3D"#ffcc66"> > <tr> > - <td align=3D"center"><b>Current Release: 4.3</b><b= r> > - <small><a > - href=3D"&base;/releases/4.3R/announce.html">An= nouncement</a> > + <td align=3D"center"><b>Current Release: &rel.curr= ent;</b><br> > + <small>&a.latest.ann;Announcement</a> That line would become <small><a href=3D"&u.latest.announce">Announcement</a> and similarly for the others. > · <a > href=3D"&base;/handbook/install.html">Instal= lation > - Guide</a> · <a > - href=3D"&base;/releases/4.3R/errata.html">Er= rata</a></small></td> > + Guide</a> · &a.latest.errata;Errata</= a> > + </small> > + </td> > </tr> > </table> > </td> > Index: releases/index.sgml > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > RCS file: /st/src/FreeBSD/www/en/releases/index.sgml,v > retrieving revision 1.53 > diff -u -r1.53 index.sgml > --- releases/index.sgml 2001/04/22 17:49:53 1.53 > +++ releases/index.sgml 2001/04/25 02:45:02 > @@ -16,11 +16,11 @@ > <a name=3D"current"></A> > <h2>Current Release(s)</h2> > =20 > -<p><b>Release 4.3</b> (April, 2001) > +<p><b>Release &rel.current;</b> (April 2001) > <em> > -<A HREF=3D"./4.3R/announce.html">Announcement</A> : > -<A HREF=3D"./4.3R/notes.html">Release Notes</A> : > -<A HREF=3D"./4.3R/errata.html">Errata</A> > +<A HREF=3D"./&rel.current;R/announce.html">Announcement</A> : > +<A HREF=3D"./&rel.current;R/notes.html">Release Notes</A> : > +<A HREF=3D"./&rel.current;R/errata.html">Errata</A> And this would change similarly. N --=20 FreeBSD: The Power to Serve http://www.freebsd.org/ FreeBSD Documentation Project http://www.freebsd.org/docproj/ --- 15B8 3FFC DDB4 34B0 AA5F 94B7 93A8 0764 2C37 E375 --- --dDRMvlgZJXvWKvBx Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.0.4 (FreeBSD) Comment: For info see http://www.gnupg.org iEYEARECAAYFAjrmnGAACgkQk6gHZCw343U/jQCePLpYTQcpY7ELRscQMedUSwA/ 1HQAn2Tsq3qLoOB2YttY/BpoDG5Xzur/ =J/VY -----END PGP SIGNATURE----- --dDRMvlgZJXvWKvBx-- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-www" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010425104400.A81151>