@cindex \command -> @syncodeindex

[Graham Percival]

On 23-Oct-04, at 4:03 PM, Han-Wen Nienhuys wrote:

> address@hidden writes:
> > Good God, what on Earth for?  Why use @cindex for commands, when you
> > have @findex and @pindex (and @syncodeindex to put them all, each one
> > in the right typeface, in the same index, if you really need to)?
>
> @syncodeindex, that's a good one. I guess we will ask our
> Documentation Editor to convert the @cindex entries to the appropriate
> index command.

Is this still desired?


Eli Zaretskii wrote:
>   Compare yours
>
>     The command @refcommand{frob} frobnicates foo.
>
> with the more traditional
>
>     @findex frob
>     The command @code{frob} frobnicates foo.
>
> Where's the style, structure, and layout effects of using the macro?
> The only benefit of your method is that you don't need to write "frob"
> twice, but that is, in my experience, a poor reason to use a macro,
> since the disadvantages far outweigh the advantage.

Since our manual is so large, I think that not having to write "frob"
twice is a more significant advantage than Eli suggests it is.  In
addition to the ease of writing, having a single macro makes the
.lytex files more readable.

Shall I convert @cindex to @syncodeindex, instead of
@findex / @code{}   ?

Cheers,
- Graham