unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Van L <van@scratch.space>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 31576@debbugs.gnu.org
Subject: bug#31576: emacs-lisp-intro.texi - NAME, TITLE inconsistency among @node, @unnumberedsec
Date: Sat, 26 May 2018 14:32:31 +1000	[thread overview]
Message-ID: <9D16C302-4D1B-40B7-B0D0-150D547F312B@scratch.space> (raw)
In-Reply-To: <83muwpax1u.fsf@gnu.org>


> Eli Zaretskii writes:
> 
>> it makes sense why the node name is short, presentation-wise in the infopage. 
> 
> Yes, that's one of the aspects of a good Texinfo usage.
> 
>> A comment saying this is justified at the first instance will help future readers in the texi file.
> 
> I don't think this manual is a place to document that.  How to choose
> good node names is explained in the Texinfo manual, see the node "Node
> Names" there.
> 

diff --git a/doc/lispintro/emacs-lisp-intro.texi b/doc/lispintro/emacs-lisp-intro.texi
index b79432e..43a8e55 100644
--- a/doc/lispintro/emacs-lisp-intro.texi
+++ b/doc/lispintro/emacs-lisp-intro.texi
@@ -1054,6 +1054,13 @@ Lisp Lists
 * Typing Lists::                How GNU Emacs helps you type lists.
 @end menu
 
+@ignore
+The `node name' and `section title' vary. This is common.  The node
+name is shorter for presentation on Info page only. Further down are
+nodes for `typing lists' and `strange names' for comparison. How to
+choose good node names is explained in the Texinfo manual, see the
+node "Node Names" there.
+@end ignore
 @ifnottex
 @node Numbers Lists
 @unnumberedsubsec Numbers, Lists inside of Lists







  reply	other threads:[~2018-05-26  4:32 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-24  0:41 bug#31576: emacs-lisp-intro.texi - NAME, TITLE inconsistency among @node, @unnumberedsec Van L
2018-05-24  2:38 ` Eli Zaretskii
2018-05-24  2:47   ` Van L
2018-05-24  4:35     ` Eli Zaretskii
2018-05-24 11:51       ` Van L
2018-05-24 15:33         ` Eli Zaretskii
2018-05-26  4:32           ` Van L [this message]
2018-05-24  3:33   ` Van L
2018-05-24  4:29     ` Eli Zaretskii
2019-10-06  4:33 ` Stefan Kangas

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=9D16C302-4D1B-40B7-B0D0-150D547F312B@scratch.space \
    --to=van@scratch.space \
    --cc=31576@debbugs.gnu.org \
    --cc=eliz@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).