Skip to content

Tildes in index entries #1064

Closed
Closed

Description

@tkoeppe

We use two distinct styles for multiword index entries, both pervasively:

  • \indextext{hello world}
  • \indextext{hello~world}

What is the purpose of the tilde? Does it have any special meaning in the index, or is it just a non-breaking space? In the latter case, why are we doing that? There seems to be no value in trying to force a particular (probably poor) line breaking decision on the already constrained index.

What's turning this question from a mere curiosity into a serious issue is that if you mix the two styles for the purportedly same entry term, you get two separate index entries, and moreover, the tilde collates differently from the space, producing a surprising index order.

Unless there's a good reason against it, I would recommend killing all those tildes.

Activity

  1. cpplearner commented on Nov 18, 2016

    @cpplearner
    Contributor

    dup/general case of #664

  2. tkoeppe commented on Nov 18, 2016

    @tkoeppe
    ContributorAuthor

    Yeah, we can keep both issues; #664 to fix existing double-indexing problems, and this one to decide on a single style.

  3. jensmaurer commented on Nov 20, 2016

    @jensmaurer
    Member

    See also #398.

  4. added
    decision-requiredA decision of the editorial group (or the Project Editor) is required.
    on Nov 23, 2016
  5. zygoloid commented on Dec 8, 2016

    @zygoloid
    Member

    I'm not aware of any reason for these tildes, and I'd be surprised if they're fixing a line-breaking issue in the index rather than causing one. Can you try stripping them (say, with sed) and see if there are any visual differences? If not, let's get rid of them all. (If there are differences, we'll need to understand why.)

  6. removed
    decision-requiredA decision of the editorial group (or the Project Editor) is required.
    on Dec 8, 2016
  7. tkoeppe commented on Dec 8, 2016

    @tkoeppe
    ContributorAuthor

    @jensmaurer: You are good with sed, right? Or @Eelis?

  8. self-assigned this
    on Dec 8, 2016
  9. added a commit that references this issue on Dec 8, 2016
    2b1af34
  10. added a commit that references this issue on Dec 8, 2016
    a67c0c4
  11. tkoeppe commented on Dec 8, 2016

    @tkoeppe
    ContributorAuthor

    Perfect, thanks! This even saves a page, thanks to deduplicating index entries.

  12. jensmaurer commented on Dec 8, 2016

    @jensmaurer
    Member

    Augmented "style guidelines" wiki page accordingly.

  13. tkoeppe commented on Dec 8, 2016

    @tkoeppe
    ContributorAuthor

    Thanked!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions