GNU bug report logs - #31576
emacs-lisp-intro.texi - NAME, TITLE inconsistency among @node, @unnumberedsec

Previous Next

Full log

View this message in rfc822 format

From: Van L <van <at> scratch.space>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 31576 <at> 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

> 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

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.