indexterm

[setantae]

Quick question :

Can I use anything I like within indexterm ?

For example, if the below was committed :

<indexterm>
<primary>Foo</primary>
<secondary>Bar</secondary>
<secondary>Quux</secondary>
</indexterm>

would it break anything ?

If there's a list I have to choose from, where can I find it ?
(grepping for indexterm has given me a headache)

Ceri

--
keep a mild groove on

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

[Murray Stokely]

On Mon, Nov 26, 2001 at 03:30:59PM +0000, setantae wrote:
> Can I use anything I like within indexterm ?

No. You must use <primary>, <secondary>, <tertiary>, <see>, or
<seealso>. See http://www.docbook.org/tdg/en/html/indexterm.html for
the complete semantics.

Inside those tags you can use additional markup, such as <command>
so that we could perhaps have commands followed by ", command" in
the index as is popular in some American technical books (and Greg
Lehey's Complete FreeBSD).

> For example, if the below was committed :
>
> <indexterm>
> <primary>Foo</primary>
> <secondary>Bar</secondary>
> <secondary>Quux</secondary>
> </indexterm>
>
> would it break anything ?

You could always just try. ;) I don't think this will validate.
You need a separate indexterm/primary for each secondary. Even if
that primary is identical.

- Murray