docs: document gambit keyword localization and canonicalKey() pattern#524
Open
docs: document gambit keyword localization and canonicalKey() pattern#524
Conversation
Adds a dedicated 'Localizing gambit keywords' section to search.md covering how key() drives localized search tokens, the canonicalKey() English fallback, examples for both KeyValueGambit and BooleanGambit, toFilter() canonical value mapping, and a subsection for language pack maintainers. Adds a brief note in update-2_0.md flagging canonicalKey() as a required change for translated gambits. Adds a pointer in language-packs.md explaining gambit keyword translation keys.
3 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Documents the gambit localization alias feature introduced in flarum/framework#4570.
search.mdcoveringcanonicalKey(), examples for bothKeyValueGambitandBooleanGambit,toFilter()canonical value mapping, and a dedicated subsection for language pack maintainers with YAML locale examples.update-2_0.mdflaggingcanonicalKey()as a required change for any extension whose gambitkey()returns a translated string.language-packs.mdexplaining gambit translation keys and linking to the full technical reference.Test plan
// highlight-start/// highlight-endmarkers in code blocks and the:::infoadmonitionsearch#localizing-gambit-keywords,./search#gambits