bug-texinfo
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Text decoration in node names and index entries


From: Gavin Smith
Subject: Text decoration in node names and index entries
Date: Fri, 3 Jul 2015 19:19:01 +0100

I'd like to propose that when @-commands that produce decoration
around text are used in node names or index entries, the decoration is
suppressed.

For example:

@node @samp{@@chapter}
@chapter @samp{@@chapter}

@findex @samp{@@chapter}

@samp{@@chapter}

@printindex fn

This gives the output:

File: index-decoration.info,  Node: '@chapter'

1 '@chapter'
************

'@chapter'

[inde]
* Menu:

* '@chapter':                            '@chapter'.            (line 6)

For comparison, the output of makeinfo 4.13 (using the --force option):

File: index-decoration.info,  Node: address@hidden'

1 address@hidden'
************

address@hidden'

[inde]
* Menu:

* @chapter:                              @chapter.              (line 8)

That didn't decorate in the index entry, but did in the node name.

And finally, with @documentencoding UTF-8:

File: index-decoration.info,  Node: â

1 â
************

â

[inde]
* Menu:

* â:                            â.            (line 6)

That was a Latin-1 terminal emulator: as you can see, the Unicode
quotes were used.

Undecorated index entries are better because they would allow typing
"info index-decoration @chapter" to jump to information about
@chapter, without the user worrying about whether it was in there as
'@chapter', address@hidden', or surrounded by Unicode quotes. It's better
for aggregating index entries from many manuals that may use different
character encodings, and also makes cross-references between different
Info files possible if they have different character encodings.

If we can agree this would be a good idea, I'll put it in the TODO file.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]