You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2010/12/31 15:48:58 UTC

svn commit: r1054123 - in /maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes: ChangesMojo.java ChangesReportGenerator.java

Author: dennisl
Date: Fri Dec 31 14:48:58 2010
New Revision: 1054123

URL: http://svn.apache.org/viewvc?rev=1054123&view=rev
Log:
[MCHANGES-190] HTML in changes.xml stopped working.

Modified:
    maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java
    maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java

Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java?rev=1054123&r1=1054122&r2=1054123&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java Fri Dec 31 14:48:58 2010
@@ -133,6 +133,25 @@ public class ChangesMojo
     private String teamlist;
 
     /**
+     * Whether HTML code within an action should be escaped. By changing this to
+     * <code>false</code> you can restore the behavior that was in version 2.2
+     * of this plugin, allowing you to use HTML code to format the content of an
+     * action.
+     * <p>
+     * <strong>Note:</strong> If you use HTML code in an action you need to
+     * place it inside a CDATA section.
+     * </p>
+     * <strong>Note:</strong> Putting any kind of markup inside a CDATA section
+     * might mess up the Changes Report or other generated documents, such as
+     * PDFs, that are based on your <code>changes.xml</code> file if you are not
+     * careful.
+     *
+     * @parameter default-value="true"
+     * @since 2.4
+     */
+    private boolean escapeHTML;
+
+    /**
      * applying filtering filtering "a la" resources plugin
      *
      * @parameter default-value="false"
@@ -264,6 +283,8 @@ public class ChangesMojo
 
         ChangesReportGenerator report = new ChangesReportGenerator( xmlPath, getLog() );
         
+        report.setEscapeHTML ( escapeHTML );
+
         report.setIssueLinksPerSystem( issueLinkTemplatePerSystem );
         report.setIssueLink( issueLinkTemplate );
         

Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java?rev=1054123&r1=1054122&r2=1054123&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java Fri Dec 31 14:48:58 2010
@@ -68,6 +68,11 @@ public class ChangesReportGenerator
 
     private boolean addActionDate;
 
+    /**
+     * @since 2.4
+     */
+    private boolean escapeHTML;
+
     public ChangesReportGenerator()
     {
         issueLinksPerSystem = new HashMap();
@@ -80,6 +85,22 @@ public class ChangesReportGenerator
     }
 
     /**
+     * @since 2.4
+     */
+    public boolean isEscapeHTML()
+    {
+        return escapeHTML;
+    }
+
+    /**
+     * @since 2.4
+     */
+    public void setEscapeHTML( boolean escapeHTML )
+    {
+        this.escapeHTML = escapeHTML;
+    }
+
+    /**
      * @deprecated
      */
     public void setIssueLink( String issueLink )
@@ -240,7 +261,14 @@ public class ChangesReportGenerator
 
                 sink.tableCell();
 
-                sink.text( action.getAction() );
+                if( escapeHTML )
+                {
+                    sink.text( action.getAction() );
+                }
+                else
+                {
+                    sink.rawText( action.getAction() );
+                }
 
                 // no null check needed classes from modello return a new ArrayList
                 if ( StringUtils.isNotEmpty( action.getIssue() ) || ( !action.getFixedIssues().isEmpty() ) )