From owner-freebsd-doc@FreeBSD.ORG Fri May 23 11:17:50 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 0FFF137B404 for ; Fri, 23 May 2003 11:17:50 -0700 (PDT) Received: from pittgoth.com (14.zlnp1.xdsl.nauticom.net [209.195.149.111]) by mx1.FreeBSD.org (Postfix) with ESMTP id B745343F75 for ; Fri, 23 May 2003 11:17:48 -0700 (PDT) (envelope-from trhodes@FreeBSD.org) Received: from mobile.pittgoth.com (acs-24-154-229-196.zoominternet.net [24.154.229.196]) by pittgoth.com (8.12.9/8.12.9) with SMTP id h4NIHlQd089860; Fri, 23 May 2003 14:17:47 -0400 (EDT) (envelope-from trhodes@FreeBSD.org) Date: Fri, 23 May 2003 14:06:57 -0400 From: Tom Rhodes To: "Simon L. Nielsen" Message-Id: <20030523140657.4275dc72.trhodes@FreeBSD.org> In-Reply-To: <20030523180624.GA65833@nitro.dk> References: <200305231720.h4NHK72A016136@freefall.freebsd.org> <20030523180624.GA65833@nitro.dk> X-Mailer: Sylpheed version 0.8.10claws (GTK+ 1.2.10; i386-portbld-freebsd5.1) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit cc: freebsd-doc@FreeBSD.org 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: Fri, 23 May 2003 18:17:50 -0000 On Fri, 23 May 2003 20:06:28 +0200 "Simon L. Nielsen" wrote: > On 2003.05.23 10:20:07 -0700, Marc Fonvieille wrote: > > The following reply was made to PR docs/52547; it has been noted by GNATS. > > > > 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™. > > This change was inspired by the 'Avoid redundant phrases' part of the > "Writing style" section of FDP... Is I reading that section wrong, or is > the FDP Primer just not updated with current pratice ? The FDP needs a few touch ups here and there. Yet, busy as we are, we simply cannot do it all. Even though we try, and a good handful of us are zealots when it comes to FreeBSD and its documentation; we are very likely to get behind. > > Thanks, for taking the time to comment so detailed on the patch! It > helps me a lot in getting to know all the do's and don'ts about the > documentation. > Education comes with time. While working through the PR base, you will learn (as I did, and many before me) the traditions and standard practices of the documentation project. Its a long road to walk, and true that the FDP can teach you how to use docbook; mdoc(7) can teach you mdoc(7); but they cannot just hand you experiance. Thats what the PR base gives you. Anyways, I've got a ton of work todo; both for FreeBSD && ${REALJOB}. Take care, -- Tom Rhodes