Skip to content

Set HTML lang and dir attribute for documentation#14546

Merged
seanbudd merged 1 commit into
masterfrom
addDirAndLangToDocs
Mar 27, 2023
Merged

Set HTML lang and dir attribute for documentation#14546
seanbudd merged 1 commit into
masterfrom
addDirAndLangToDocs

Conversation

@seanbudd

@seanbudd seanbudd commented Jan 16, 2023

Copy link
Copy Markdown
Member

Link to issue number:

Supersedes #13133
Closes #8856 with nvaccess/mrconfig#83

Summary of the issue:

The generated HTML from t2t (changes, quick reference, user guide) has no lang attribute set.
So, it will not read in the correct TTS language.
Right to left languages also do not render correctly without an dir="rtl" attribute.

Description of user facing changes

When translators add values to the attributes, the correct TTS language will be used when reading NVDA documentation and the layout direction of text will be appropriate.

Description of development approach

Testing strategy:

Check generated .html files in user_docs/en

Known issues with pull request:

None

Change log entries:

None

Code Review Checklist:

  • Pull Request description:
    • description is up to date
    • change log entries
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • API is compatible with existing add-ons.
  • Documentation:
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • Security precautions taken.

@Qchristensen Qchristensen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work Sean! Users will appreciate this.

@seanbudd seanbudd removed the blocked label Mar 24, 2023
seanbudd added a commit to nvaccess/mrconfig that referenced this pull request Mar 24, 2023
Closes nvaccess/nvda#14169
Relates to nvaccess/nvda#8856, and closes the issue with nvaccess/nvda#14546

locale.t2tconf allows translators to set the locale and layout direction of NVDA user documentation
locale.t2tconf files cannot be modified by translators, and are expected to be modified in the main NVDA repository.
This is an unexpected workflow for translators, they should be able to push changes to locale.t2tconf.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

HTML "lang" & "dir" attributes are missing in the NVDA documentations for some languages

4 participants