Skip to content

Remove locale.t2tconf files and references#15981

Merged
seanbudd merged 5 commits intobetafrom
removeLocaleConf
Jan 10, 2024
Merged

Remove locale.t2tconf files and references#15981
seanbudd merged 5 commits intobetafrom
removeLocaleConf

Conversation

@seanbudd
Copy link
Copy Markdown
Member

@seanbudd seanbudd commented Dec 29, 2023

Link to issue number:

Follow up to #15945

Summary of the issue:

locale.t2tconf files are no longer required. Setting the language code and direction will happen using custom rules in #15945 when converting markdown to HTML

Description of user facing changes

None once #15945 is merged

Description of development approach

locale.t2tconf files were removed.
References were also removed.
When saving documents, VS code automatically fixed whitespace issues like mixed line endings.
The diff should be viewed with "ignore whitespace" on.

Testing strategy:

Tested generating correct language and direction codes in #15945

Known issues with pull request:

None

Code Review Checklist:

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

@seanbudd seanbudd requested review from a team as code owners December 29, 2023 00:05
@seanbudd seanbudd requested review from Qchristensen and gerald-hartig and removed request for a team December 29, 2023 00:05
@seanbudd seanbudd marked this pull request as draft December 29, 2023 00:05
@seanbudd seanbudd added this to the 2024.1 milestone Dec 29, 2023
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Jan 8, 2024
seanbudd added a commit that referenced this pull request Jan 9, 2024
Closes #8734
Part of #15014
Related nvaccess/nvda-misc-deps#30, #16002, #15950, #15939, #15981

Summary of the issue:
In order to migrate to Crowdin, we must convert txt2tags to markdown.
In order transition safely, beta will build docs from t2t to markdown to html.
Eventually the t2t will be removed and the markdown will become the source of truth.

Description of user facing changes
The user Guide no longer has numbered sections

Translators and documentation writers now use extended markdown syntax rather than txt2tags.

Description of development approach
The build system performs certain pre-processing and post-processing when converting t2t to HTML.
This equivalent system should be retained - i.e. the translator and documentation contribution experience should remain the same for markdown to HTML.
Additionally, when converting t2t to markdown, new processing rules had to be created.

There is no universal standard for custom anchors in markdown.
As such text2tags doesn't have default rules for this. To retain our custom anchors, I added rules for a common markdown extended syntax.
Similarly a shortcut is used for generating table of contents.
See nvaccess/nvda-misc-deps#30

Setting the language code is done using the user_docs folder name, and the direction of RTL is manually set for the 3 current languages that require it, Persian, Arabic, Hebrew.

Special Catalan processing for adding hreflang attributes is converted to a markdown extension syntax of {hreflang=en}

The key commands file is generated using a custom made markdown python extension.
@seanbudd seanbudd marked this pull request as ready for review January 9, 2024 23:01
@seanbudd seanbudd removed the blocked label Jan 9, 2024
@seanbudd seanbudd merged commit 0b5154d into beta Jan 10, 2024
@seanbudd seanbudd deleted the removeLocaleConf branch January 10, 2024 00:05
Adriani90 pushed a commit to Adriani90/nvda that referenced this pull request Mar 13, 2024
Closes nvaccess#8734
Part of nvaccess#15014
Related nvaccess/nvda-misc-deps#30, nvaccess#16002, nvaccess#15950, nvaccess#15939, nvaccess#15981

Summary of the issue:
In order to migrate to Crowdin, we must convert txt2tags to markdown.
In order transition safely, beta will build docs from t2t to markdown to html.
Eventually the t2t will be removed and the markdown will become the source of truth.

Description of user facing changes
The user Guide no longer has numbered sections

Translators and documentation writers now use extended markdown syntax rather than txt2tags.

Description of development approach
The build system performs certain pre-processing and post-processing when converting t2t to HTML.
This equivalent system should be retained - i.e. the translator and documentation contribution experience should remain the same for markdown to HTML.
Additionally, when converting t2t to markdown, new processing rules had to be created.

There is no universal standard for custom anchors in markdown.
As such text2tags doesn't have default rules for this. To retain our custom anchors, I added rules for a common markdown extended syntax.
Similarly a shortcut is used for generating table of contents.
See nvaccess/nvda-misc-deps#30

Setting the language code is done using the user_docs folder name, and the direction of RTL is manually set for the 3 current languages that require it, Persian, Arabic, Hebrew.

Special Catalan processing for adding hreflang attributes is converted to a markdown extension syntax of {hreflang=en}

The key commands file is generated using a custom made markdown python extension.
Adriani90 pushed a commit to Adriani90/nvda that referenced this pull request Mar 13, 2024
Follow up to nvaccess#15945

Summary of the issue:
locale.t2tconf files are no longer required. Setting the language code and direction will happen using custom rules in nvaccess#15945 when converting markdown to HTML

Description of user facing changes
None once nvaccess#15945 is merged

Description of development approach
locale.t2tconf files were removed.
References were also removed.
When saving documents, VS code automatically fixed whitespace issues like mixed line endings.
The diff should be viewed with "ignore whitespace" on.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants