[
https://issues.apache.org/jira/browse/MCHANGES-466?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17927837#comment-17927837
]
Elliotte Rusty Harold commented on MCHANGES-466:
------------------------------------------------
In general I'm very skeptical of copying markup from an XML document as plain
text. There are about 1000 ways for this to go wrong and it usually does. Maybe
this is one of the rare cases where this makes. However, I'd like to consider
whether this might be adding one problem on top of another, rather than fixing
the original problem.
Perhaps the changes plugin should be putting raw text into changes.xml instead
of HTML or other markup. E.g. should it be writing <p> instead of <p>?
They are not the same thing. If it writes the former. then this can be copied
straight into a plain text document with the expected result.
> Add optional parameter passRawText
> ----------------------------------
>
> Key: MCHANGES-466
> URL: https://issues.apache.org/jira/browse/MCHANGES-466
> Project: Maven Changes Plugin
> Issue Type: New Feature
> Reporter: Stefan Seifert
> Priority: Major
>
> By default, all text read from changes.xml is interpreted as plaint text, and
> transferred 1:1 to the generated changes reports, which is most times HTML,
> but can also be other formats like PDF. Thus any HTML markup that is included
> in changes.xml is not treated as markup but as plain text, even if HTML
> output is generated.
> Goal of this ticket is to introduced a new parameter {{passRawText}} for the
> {{changes}} goal, which passes the text contained in changes XML as "raw
> text" to Doxia, allowing HTML markup contained in changes.xml to be
> transferred 1:1 to the output, thus being interpreted as HTML markup in HTML
> output. The parameter is set to false by default. I has to be documented
> clearly to the user that setting this parameter to true will break any
> non-HTML output, so users should use it with care.
> If enabled, and if only HTML output is used, setting the parameter to true
> allows to use advanced formatting/markup in the changes reports like:
> * Links (anchor tags)
> * Simple formatting like bold and italics to highlight important things in
> the changelog
> ---
> This new feature is a replacement for the {{escapeHTML}} parameter, which was
> present in changes plugin version 2.x and was removed for 3.x as it was
> marked as deprecated a long time ago.
> Technically, an implementation for this new feature is quite similar to
> reverting PRs https://github.com/apache/maven-changes-plugin/pull/54 and
> https://github.com/apache/maven-changes-plugin/pull/48, but using a different
> parameter name and inverse parameter meaning. An integration test should be
> added as well.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
