Provide option to link to TW word definitions online. Closes #321 - #322
Merged
PurpleGuitar merged 3 commits intoJul 10, 2026
Conversation
…Associates#321 By default this is now True rather than including TW word definitions in generated documents.
PurpleGuitar
reviewed
Jul 9, 2026
| ) | ||
| + "</ul>", | ||
| is_rtl=is_rtl, | ||
| use_section_visual_separator=False, |
Contributor
There was a problem hiding this comment.
Were these lines deleted on purpose? It seems like we would still need them if link_rather_than_include_tw_definitions is reset to false at some point in the future.
Contributor
Author
There was a problem hiding this comment.
Thanks for catching that, unintentional. I did a bit of clean up too.
Contributor
There was a problem hiding this comment.
It appears this is a <ul> element containing <span> elements. Usually <ul> should contain <li> elements -- consider wrapping the <span>...</span> in <li>...</li>.
Contributor
Author
There was a problem hiding this comment.
Thanks for this catch too, I did a bit of clean up too.
…S is False Fixed issue raised in code review. Also clean up code a bit to remove magic strings
PurpleGuitar
merged commit Jul 10, 2026
7aec71f
into
WycliffeAssociates:doc-dev.walink.org
8 checks passed
github-project-automation
Bot
moved this from In progress
to Done
in DOC Project Management
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
2 participants
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.
WIth this PR, online translation word definitions, at BIEL, are linked from each chapter's list of translation words (in the generated document) rather than including TW word definitions in generated documents.
Please note: The linking does not happen at the individual word level, but rather opens BIEL to the language's TW page which features a drop down to select which specific word. Why? At first we tried to implement per word direct links (for the basic case it works), but there were inconsistencies in how BIEL generates HTML IDs for each word in a way that made it not tractable within budget. It is presumed that the current implementation (in this update), because BIEL offers the dropdown, will suffice. A change back to including translation word definitions in the generated document is still possible if this ever were to change requirements as it is controlled by a program configuration variable.