TOOLSDEV-385: Add translate="no" attribute to code and pre elements #136
Conversation
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
This commit adds the `translate="no"` attribute to both inline code elements and code blocks to prevent machine translation tools from attempting to translate code snippets. Changes include: 1. Added `translate="no"` attribute to code blocks in block_listing.html.erb 2. Added `translate="no"` attribute to inline code elements in inline_quoted.html.erb 3. Added comprehensive tests to verify the attribute is correctly applied: - Test for inline code elements verifies the attribute is present on <code> tags - Test for code blocks verifies the attribute is present on <pre> tags with data-type="programlisting"
This commit adds the `translate="no"` attribute to block literal templates to prevent machine translation tools from attempting to translate content within literal blocks. Literal blocks are typically used for command output, log files, and other pre-formatted text where exact spacing and formatting must be preserved. Changes include: - Added `translate="no"` attribute to the <pre> element in block_literal.html.erb - Added a comprehensive test in htmlbook_spec.rb to verify the attribute is correctly applied to literal blocks delimited with `....` This change complements the previous commits that added the same attribute to: 1. Inline code elements (via inline_quoted.html.erb) 2. Code blocks (via block_listing.html.erb) Together, these changes ensure that all code-like content throughout the documentation is excluded from translation by browser-based translation tools and other translation services, preserving the integrity of code examples, command output, and other technical content.
delfanbaum
approved these changes
May 5, 2025
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.
QAed on Staging. This does prevent machine translation on the Platform without causing any problems I could find.
Prod Merge for #134 and #135