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

Index all mentions of a grammarterm? #1452

Closed
jensmaurer opened this issue Feb 9, 2017 · 3 comments
Closed

Index all mentions of a grammarterm? #1452

jensmaurer opened this issue Feb 9, 2017 · 3 comments
Assignees

Comments

@jensmaurer
Copy link
Member

As an experiment, I have equipped \grammarterm with adding an index entry. The BNF definitions are in bold. Example:

grammar

Is that a direction to pursue?

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Feb 9, 2017
@AlisdairM
Copy link
Contributor

I like it - if for no other reason than it highlights capitalization issues, like for Class-specifier above.

More seriously, not being a core expert, I have gone reaching for this kind of tool many times - it would be extremely helpful to find it one day.

@jensmaurer
Copy link
Member Author

jensmaurer commented Mar 2, 2017

Editorial committee consensus: This approach is good. Fix intro text. (Do not remove grammar names from main index.) This makes it easy to see where we screw up. Try to also add index entries for grammar terms used in the definition of other grammar terms.

@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Mar 2, 2017
@jensmaurer
Copy link
Member Author

"Try to also add index entries for grammar terms used in the definition of other grammar terms." is mighty hard, because we just mention other non-terminals inside a bnf environment, without further markup which we could hook with creating index entries.

We could define a short markup such as \nt{blah} inside bnf environments for the non-terminals, but we would still need to manually iterate through all grammar snippets to add the markup. Postponed until #1821 has been resolved.

@jensmaurer jensmaurer self-assigned this Nov 30, 2017
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

2 participants