From: Eli Zaretskii <eliz@gnu.org>
To: Glenn Morris <rgm@gnu.org>
Cc: 15038@debbugs.gnu.org
Subject: bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Wed, 07 Aug 2013 19:40:58 +0300 [thread overview]
Message-ID: <83a9ktv4h1.fsf@gnu.org> (raw)
In-Reply-To: <4y61vhmp8f.fsf@fencepost.gnu.org>
> From: Glenn Morris <rgm@gnu.org>
> Cc: dmoncayo@gmail.com, 15038@debbugs.gnu.org
> Date: Wed, 07 Aug 2013 12:37:20 -0400
>
> Eli Zaretskii wrote:
>
> > I think Dany is describing the way Emacs displays that node, not the
> > exact text in the Info file.
>
> Standalone info seems to handle it fine.
It uses a different way of finding the end of a node name (which OTOH
fails in some cases Emacs doesn't).
> > The problem is in the Texinfo sources: a node name cannot include a
> > period, see the Texinfo manual.
>
> ./misc/org.texi:@node org-crypt.el, , Interaction, Miscellaneous
> ./misc/edt.texi:@node edt-user.el
> ./misc/epa.texi:@node Encrypting/decrypting *.gpg files
> ./misc/cc-mode.texi:@node Sample .emacs File, Performance Issues, Odds and Ends, Top
> ./misc/mairix-el.texi:@node About mairix and mairix.el
> ./misc/mairix-el.texi:@node Setting up mairix.el
> ./misc/mairix-el.texi:@node Using mairix.el
> ./misc/mairix-el.texi:@node Extending mairix.el
They are all in error. From the Texinfo manual:
* Unfortunately, you cannot reliably use periods, commas, or colons
within a node name; these confuse the Info reader. Also, a node
name may not start with a left parenthesis preceding a right
parenthesis, as in '(not)allowed', since this syntax is used to
specify an external manual. (Perhaps these limitations will be
removed some day.)
If you insist on using these characters in node names, accepting
the resulting substandard Info output, in order not to confuse the
Texinfo processors, you must still escape those characters, by
using either special insertions (*note Inserting a Comma::) or
'@asis' (*note @asis::). For example:
@node foo@asis{::}bar
As an example of avoiding the special characters, the following is
a section title in this manual:
@code{@@unnumberedsec}, @code{@@appendixsec}, @code{@@heading}
But the corresponding node name lacks the commas (and the '@''s,
but that is historical):
unnumberedsec appendixsec heading
next prev parent reply other threads:[~2013-08-07 16:40 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-08-06 21:38 bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun" dmoncayo
2013-08-06 23:23 ` Glenn Morris
2013-08-07 3:56 ` Eli Zaretskii
2013-08-07 14:00 ` Eli Zaretskii
2013-08-07 16:37 ` Glenn Morris
2013-08-07 16:40 ` Eli Zaretskii [this message]
2013-08-07 16:47 ` Glenn Morris
2013-08-07 17:39 ` Eli Zaretskii
2013-08-07 16:41 ` Glenn Morris
2013-08-07 18:54 ` Dani Moncayo
2013-08-07 18:54 ` Dani Moncayo
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=83a9ktv4h1.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=15038@debbugs.gnu.org \
--cc=rgm@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).