From: Lute Kamstra <Lute.Kamstra@cwi.nl>
Cc: bug-texinfo@gnu.org, emacs-devel@gnu.org
Subject: Re: Double hyphens in variable names.
Date: Thu, 02 Oct 2003 10:43:54 +0200 [thread overview]
Message-ID: <sgdvfr8c9md.fsf@occarina.pna.cwi.nl> (raw)
In-Reply-To: <uk77ogp4z.fsf@elta.co.il> (Eli Zaretskii's message of "02 Oct 2003 07:55:08 +0200")
Eli Zaretskii <eliz@elta.co.il> 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.
next prev parent reply other threads:[~2003-10-02 8:43 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2003-10-01 13:53 Double hyphens in variable names Lute Kamstra
2003-10-02 5:55 ` Eli Zaretskii
2003-10-02 8:43 ` Lute Kamstra [this message]
2003-10-02 13:18 ` Luc Teirlinck
2003-10-02 15:11 ` Lute Kamstra
2003-10-02 16:00 ` Luc Teirlinck
2003-10-02 16:14 ` Lute Kamstra
2003-10-02 16:54 ` Andreas Schwab
2003-10-02 17:25 ` Luc Teirlinck
2003-10-03 1:50 ` Luc Teirlinck
2003-10-03 2:13 ` Luc Teirlinck
2003-10-03 3:45 ` Luc Teirlinck
2003-10-02 19:04 ` Oliver Scholz
2003-10-03 8:39 ` Lute Kamstra
2003-10-03 16:18 ` Luc Teirlinck
2003-10-03 19:37 ` Lute Kamstra
2003-10-03 18:33 ` Luc Teirlinck
2003-10-03 18:42 ` Luc Teirlinck
2003-10-03 19:46 ` Lute Kamstra
2003-10-04 10:47 ` David Ponce
2003-10-06 7:11 ` Lute Kamstra
2003-10-06 23:19 ` Juri Linkov
2003-10-07 9:08 ` Lute Kamstra
2003-10-03 19:42 ` Richard Stallman
2003-10-03 21:19 ` Juri Linkov
2003-10-02 14:07 ` Luc Teirlinck
2003-10-02 19:15 ` Richard Stallman
2003-10-02 18:56 ` Kevin Rodgers
-- strict thread matches above, loose matches on Subject: below --
2003-10-04 1:03 Karl Berry
2003-10-04 3:51 ` Luc Teirlinck
2003-10-04 1:03 Karl Berry
2003-10-04 22:35 ` Richard Stallman
2003-10-05 0:53 ` Miles Bader
2003-10-05 10:36 ` Stepan Kasal
2003-10-05 8:34 ` Werner LEMBERG
2003-10-06 9:06 David PONCE
2003-10-06 9:18 ` Lute Kamstra
2003-10-07 5:32 ` Richard Stallman
2003-10-07 6:57 ` Lute Kamstra
2003-10-06 9:26 David PONCE
2003-10-07 7:57 David PONCE
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=sgdvfr8c9md.fsf@occarina.pna.cwi.nl \
--to=lute.kamstra@cwi.nl \
--cc=bug-texinfo@gnu.org \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).