feat: make speaker notes translatable (fixes #1390) - #3274
Open
hazelzimuto wants to merge 1 commit into
Open
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
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.
Description
This PR resolves the issue where Speaker Notes strings were hardcoded in theme/speaker-notes.js, making them inaccessible to the mdbook-i18n-helpers gettext translation workflow.
Approach
Because xgettext extraction natively targets the markdown content, I integrated the strings into the existing translation pipeline:
Preprocessor HTML Injection: Modified mdbook-course to append a hidden div with the id speaker-notes-translations containing the required UI strings to the end of each chapter's content stream.
Translation Extraction: Because the strings are now embedded in the markdown stream, mdbook-i18n-helpers will automatically extract them into messages.pot for translators.
Dynamic UI Updates: Updated theme/speaker-notes.js to look for this injected div. If found, it dynamically extracts the translated textContent and updates the UI buttons and headings accordingly, falling back to English gracefully if not found.
This ensures translators can continue using their standard .po files without needing to touch JavaScript files.
Strings localized:
"Close speaker notes"
"Speaker Notes"
"Speaker Notes for"
"Could not open popup, please check your popup blocker settings."