docs/52547: [patch] Cleanup of laptop article

[Giorgos Keramidas]

On 2003-05-23 22:51, Marc Fonvieille <blackend at freebsd.org> wrote:
>On Fri, May 23, 2003 at 02:06:57PM -0400, Tom Rhodes wrote:
>>On Fri, 23 May 2003 20:06:28 +0200 "Simon L. Nielsen" <simon at nitro.dk> wrote:
>>>On 2003.05.23 10:20:07 -0700, Marc Fonvieille wrote:
>>>>On Thu, May 22, 2003 at 01:45:04AM +0200, Simon L.Nielsen wrote:
>>>>> General cleanup of the laptop article :
>>>>>
>>>>> * Add id attributes to all sect1 tags
>>>>
>>>>  This is far to be mandatory on a so little article.
>>>
>>> Hmm, from following the this mailling list I got the impression that the
>>> section id tags was a good idea on all books/articles, since it makes
>>> sensible filenames when doing html-split output ?
>>
>> I'm going to agree with ceri (and keramida?) about this.  Personally,
>> I think using id attributes in articles is a Good Thing™.
>
> I think for a short article, id attributes could be in some ways
> useless since it's more annoying to read the html-split than the plain
> one... :)

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.

Just my two eurocents...

- Giorgos

-------------- 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/20030524/813fbfa4/attachment.sig>