From owner-freebsd-doc@FreeBSD.ORG Wed Jan 9 22:14:22 2013 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.FreeBSD.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id 15F149B4 for ; Wed, 9 Jan 2013 22:14:22 +0000 (UTC) (envelope-from wblock@wonkity.com) Received: from wonkity.com (wonkity.com [67.158.26.137]) by mx1.freebsd.org (Postfix) with ESMTP id B61C1149 for ; Wed, 9 Jan 2013 22:14:21 +0000 (UTC) Received: from wonkity.com (localhost [127.0.0.1]) by wonkity.com (8.14.6/8.14.6) with ESMTP id r09MEJZs005974; Wed, 9 Jan 2013 15:14:19 -0700 (MST) (envelope-from wblock@wonkity.com) Received: from localhost (wblock@localhost) by wonkity.com (8.14.6/8.14.6/Submit) with ESMTP id r09MEIXe005971; Wed, 9 Jan 2013 15:14:19 -0700 (MST) (envelope-from wblock@wonkity.com) Date: Wed, 9 Jan 2013 15:14:18 -0700 (MST) From: Warren Block To: Dru Lavigne Subject: Re: [patch] Quick Start Guide to FDP Primer In-Reply-To: <1357765738.95165.YahooMailClassic@web184902.mail.gq1.yahoo.com> Message-ID: References: <1357765738.95165.YahooMailClassic@web184902.mail.gq1.yahoo.com> User-Agent: Alpine 2.00 (BSF 1167 2008-08-23) MIME-Version: 1.0 Content-Type: TEXT/PLAIN; format=flowed; charset=US-ASCII X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.2.7 (wonkity.com [127.0.0.1]); Wed, 09 Jan 2013 15:14:19 -0700 (MST) Cc: freebsd-doc@freebsd.org X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 09 Jan 2013 22:14:22 -0000 On Wed, 9 Jan 2013, Dru Lavigne wrote: > Attached is the svn diff for proposed changes to the Quick Start Guide of the FDP Primer. Igor is mostly happy, except for a few tab indents I can't figure out. I see a few in the diff. When a tag is opened, the indent level is increased. In some long tags like ulink, this suprises people: + choice of two ports. If you install textproc/docproj-nojadetex, you The start of the second line is still inside the tag, so it should be indented: + choice of two ports. If you install textproc/docproj-nojadetex, you The closing tag is on the second line, so the indent goes back a level on the next line (not shown). > Note that this patch incorporates the information in the Tools section > into the Overview section. As a new user I got bitten by following the > Quick Start only to find that it did not mention all of the needed > tools until the next chapter. Tools was also quite redundant in the > docproj/jadetex discussion, none of which was mentioned in the earlier > Quick Start section. If accepted, the svn diff shows the removal of > Tools. The patch fails for me on tools/chapter.xml at line 0. > I tried to include in the Quick Start all of the info I could think of > to get a new user started and ready to go. The content should be > reviewed to make sure it isn't missing anything useful or suggests > something which isn't standard practice. A quick first glance would make me suggest using igor -R | less -RS. This shows the color highlights, which most people prefer. The plain ASCII alternate can be mentioned. I'll look at it in more depth later. > Thanks to bcr@ for his patience in getting my head wrapped around indentation. And thanks to you, also!