[jira] [Closed] (MCHANGES-466) Add optional parameter escapeText

["Slawomir Jaranowski (Jira)" <ji...@apache.org>]

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

Slawomir Jaranowski closed MCHANGES-466.
----------------------------------------
    Fix Version/s: 3.0.0-M3
       Resolution: Fixed

> Add optional parameter escapeText
> ---------------------------------
>
>                 Key: MCHANGES-466
>                 URL: https://issues.apache.org/jira/browse/MCHANGES-466
>             Project: Maven Changes Plugin (Moved to GitHub Issues)
>          Issue Type: New Feature
>            Reporter: Stefan Seifert
>            Priority: Major
>             Fix For: 3.0.0-M3
>
>
> 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 {{escapeText}} for the {{changes}} goal which is true by default. If set to false the text contained in changes XML is passed 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. 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 disabled, and if only HTML output is used, setting the parameter to false 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. An integration test should be added as well.



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