Skip to content

Fixup norwegian user guide#16002

Merged
seanbudd merged 2 commits intobetafrom
fixNoUg
Jan 4, 2024
Merged

Fixup norwegian user guide#16002
seanbudd merged 2 commits intobetafrom
fixNoUg

Conversation

@seanbudd
Copy link
Copy Markdown
Member

@seanbudd seanbudd commented Jan 3, 2024

Link to issue number:

None

Summary of the issue:

Formatting issues in the Norwegian user guide caused it not build correctly.
This causes fatal errors when building key commands file

See examples:

Description of user facing changes

Fix formatting for user guide and key commands file

Description of development approach

Line endings are normalized - please view whitespace ignoring diff

Testing strategy:

Test building docs with #15945

Known issues with pull request:

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 a review from a team as a code owner January 3, 2024 06:27
@seanbudd seanbudd requested a review from gerald-hartig January 3, 2024 06:27
@seanbudd seanbudd changed the base branch from master to beta January 3, 2024 06:28
@seanbudd seanbudd added this to the 2024.1 milestone Jan 3, 2024
@seanbudd seanbudd merged commit cccd6a5 into beta Jan 4, 2024
@seanbudd seanbudd deleted the fixNoUg branch January 4, 2024 02:59
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.
Adriani90 pushed a commit to Adriani90/nvda that referenced this pull request Mar 13, 2024
None

Summary of the issue:
Formatting issues in the Norwegian user guide caused it not build correctly.
This causes fatal errors when building key commands file

See examples:

https://www.nvaccess.org/files/nvda/releases/2023.3/documentation/nb_NO/userGuide.html#MicrosoftSpeechPlatform
https://www.nvaccess.org/files/nvda/releases/2023.3/documentation/nb_NO/userGuide.html#GeneralSettings
Description of user facing changes
Fix formatting for user guide and key commands file

Description of development approach
Line endings are normalized - please view whitespace ignoring diff
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.
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.

2 participants