fix: correct broken backslash display and enhance escape characters section#514
fix: correct broken backslash display and enhance escape characters section#514CybotTM wants to merge 2 commits intoTYPO3-Documentation:mainfrom
Conversation
…ection The :rst: text role cannot render a lone backslash because `\` before the closing backtick is interpreted as an escape sequence by the RST parser. Replace with inline literal (double backticks) and add more escape examples. Relates: TYPO3-Documentation#507
Consolidate escape examples into a single code block with rendered output below, following the source/result pattern used elsewhere in the cheat sheet.
|
I would say a hint to " :rst:` |
|
I have tested my original commit. And it also works. Shouldn't it be mentioned as a second alternative? Then everyone can choose his preferred way.
|
IF finally works, which will take some time as it is complicated. We can easily update the docs. Giving a hint that something will work in the future does not really help, does it? |
|
I think it helps to add the hint about the future for persons who are learning by reading the Docs. Then they get prepared already. |
AFAIK there is not even a decision currently if it will be fixed. |
Summary
:rst:text role with inline literal (double backticks) which renders correctlyContext
PR #507 attempted to fix the backslash display by using the
:rst:text role, but as confirmed by @franzholz and @ineswillenbrock, the backslash is still not rendered.Root cause: A backslash immediately before the closing backtick is consumed by the RST parser as an escape sequence — the text role handler never receives it. See upstream issue: TYPO3-Documentation/render-guides#1188
Fix: Use inline literal markup instead, which handles the backslash correctly:
Test plan