Update Avoid Styles for Heading Text Issue Description #938
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
dmols
requested changes
Apr 18, 2024
translations/en.json
Outdated
| @@ -356,7 +356,7 @@ | |||
| "rule.desc.NoHeadings": "<p>If appropriate, add headings to the page to organize the content for sighted and <a href='https://en.wikipedia.org/wiki/Screen_reader' target='_blank'>screen reader</a> users. The headings should represent an accurate outline of the content</p>", | |||
| "rule.desc.ObjectMustContainText": "<p>Multimedia objects should be accompanied by a link to a transcript of the content.</p>", | |||
| "rule.desc.ObjectTagDetected": "<p>Multimedia embedded using the 'Object' tag may require the user to install a plugin for their web browser. This can create support and access issues for some users. Additionally, users on mobile devices may not be able to view the multimedia content at all. Consider using an alternative format that the user's browser can display natively.</p>", | |||
| "rule.desc.ParagraphNotUsedAsHeader": "<p>Bold and Italics are used to emphasize text, whereas headings are used to define the structure of the document. Headings like <code>h1-h6</code> are extremely useful for non-sighted users to navigate the structure of the page, and formatting a paragraph to just be big or bold, while it might visually look like a heading, does not make it one.</p>", | |||
| "rule.desc.ParagraphNotUsedAsHeader": "<p>Bold and Italics are used to emphasize text, whereas headings are used to define the structure of the document. Headings like <code>h1-h6</code> are extremely useful for non-sighted users to navigate the structure of the page, and formatting a paragraph to just be big or bold, while it might visually look like a heading, does not make it one. UDOIT has flagged this as a potential usage of style for document structure, please ensure that it is not the case.</p>", | |||
There was a problem hiding this comment.
Little nit-picky and might be overkill, but I feel this'll make it clearer to the user what they should look for in their html.
Suggested change
| "rule.desc.ParagraphNotUsedAsHeader": "<p>Bold and Italics are used to emphasize text, whereas headings are used to define the structure of the document. Headings like <code>h1-h6</code> are extremely useful for non-sighted users to navigate the structure of the page, and formatting a paragraph to just be big or bold, while it might visually look like a heading, does not make it one. UDOIT has flagged this as a potential usage of style for document structure, please ensure that it is not the case.</p>", | |
| "rule.desc.ParagraphNotUsedAsHeader": "<p>Bold and Italics are used to emphasize text, whereas headings are used to define the structure of the document. Headings like <code>h1-h6</code> are extremely useful for non-sighted users to navigate the structure of the page, and formatting a paragraph to just be big or bold, while it might visually look like a heading, does not make it one. UDOIT flagged this as a potential usage of style for document structure, please ensure that this is not the case when you review the html editor in the page.</p>", |
There was a problem hiding this comment.
I would probably say "please ensure that this is not the case when you review the content in the HTML editor" or something along those lines... I believe the acronym "HTML" has to be capitalized though.
|
When you get a chance, @taheralfayad , I left some notes. Let me know if you agree or disagree. Besides that minor input, the changes look great. |
dmols
approved these changes
Apr 30, 2024
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.
Kind of fixes #923. Change up the issue description to tell the user that UDOIT is not entirely sure that this is a usage of style for heading, but it is a good suspect.
An enhancing solution is absolutely needed for this issue.