docs/52547: [patch] Cleanup of laptop article

[Peter Pentchev]

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:
> [...]
> > 
> > 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=""
> > keywords.  For instance, this is why I recently added id="" parts to all
> > the <section> elements of the pr-guidelines article.
> > 
> > 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.
> > 
> > For an article that doesn't contain a TOC, I agree with Marc though.
> >
> 
> 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

-- 
Peter Pentchev	roam at ringlet.net    roam at sbnd.net    roam at 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?
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20030527/2b760cb4/attachment.sig>