Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 10 Apr 2002 09:20:02 +0100
From:      Ceri Davies <setantae@submonkey.net>
To:        Murray Stokely <murray@FreeBSD.org>
Cc:        doc@FreeBSD.org
Subject:   Re: FAQ and Indexterm finished
Message-ID:  <20020410082002.GB71876@submonkey.net>
In-Reply-To: <20020409212304.GC22329@freebsdmall.com>
References:  <20020409171830.GA65916@submonkey.net> <20020409212304.GC22329@freebsdmall.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On Tue, Apr 09, 2002 at 02:23:04PM -0700, Murray Stokely wrote:
> On Tue, Apr 09, 2002 at 06:18:30PM +0100, Ceri Davies wrote:
> > Big ol' patch at http://www.submonkey.net/patches/faq.full.diff
> 
>   I think a lot of these secondary indexterms are unnecessary.  For
> example, IOMega Zip Drive, etc.  That's not really a high level topic
> with lots of subtopics.  I would change some of those very specific
> things to just primaries without a secondary indexterm.  If you look
> in a normal book index, you will see mostly primary indexterms and
> indexterms with secondary entries are usually in the minority.  In
> this patch, they make up 100% of the indexterms, which is not ideal.
> <secondary> and <tertiary> are available when the organization of the
> content requires it -- you shouldn't feel obligated to give every
> index term a two-tier designation.

Good point.

>   I think sendmail should be a primary, not a secondary under
> software.  Somewhere under the "mail" or "email" entries there should
> be a <seealso> to sendmail.  grep the Handbook for examples of usage.

There are <seealso>'s ?!  Dammit, that's handy!

>   It is much more likely that someone is going to look under sendmail
> for this information in the Index.  For some of these, you may want to
> add a <see> or <seealso> element to the index easier to follow.
> 
> > I realise that it's not the most beautiful thing ever, but if I
> > get this in, then I'll be more than happy to see people help out
> > with tidying it up.
> 
>   It's great work, so feel free to commit it with or without my
> suggestion above.

No, in light of the <seealso>'s I'm going to redo it, I think.
I can do it better with those.

Thanks,

Ceri

-- 
get the cool shoe shine

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20020410082002.GB71876>