[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [help-texinfo] @cindex \command

From: Eli Zaretskii
Subject: Re: [help-texinfo] @cindex \command
Date: Sun, 24 Oct 2004 06:38:37 +0200

> Date: Sun, 24 Oct 2004 01:05:54 +0200
> From: Han-Wen Nienhuys <address@hidden>
> Cc: Jan Nieuwenhuizen <address@hidden>, address@hidden,
>         address@hidden
> > And why the macro? is it only to avoid typing the command name one
> > more time or am I missing something?
> Because we want to have some flexibility in how we structure and
> layout the document. Using a macro for every concept makes sure that
> each concept uses a uniform style across the manual, and it makes
> changing styles easy.

I see no style issues here, nor structure nor layout: the macro does
not affect the text of the document in any way.  All it does is make
sure the index entry and the text refer to the same name in the same
typeface.  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.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]