nvaccess/nvda

Structure issue in Change log after conversion from t2t to md

Opened this issue · 1 comments

There are various structure issues in the change log after the conversion from t2t to md file format, where nested lists are not nested anymore.

Here is an example with the first one.

Steps to reproduce:

Look at change log, in section 2022.2, subsection new feature, after item "New table navigation commands have been added."

Actual behavior:

The two following items are at the same level

Expected behavior:

The two following items should be a sublist of 2 items since these gestures are for table navigation.

NVDA logs, crash dumps and other attachments:

N/A

System configuration

NVDA installed/portable/running from source:

N/A

NVDA version:

2024.2beta3

Windows version:

N/A

Name and version of other software in use when reproducing the issue:

N/A

Other information about your system:

N/A

Other questions

Does the issue still occur after restarting your computer?

N/A

Have you tried any other versions of NVDA? If so, please report their behaviors.

  • Change log of NVDA 2023.3.4 is OK.
  • Change log of NVDA 2024.1 is NOK. It is the first release where t2t is converted to .md format.

If NVDA add-ons are disabled, is your problem still occurring?

N/A

Does the issue still occur after you run the COM Registration Fixing Tool in NVDA's tools menu?

N/A

Note

The issue is due to missing spaces in the indentation of the sublists.
The following regexp allows to find the location of such issues:

(?<=\n) (  )*(?! )

But one needs to look around these locations to find all the issues, in case of multiple list levels. I.e. this regexp is not enough to find and fix all the indentation issues automatically.

There are at least between 200 and 250 lines impacted. I may fix the issue in the English file. However, with the current translation system, this will lead to more than 200 new lines to translate for each translator. Instead, I imagine that when the change log has migrated to Crowdin, translators will not be impacted anymore with such structural change (e.g. add-on an indentation level on a list item). If it is confirmed, I'd rather wait for the migration to be complete before submitting a fix.
@michaelDCurran or @seanbudd what is your opinion on this? Or have you another idea?

However, with the current translation system, this will lead to more than 200 new lines to translate for each translator. Instead, I imagine that when the change log has migrated to Crowdin, translators will not be impacted anymore with such structural change (e.g. add-on an indentation level on a list item). If it is confirmed, I'd rather wait for the migration to be complete before submitting a fix.

We've generally avoided making changes to old sections of the changelog to avoid translators needing to retranslate, even for formatting issues.
I would say fixing this is now blocked on migrating to crowd-in, as we don't want to trigger a retranslation and unfortunately we've already switch to markdown as a source of truth.