[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Double hyphens in variable names.
From: |
Lute Kamstra |
Subject: |
Re: Double hyphens in variable names. |
Date: |
Thu, 02 Oct 2003 10:43:54 +0200 |
User-agent: |
Gnus/5.1003 (Gnus v5.10.3) Emacs/21.3.50 (gnu/linux) |
Eli Zaretskii <address@hidden> writes:
>> I'm trying to document the variable `imenu--index-alist' in the Lisp
>> Reference Manual. When I write this in the Texinfo source file:
>>
>> @defvar imenu--index-alist
>>
>> Texinfo produces an info file that has this:
>>
>> - Variable: imenu-index-alist
>>
>> Note that the double hyphen is reduced to a single hyphen. Am I
>> missing something, or is this a bug in Texinfo?
>
> Not a bug, but a feature. See the node "Conventions" in the Texinfo
> manual. In this case, you want to say
>
> @defvar imenu---index-alist
>
> (three dashes in a row).
I see; now it shows up right in the info file:
- Variable: imenu--index-alist
However, it generates this index entry:
* imenu---index-alist: Imenu.
Also, the dvi file shows a long dash as apposed to the desired two
hyphens.
Note that when I do:
@defvar @code{imenu--index-alist}
the double hyphens are handled properly in the sense that it shows up
in info as:
- Variable: `imenu--index-alist'
and in the info file's index as:
* imenu--index-alist: Imenu.
The dvi file shows two hyphens as well. The only problem, of course,
is that the variable name is surrounded by quotes in the info file and
is shown with a different font in the dvi file. I think that Texinfo
should be changed so that the @defvr command (I assume that @defvar is
defined in terms of @defvr) handles hyphens like @code.
Lute.
- Double hyphens in variable names., Lute Kamstra, 2003/10/02
- Re: Double hyphens in variable names., Eli Zaretskii, 2003/10/02
- Re: Double hyphens in variable names.,
Lute Kamstra <=
- Re: Double hyphens in variable names., Luc Teirlinck, 2003/10/02
- Re: Double hyphens in variable names., Lute Kamstra, 2003/10/02
- Re: Double hyphens in variable names., Luc Teirlinck, 2003/10/02
- Re: Double hyphens in variable names., Lute Kamstra, 2003/10/02
- Re: Double hyphens in variable names., Andreas Schwab, 2003/10/02
- Re: Double hyphens in variable names., Luc Teirlinck, 2003/10/02
- Re: Double hyphens in variable names., Luc Teirlinck, 2003/10/02
- Re: Double hyphens in variable names., Luc Teirlinck, 2003/10/02
- Re: Double hyphens in variable names., Luc Teirlinck, 2003/10/02
- Re: Double hyphens in variable names., Oliver Scholz, 2003/10/02