From owner-freebsd-doc Fri Feb 23 7:18:18 2001 Delivered-To: freebsd-doc@freebsd.org Received: from njord.bart.nl (njord.bart.nl [194.158.170.15]) by hub.freebsd.org (Postfix) with ESMTP id DC9B137B401; Fri, 23 Feb 2001 07:18:13 -0800 (PST) (envelope-from asmodai@wxs.nl) Received: from daemon.chronias.ninth-circle.org (root@cable.ninth-circle.org [195.38.232.6]) by njord.bart.nl (8.10.1/8.10.1) with ESMTP id f1NFI9l74038; Fri, 23 Feb 2001 16:18:10 +0100 (CET) Received: (from asmodai@localhost) by daemon.chronias.ninth-circle.org (8.11.2/8.11.0) id f1NFHnB37500; Fri, 23 Feb 2001 16:17:49 +0100 (CET) (envelope-from asmodai) Date: Fri, 23 Feb 2001 16:17:49 +0100 From: Jeroen Ruigrok/Asmodai To: Nik Clayton Cc: Murray Stokely , freebsd-doc@freebsd.org Subject: Re: Indexing the Handbook Message-ID: <20010223161749.E35087@daemon.ninth-circle.org> References: <20010223144043.A46865@canyon.nothing-going-on.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.2i In-Reply-To: <20010223144043.A46865@canyon.nothing-going-on.org>; from nik@freebsd.org on Fri, Feb 23, 2001 at 02:40:43PM +0000 Organisation: Ninth-Circle Enterprises Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org -On [20010223 11:30], Nik Clayton (nik@freebsd.org) wrote: >On Thu, Feb 22, 2001 at 05:59:04PM -0800, Murray Stokely wrote: > >My main concern is that in talking with a few people at various >conventions it seems that getting a good index involves more than just >sprinkling liberally around the document. > >I've got no idea how we select good terms to index, and again, the >feedback I've had suggests that it's much more an art than a science. >Which probably means we can't write rules and procedures for it :-) You are so true in that aspect. Indexing is Black Art. >Do we also run the risk of having lots of different index terms, all >subtly different? I don't know. One of the reasons we need to use standard terms? :) >What are the {Linux,Gnome,KDE} Documentation Projects doing about this, >if anything? I am unsure. I am checking the GDP at this moment and the others this weekend and I'll report my findings. >Is this something we could use entities for? > > "stack frame"> > >and then write > > &index.p.stack_frame; > >As I say, I don't know. I have to say I actually like that. The good part about the entity solution is that it doesn't clutter the flow of the text (much). Hmmm, I know vim pulls in autocompletion for C source files through the #include'd files, let's see if I can do the same for SGML files. That would at least ease writing for me/vim using doccers. -- Jeroen Ruigrok vd Werven/Asmodai asmodai@[wxs.nl|bart.nl|freebsd.org] Documentation nutter/C-rated Coder BSD: Technical excellence at its best D78D D0AD 244D 1D12 C9CA 7152 035C 1138 546A B867 I'm a child of the air, I'm a witch of the wind... To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message