From owner-freebsd-doc@FreeBSD.ORG  Mon Nov 17 14:05:50 2003
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
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 AD8D116A4CE; Mon, 17 Nov 2003 14:05:50 -0800 (PST)
Received: from pittgoth.com (14.zlnp1.xdsl.nauticom.net [209.195.149.111])
	by mx1.FreeBSD.org (Postfix) with ESMTP
	id B0C3A43F3F; Mon, 17 Nov 2003 14:05:46 -0800 (PST)
	(envelope-from trhodes@FreeBSD.org)
Received: from localhost (acs-24-154-239-203.zoominternet.net
	[24.154.239.203])
	by pittgoth.com (8.12.9/8.12.9) with SMTP id hAHM5hvd074536;
	Mon, 17 Nov 2003 17:05:44 -0500 (EST)
	(envelope-from trhodes@FreeBSD.org)
Date: Mon, 17 Nov 2003 17:05:41 -0500
From: Tom Rhodes <trhodes@FreeBSD.org>
To: "Simon L. Nielsen" <simon@FreeBSD.org>
Message-Id: <20031117170541.1a05bbb7.trhodes@FreeBSD.org>
In-Reply-To: <20031117215514.GB405@arthur.nitro.dk>
References: <1068365672.64416.2.camel@shumai.marcuscom.com>
	<20031109031918.40437858.trhodes@FreeBSD.org>
	<1068366438.64416.8.camel@shumai.marcuscom.com>
	<20031116173729.GC5895@electra.cse.Buffalo.EDU>
	<1069007319.3752.11.camel@shumai.marcuscom.com>
	<20031117043515.GA16285@electra.cse.Buffalo.EDU>
	<20031117213239.GA345@jenny.daemon.li>
	<1069104837.737.71.camel@gyros>
	<20031117215514.GB405@arthur.nitro.dk>
X-Mailer: Sylpheed version 0.9.6claws (GTK+ 1.2.10; i386-portbld-freebsd5.1)
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
cc: doc@FreeBSD.org
cc: Ken Smith <kensmith@cse.Buffalo.EDU>
cc: Joe Marcus Clarke <marcus@FreeBSD.org>
Subject: Re: DocBook help
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 17 Nov 2003 22:05:50 -0000

On Mon, 17 Nov 2003 22:55:15 +0100
"Simon L. Nielsen" <simon@freebsd.org> wrote:

> On 2003.11.17 16:33:57 -0500, Joe Marcus Clarke wrote:
> > On Mon, 2003-11-17 at 16:32, Josef El-Rayes wrote:
> > > Ken Smith <kensmith@cse.Buffalo.EDU> wrote:
> > > > On Sun, Nov 16, 2003 at 01:28:39PM -0500, Joe Marcus Clarke wrote:
> > > > 
> > > > > Yeah, that's fine.  Thanks!
> > > > 
> > > > How's this?  It's viewable in a very stripped-down web version at:
> > > > 
> > > > http://www.cse.buffalo.edu/~kensmith/FreeBSD/cluster_article.html
> > > > 
> > 
> > Fixed, thanks!
> 
> Now that we are at the little things... :-)
> 
> When you use the trademark entities in the body of the text, then the
> coresponding attributions entities should be used in the header.  Since you
> use sparc and i386 it should be like this:
> 
>     <legalnotice id="trademarks" role="trademarks">
>       &tm-attrib.freebsd;
>       &tm-attrib.intel;
>       &tm-attrib.sparc;
>       &tm-attrib.general;
>     </legalnotice>
> 
> I also noticed that there are some end-of-line whitespace in the SGML
> file which should be removed, and some spaces in the beginnig of lines,
> which should be tabs (see [1]).
> 
> [1] http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style.html#WRITING-STYLE-GUIDE

The primer could probably use a workover, although who has the time.

It should include information on some markup, information about the
trademarks, and a better explination of (and example) of adding a
chapter and using the article framework.  If any of these 'issues'
have been fixed, then please pardon my ignorance.

-- 
Tom Rhodes