HTML: Assign glossary terms with grouping keys to single-character groupings #12862
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This fixes a bug where previously the `category_key` -- an optional grouping that can be specified on glossary terms -- was used directly as the group name to place terms within in the generated HTML index. The fix re-uses a similar logic flow as used in `_key_func_1`, where the `category_key` is used to derive (but not as an absolute source of) the index group.
The grouping key (`category_key`) from glossary terms is used to decide what symbol/character to group the corresponding terms into. However: the terms are not guaranteed to begin with the same symbol as the `category_key`. This code therefore places them into a nested definition entry in the index, with the complete `category_key` as the parent label. Relates to commit 4255bbe.
|
Is there anyone who could help me confirm whether this would introduce a significant functionality regression for Japanese-language projects in particular? When I was browsing through the test cases, I remember finding some fixtures that suggested that these glossary terms can be useful to select multi-symbol headings. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Purpose
glossaryitems by a single-character symbol instead of grouping key (when present).Detail
category_key-- the entire grouping key name -- and using that as a heading to place glossary terms under, instead derive a single-character symbol fromcategory_key._key_func_1function.Concerns
Relates
Screenshots
Before (en)
After (en)
Edit: fixup: I'd uploaded an incorrect after-fix sample image, containing a made-up
fooonfermion in the glossary. That is now corrected.