From owner-freebsd-doc@FreeBSD.ORG Tue Jul 13 02:35:22 2004 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: by hub.freebsd.org (Postfix, from userid 815) id 3C02716A4CF; Tue, 13 Jul 2004 02:35:22 +0000 (GMT) Date: Tue, 13 Jul 2004 02:35:22 +0000 From: Murray Stokely To: Tom Hukins , doc@freebsd.org, doceng@freebsd.org Message-ID: <20040713023522.GB85720@hub.freebsd.org> References: <20040712100256.GB3948@hub.freebsd.org> <20040712165338.GA16218@eborcom.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20040712165338.GA16218@eborcom.com> User-Agent: Mutt/1.4.1i X-GPG-Key-ID: 1024D/0E451F7D X-GPG-Key-Fingerprint: E2CA 411D DD44 53FD BB4B 3CB5 B4D7 10A2 0E45 1F7D Subject: Re: Split of Advanced Networking chapter of Handbook 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: Tue, 13 Jul 2004 02:35:22 -0000 On Mon, Jul 12, 2004 at 05:53:38PM +0100, Tom Hukins wrote: > I've been concerned for a while about the prevalance of TLAs here. > Sure, most users will know what DNS does, but maybe we should make > section titles more helpful by using something like: Yea I agree all the section names should be like your list. Some of them are already I think. > This way, users looking through the book's contents will have a > clearer idea of what different sections are about. Agreed. > Alternatively, this might be solved through adding index terms. > Opinions? If I don't hear any objections, I'll commit something along Index terms are something separate. Many terms are already there in both expanded and acronym form (possibly with a marker). The index terms may still need cleaning up, but that isn't a replacement for expanding section titles. There is space pressure to keep the index entries concise and so acronyms aren't as frowned upon in an index, I think. Four words like 'Network File System Server' is pushing the space limitation for two column index output in a book -- especially if you then have secondary index terms beneath it. > these lines. Please don't make this kind of commit until I do the split so that my patch will still apply cleanly. - Murray