all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* Re: Indices in Info.
@ 2003-06-24 13:26 Karl Berry
  2003-06-24 14:04 ` Andreas Schwab
  2003-06-25  1:35 ` Luc Teirlinck
  0 siblings, 2 replies; 10+ messages in thread
From: Karl Berry @ 2003-06-24 13:26 UTC (permalink / raw)


    > * $Id::                                  GNU Sample Texts.

I removed the :'s from these index entries in texinfo.txi.

    "Emacs should be able to handle this correctly" 

Yes it should.  Regardless of the (newline) example (see below),
consider this index entry:
@cindex (dir) as Up node of Top node

Here, the parentheses are meaningful and correct.  I could also imagine
wanting to index ( in a programming language manual.  I'm sure there are
other index entries that start with ( out there as well, since it's
always been allowed.

    or "starting an index entry with a parenthetical remark makes no sense"?  
    In this particular instance, it definitely would
    seem more logical to have entries named "newline", "space" and "tab",

This is in the command index.  The manual is not talking about a command
@newline.  It's talking about @<the-newline-character>.  That's why I
put the parentheses in.  I suppose angle brackets instead of parentheses
might be slightly better.  I changed it.

But that's irrelevant to the question of whether index entries can start
with (.  They should be able to.  And the leading parentheses work in
Emacs 21.3, at least they do for me.  So perhaps this got broken in the
current source code ...

    IMHO, these tricky cases should be solved by a change in the Info file
    format

Yes, I agree, as we've discussed before.  We shouldn't make complicated
rules about when colons are acceptable and when they're not, according
to the regexp du jour.  Instead, we should just support everything.

Until that glorious day arrives, I'm not worried about discrepancies
between emacs-info and standalone-info in this regard.  I don't see any
need to document exactly which cases work and which don't in which
reader, since it all changes from version to version anyway.

Thanks,
karl

^ permalink raw reply	[flat|nested] 10+ messages in thread
* Re: Indices in Info.
@ 2003-06-24 14:08 Karl Berry
  0 siblings, 0 replies; 10+ messages in thread
From: Karl Berry @ 2003-06-24 14:08 UTC (permalink / raw)
  Cc: emacs-devel

    The problem with that is that the info format does not have a way to quote
    special characters, so you will always come up with cases that fail.

Yes, and that is why the info format has to be changed.

^ permalink raw reply	[flat|nested] 10+ messages in thread
* Indices in Info.
@ 2003-06-24  3:42 Luc Teirlinck
  2003-06-24  4:17 ` Eli Zaretskii
  0 siblings, 1 reply; 10+ messages in thread
From: Luc Teirlinck @ 2003-06-24  3:42 UTC (permalink / raw)
  Cc: karl

Both Emacs Info and stand-alone Info have some trouble with various
index entries.  In many cases, the conclusion might be that we should
just "outlaw" such entries.

Problem 1: both Emacs and stand-alone, or maybe just texinfo.txi

g (texinfo)Concept Index

Click on:

* $Id::                                  GNU Sample Texts.

Result:

byte-code: No such anchor in tag table or node in tag table or file: $Id
(Emacs)

$Id: No such file or directory (stand-alone).

Proposed solution:  Just institute a convention that an index entry
should never end in a colon.  Those two colons in an index entry look
weird anyway, even if they would not produce a bug.  Of course, also
follow that convention.

Problem 2: Emacs, or maybe texinfo.txi

g (texinfo)Command and Variable Index

Click on:

* (newline):                             Multiple Spaces.

Result:

Info-find-node: Info file newline does not exist

Reason: Index entry starting with a parenthetical remark.

The stand-alone Info correctly visits Multiple Spaces.

What is the conclusion here: "Emacs should be able to handle this
correctly" or "starting an index entry with a parenthetical remark
makes no sense"?  In this particular instance, it definitely would
seem more logical to have entries named "newline", "space" and "tab",
rather than "(newline)", "(space)" and "(tab)".  (I guess these were
just typos, or not?)

Problem 3: No real problem but maybe worth mentioning. Also, should be
compared with problem 4.

I produced the following index for experimentation purposes:

Index
*****

* Menu:

* Aha: oho:                              Top.
* Oho:ihi:                               Top.


Both Emacs and stand-alone fail to visit "Top" in the first entry. Of
course, no bug, but it might be worth emphasizing in 
(texinfo)Index Entries that an index entry should *never* contain a
colon followed by a space or tab.

Problem 4:

Emacs visits Top in the _second_ entry above, stand-alone Info does not.

>From info.el:

;;  - a menu item MAY contain colons but not colon-space ": "
;;  - a menu item ending with ": " (but not ":: ") is an index entry
;;  - a node name MAY NOT contain a colon
;; This distinction is to support indexing of computer programming
;; language terms that may contain ":" but not ": ".


If it is worth while for Emacs Info to support those computer
programming language terms, it might also be worth while for the
stand-alone version to do so.  People constructing index entries do so
for both versions, so one should be consistent.

All conventions we decide on for index entries could be described in
(texinfo)Index Entries.

Sincerely,

Luc.

^ permalink raw reply	[flat|nested] 10+ messages in thread

end of thread, other threads:[~2003-06-25 19:53 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2003-06-24 13:26 Indices in Info Karl Berry
2003-06-24 14:04 ` Andreas Schwab
2003-06-25  1:35 ` Luc Teirlinck
2003-06-25  1:55   ` Luc Teirlinck
2003-06-25  3:26     ` Luc Teirlinck
2003-06-25 17:50     ` Stefan Monnier
2003-06-25 19:53   ` Richard Stallman
  -- strict thread matches above, loose matches on Subject: below --
2003-06-24 14:08 Karl Berry
2003-06-24  3:42 Luc Teirlinck
2003-06-24  4:17 ` Eli Zaretskii

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.