From owner-freebsd-doc@FreeBSD.ORG Tue May 27 02:10:07 2003 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id BA66B37B404 for ; Tue, 27 May 2003 02:10:07 -0700 (PDT) Received: from gandalf.online.bg (gandalf.online.bg [217.75.128.9]) by mx1.FreeBSD.org (Postfix) with SMTP id 2238443FAF for ; Tue, 27 May 2003 02:10:03 -0700 (PDT) (envelope-from roam@ringlet.net) Received: (qmail 25574 invoked from network); 27 May 2003 09:03:33 -0000 Received: from office.sbnd.net (HELO straylight.ringlet.net) (217.75.140.130) by gandalf.online.bg with SMTP; 27 May 2003 09:03:33 -0000 Received: (qmail 24862 invoked by uid 1000); 27 May 2003 09:07:07 -0000 Date: Tue, 27 May 2003 12:07:06 +0300 From: Peter Pentchev To: Marc Fonvieille Message-ID: <20030527090706.GC513@straylight.oblivion.bg> Mail-Followup-To: Marc Fonvieille , Giorgos Keramidas , Tom Rhodes , freebsd-doc@freebsd.org, "Simon L. Nielsen" References: <200305231720.h4NHK72A016136@freefall.freebsd.org> <20030523180624.GA65833@nitro.dk> <20030523140657.4275dc72.trhodes@FreeBSD.org> <20030523205124.GH3794@nosferatu.blackend.org> <20030523230218.GE25642@gothmog.gr> <20030524081105.GA806@nosferatu.blackend.org> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="xesSdrSSBC0PokLI" Content-Disposition: inline In-Reply-To: <20030524081105.GA806@nosferatu.blackend.org> User-Agent: Mutt/1.5.4i cc: Giorgos Keramidas cc: Tom Rhodes cc: freebsd-doc@freebsd.org cc: "Simon L. Nielsen" Subject: Re: docs/52547: [patch] Cleanup of laptop article X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 27 May 2003 09:10:08 -0000 --xesSdrSSBC0PokLI Content-Type: text/plain; charset=windows-1251 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Sat, May 24, 2003 at 10:11:05AM +0200, Marc Fonvieille wrote: > On Sat, May 24, 2003 at 02:02:18AM +0300, Giorgos Keramidas wrote: > [...] > >=20 > > They're only useful if the article contains a "table of contents" near > > the top, or other parts of our docs want to refer to parts of the > > article. Then the links will be more sensible if we *do* use id=3D"" > > keywords. For instance, this is why I recently added id=3D"" parts to = all > > the
elements of the pr-guidelines article. > >=20 > > Having those id keywords there also has another advantage. People who > > link to the FreeBSD.org docs collection from external sites won't be > > surprised after a while to find that all their links point to the wrong > > and incomprehensible URI http://www.freebsd.org/.../lala.html#AE987623. > >=20 > > For an article that doesn't contain a TOC, I agree with Marc though. > > >=20 > True, some articles need the id thing, some others not. I thought the main reason for the push for 'id' attributes was not clarity, but removing the possibility for people to link to *outdated* information? If the 'x*.html' files change at each build (or at least, sometimes), then there is the chance that someone will link to a months-old version of the section, and thus give people outdated information. If the articles do have 'id' attributes, and generate sensible html-split filenames, then this kind of link would get the newest version of the section. Thus, IMHO, we really do want to put 'id' attributes on all (or at least, the top-level) sections... G'luck, Peter --=20 Peter Pentchev roam@ringlet.net roam@sbnd.net roam@FreeBSD.org PGP key: http://people.FreeBSD.org/~roam/roam.key.asc Key fingerprint FDBA FD79 C26F 3C51 C95E DF9E ED18 B68D 1619 4553 What would this sentence be like if it weren't self-referential? --xesSdrSSBC0PokLI Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.2 (FreeBSD) iD8DBQE+0yq67Ri2jRYZRVMRAnmzAKCJQVOj6jWaqJzbQkM7ekpqIZh3ywCeK2Np L0aNRLFo3FnBUqXMj2XGIUE= =9GPD -----END PGP SIGNATURE----- --xesSdrSSBC0PokLI--