unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Alan Mackenzie <acm@muc.de>
Cc: emacs-devel@gnu.org
Subject: Re: Info bug with @xref{Sample .emacs File, , , ccmode, the CC Mode Manual}.
Date: Mon, 12 Dec 2005 09:32:55 +0000 (GMT)	[thread overview]
Message-ID: <Pine.LNX.3.96.1051212091512.422B-100000@acm.acm> (raw)
In-Reply-To: <m1Elc1c-0004STC@rattlesnake.com>

Hi, Robert!

On Mon, 12 Dec 2005, Robert J. Chassell wrote:

>   ... We've had a node called "Sample .emacs File" in the CC Mode
>   manual since 22nd February 1995 ...

>And possibly Info searched for that node as "Sample" ...  That is the
>only node in that manual that starts with the word "Sample".

>The Texinfo manual has included a warning about the characters that a
>node name may contain since at least 1987 and probably earlier.  I don't
>remember dot specifically, but I do remember thinking that the rule was
>to use characters that are not in regexps.

OK.  The warning in that manual is somewhat inconspicuous.  On the page
"node" we have:

      To create a node, write an `@node' command at the beginning of a
    line, and follow it with up to four arguments, separated by commas, on
    the rest of the same line.

, with no mention of colons, parens or periods.  In the sub-node
"Choosing Node and Pointer Names", there is no mention of the
restriction.  Only in (the relatively obscurely named) "Node Line
Requirements" is this restriction mentioned.  This seems suboptimal.

>In any event, the customary solution is to name the node and the title
>differently.  As is said in  (texinfo)Node Line Tips , `try to pick node
>names that are informative but short'.  The node name might be `Sample'
>and the chapter or section title `Sample @code{.emacs} File'.

OK, thanks.

>    Robert J. Chassell                         

-- 
Alan Mackenzie (Munich, Germany)

  reply	other threads:[~2005-12-12  9:32 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-12-11 18:37 Info bug with @xref{Sample .emacs File, , , ccmode, the CC Mode Manual} Alan Mackenzie
2005-12-11 19:58 ` Eli Zaretskii
2005-12-11 21:28   ` Alan Mackenzie
2005-12-12  0:58     ` Robert J. Chassell
2005-12-12  9:32       ` Alan Mackenzie [this message]
2005-12-12 20:59         ` Eli Zaretskii
2005-12-12  5:23     ` Richard M. Stallman
2005-12-12  5:39     ` Eli Zaretskii
2005-12-12 23:44       ` Karl Berry

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=Pine.LNX.3.96.1051212091512.422B-100000@acm.acm \
    --to=acm@muc.de \
    --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).