[ 
https://issues.apache.org/jira/browse/YETUS-457?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15474002#comment-15474002
 ] 

Allen Wittenauer commented on YETUS-457:
----------------------------------------

bq. I tested my example "Add missing <i> tag" outside RDM with pandoc and it 
passes the <i> through unescaped.

RDM already escapes <i> as \<i\>.  pandoc won't treat that as a HTML directive 
and will correctly put in the HTML entities in when converting.  You can see 
this in action with RELEASENOTES.0.17.0, HADOOP-2818 and lots of other places 
where angle brackets are already in use.  This particular use case came up very 
early when writing RDM because it was so prevalent. :)

bq. Regarding the JIRA IDs, sure we can not escape hyphen, but would you mind 
if I still changed write_list to not pass them through sanitize_text?

Sure.  But at a minimum, you'll need to convert to UTF-8....

Also, it looks like entries like [HOD] aren't being converted to links by 
pandoc, github, etc so we might be OK to let squares go through unchanged.

That said...

I think the list should be:

* add a conversion of ' to \'
* update the comments to make clear we're using MultiMarkdown and, if using 
pandoc, then use -f markdown_mmd.
* better comments and re-arranging the functions
* whatever you want to do with converting the URL to UTF-8.

Thanks.

> RDM does not properly escape entities
> -------------------------------------
>
>                 Key: YETUS-457
>                 URL: https://issues.apache.org/jira/browse/YETUS-457
>             Project: Yetus
>          Issue Type: Bug
>    Affects Versions: 0.3.0
>            Reporter: Andrew Wang
>            Assignee: Andrew Wang
>            Priority: Critical
>         Attachments: YETUS-457.001.patch, YETUS-457.002.patch
>
>
> Noticed while browsing the Hadoop 3.0.0-alpha1 changelog. Quotes and possibly 
> some other entities are not escaped properly, leading to malformed markdown 
> output.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to