Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tildes in index entries #1064

Closed
tkoeppe opened this issue Nov 17, 2016 · 8 comments
Closed

Tildes in index entries #1064

tkoeppe opened this issue Nov 17, 2016 · 8 comments
Assignees

Comments

@tkoeppe
Copy link
Contributor

tkoeppe commented Nov 17, 2016

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.

@cpplearner
Copy link
Contributor

dup/general case of #664

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Nov 18, 2016

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

@jensmaurer
Copy link
Member

See also #398.

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Nov 23, 2016
tkoeppe pushed a commit that referenced this issue Dec 1, 2016
@zygoloid
Copy link
Member

zygoloid commented Dec 8, 2016

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.)

@zygoloid zygoloid removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Dec 8, 2016
@tkoeppe
Copy link
Contributor Author

tkoeppe commented Dec 8, 2016

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

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Dec 8, 2016

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

@jensmaurer
Copy link
Member

Augmented "style guidelines" wiki page accordingly.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Dec 8, 2016

Thanked!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants