Backslash missing in the User Guide #17208
Comments
seanbudd
added
component/documentation
p3
|
@michaelDCurran I'd like to know your opinion on this topic give the recent discussion about escaped characters and poedit. Should all backslashes be escaped (i.e. doubled) in |
|
I think in future we should double all back slashes in the source english markdown files. Once pr #17214 is completed and merged to beta, I will then fix the one double back slash case you pointed out in the English user guide. |
|
@michaelDCurran |
|
i am working on this and using first possibility for now by fixing the sentence |
fixes issue #17208 Summary of the issue: Problem: The sentence originally read: "Normal backslashes in the Replacement field should thus be doubled, e.g., "a\b" should be typed to get the "a\b" replacement." In the HTML output, this rendered incorrectly as only one backslash (a\b), when two backslashes (a\b) were intended. Solution: The sentence was updated to correctly show double backslashes where needed: "Normal backslashes in the Replacement field should thus be doubled, e.g., "a\\b" should be typed to get the "a\b" replacement and "a\b" should be typed to get the "a\b" replacement. This ensures that two backslashes are correctly represented in both Markdown and HTML output
|
@seanbudd, shouldn't this issue remain opened? I am reopening the issue while waiting for the response from NV Access. |
|
hi @CyrilleB79 ok i will do what @michaelDCurran wants. |
|
Hey @seanbudd and @CyrilleB79 i have review all the languages user guides only one of this file has this error so i solved it again and now there was no backslash error in any userguide.md file |
|
@nakul-py, in the future, the goal is to double all the backslashes in .md files, not only for the sentence that you have already fixed. For non translatable documentation, this can be done immediately if you want. For translatable documentation, before submitting a PR, a strategy should be defined in order to minimize the work for translators. |
|
hey @CyrilleB79 in all .md files or in only all userguides file. |
|
Ideally, I guess, all .md files. But NV Access should confirm. |
|
Except translated .md files as written in #17316. |
|
Are we conscious of any other instances of this issue? There doesn't appear to be a simple regex to discover these. I am in favour of closing and opening new issues or PRs as these issues are found. |
|
Agreed |
and others
Steps to reproduce:
Look at User Guide, paragraph "12.2.2. Punctuation/symbol pronunciation"
Actual behavior:
There is the following sentence:
Expected behavior:
In the
.mdfile, the sentence is:So in the converted HTML, the two expressions should be "a\\b" and "a\b", I.e. two backslashes in the first expression.
Technical
From what I have seen about markdown, backslashes are used to escape special markdown characters. When we have two backslashes in a row, the first backslash is just used to escape the second one, i.e. the second one will be literally a backslash. Though, Markdown seems not to complain when backslash is used before a non-special character.
There are two possibilities:
My personal preference (being also a translator) is the first solution.
NVDA logs, crash dumps and other attachments:
N/A
System configuration
NVDA installed/portable/running from source:
N/A
NVDA version:
2024.4beta
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.
I suspect #15945 to have brought this regression.
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
The text was updated successfully, but these errors were encountered: