[jira] [Resolved] (DOXIA-770) MarkdownSink: Only escape when necessary

["Konrad Windszus (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/DOXIA-770?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Konrad Windszus resolved DOXIA-770.
-----------------------------------
    Resolution: Fixed

Fixed in https://github.com/apache/maven-doxia/commit/41a51b4eecf20096d6ae8121fcba386ca5efd785 and https://github.com/apache/maven-doxia/commit/612f82c2e7e5047e20c53550c66879ace6d9afc2

> MarkdownSink: Only escape when necessary 
> -----------------------------------------
>
>                 Key: DOXIA-770
>                 URL: https://issues.apache.org/jira/browse/DOXIA-770
>             Project: Maven Doxia
>          Issue Type: Improvement
>            Reporter: Konrad Windszus
>            Assignee: Konrad Windszus
>            Priority: Major
>             Fix For: 2.1.0
>
>
> Currently all characters which can be escaped in markdown are escaped. This should be improved so that characters are only escaped when necessary. This requires evaluation of the context. Compare with https://github.com/jgm/pandoc/issues/6259.
> ||Character||Escaping condition||
> |backslash|Always|
> |`|When otherwise may be interpreted as inline code|
> |underscore|When otherwise be interpreted as italic|
> |curly braces|Never(https://meta.stackexchange.com/a/29067)|
> |square brackets|When otherwise may be interpreted as link, reference, footnote or image|
> |parentheses|When otherwise may be interpreted as inline link or image|
> |hash|When otherwise may be interpreted as header (those can be used at the beginning or end of line)|
> |*|Inside unordered lists or when otherwise be misinterpreted as horizontal rule|
> |+|Inside unordered lists|
> |-|Inside unordered lists or when otherwise be misinterpreted as horizontal rule|
> |.|Inside ordered lists|
> |!|When otherwise be interpreted as image|



--
This message was sent by Atlassian Jira
(v8.20.10#820010)