From a7e46d68144194fcb2e7eea6e9f909c2316f22f2 Mon Sep 17 00:00:00 2001
From: ltheussl <ltheussl@13f79535-47bb-0310-9956-ffa450edef68>
Date: Sun, 11 Sep 2005 05:21:48 +0000
Subject: [PATCH] MPPDF-40 : Use optional id tag for sub/section anchors

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@280081 13f79535-47bb-0310-9956-ffa450edef68
---
 pdf/src/plugin-resources/fo-body.xslt     | 49 ++++++++++++-----------
 pdf/src/plugin-test/test02/xdocs/test.xml | 13 ++++++
 pdf/xdocs/changes.xml                     |  3 ++
 pdf/xdocs/index.xml                       | 15 ++++---
 4 files changed, 52 insertions(+), 28 deletions(-)

diff --git a/pdf/src/plugin-resources/fo-body.xslt b/pdf/src/plugin-resources/fo-body.xslt
index c106e92b..6c7905cf 100644
--- a/pdf/src/plugin-resources/fo-body.xslt
+++ b/pdf/src/plugin-resources/fo-body.xslt
@@ -103,14 +103,19 @@
   <xsl:template match="section">
     <xsl:param name="chapterNumber"/>
     <xsl:param name="fileName"/>
-    <xsl:param name="transLink">
-      <xsl:call-template name="escapeNameToken">
-        <xsl:with-param name="oldString" select="@name"/>
-      </xsl:call-template>
-    </xsl:param>
-    <fo:block xsl:use-attribute-sets="body.h1" id="{$fileName}#{$transLink}">
-      <xsl:value-of select="@name"/>
-    </fo:block>
+    <!-- Generate anchor only if id tag exists -->
+    <xsl:choose>
+      <xsl:when test="@id">
+        <fo:block xsl:use-attribute-sets="body.h1" id="{$fileName}#{@id}">
+          <xsl:value-of select="@name"/>
+        </fo:block>
+      </xsl:when>
+      <xsl:otherwise>
+        <fo:block xsl:use-attribute-sets="body.h1">
+          <xsl:value-of select="@name"/>
+        </fo:block>
+      </xsl:otherwise>
+    </xsl:choose>
     <fo:block xsl:use-attribute-sets="body.text">
       <xsl:apply-templates>
         <xsl:with-param name="chapterNumber">
@@ -122,24 +127,22 @@
       </xsl:apply-templates>
     </fo:block>
   </xsl:template>
-  <xsl:template name="escapeNameToken">
-    <!-- Same transformation as done by the escapeNameToken tag of xdoc -->
-    <xsl:param name="oldString"/>
-    <xsl:variable name="replaceChars"> .,;!?/'\()[]{}+*°</xsl:variable>
-    <xsl:variable name="replaceWith">___________________</xsl:variable>
-    <xsl:value-of select="translate($oldString,$replaceChars,$replaceWith)"/>
-  </xsl:template>
   <xsl:template match="subsection">
     <xsl:param name="chapterNumber"/>
     <xsl:param name="fileName"/>
-    <xsl:param name="transLink">
-      <xsl:call-template name="escapeNameToken">
-        <xsl:with-param name="oldString" select="@name"/>
-      </xsl:call-template>
-    </xsl:param>
-    <fo:block xsl:use-attribute-sets="body.h2" id="{$fileName}#{$transLink}">
-      <xsl:value-of select="@name"/>
-    </fo:block>
+    <!-- Generate anchor only if id tag exists -->
+    <xsl:choose>
+      <xsl:when test="@id">
+        <fo:block xsl:use-attribute-sets="body.h2" id="{$fileName}#{@id}">
+          <xsl:value-of select="@name"/>
+        </fo:block>
+      </xsl:when>
+      <xsl:otherwise>
+        <fo:block xsl:use-attribute-sets="body.h2">
+          <xsl:value-of select="@name"/>
+        </fo:block>
+      </xsl:otherwise>
+    </xsl:choose>
     <fo:block xsl:use-attribute-sets="body.text">
       <xsl:apply-templates>
         <xsl:with-param name="chapterNumber">
diff --git a/pdf/src/plugin-test/test02/xdocs/test.xml b/pdf/src/plugin-test/test02/xdocs/test.xml
index 1be962b5..182eb825 100644
--- a/pdf/src/plugin-test/test02/xdocs/test.xml
+++ b/pdf/src/plugin-test/test02/xdocs/test.xml
@@ -97,5 +97,18 @@
         </p>
       </subsection>
     </section>
+    <section name="Test for MPPDF-40" id="sec1">
+      <subsection name="Identical names" id="subsec1">
+        <p>This subsection has an <code>id="subsec1"</code> tag.</p>
+      </subsection>
+    </section>
+    <section name="Test for MPPDF-40" id="sec2">
+      <subsection name="Identical names" id="subsec2">
+        <p>This subsection has an <code>id="subsec2"</code> tag.</p>
+        <p>
+          Here's a <a href="#subsec1">link</a> to the previous subsetion.
+        </p>
+      </subsection>
+    </section>
   </body>
 </document>
diff --git a/pdf/xdocs/changes.xml b/pdf/xdocs/changes.xml
index c4a4a1ba..08be3ca5 100644
--- a/pdf/xdocs/changes.xml
+++ b/pdf/xdocs/changes.xml
@@ -24,6 +24,9 @@
     <author email="aheritier@apache.org">Arnaud Heritier</author>
   </properties>
   <body>
+    <release version="2.5-SNAPSHOT" date="in SVN">
+      <action dev="ltheussl" type="fix" issue="MPPDF-40">Use optional id tag for sub/section anchors to avoid problems with identical names.</action>
+    </release>
     <release version="2.4" date="2005-09-05">
       <action dev="aheritier" type="update">Make the plugin compatible with maven 1.0 and jdk 1.3/1.4/1.5 or with maven 1.1 and jdk 1.4/1.5.</action>
       <action dev="aheritier" type="fix" issue="MPPDF-43" due-to="Lukas Theussl">sub-/superscripts do not work.</action>
diff --git a/pdf/xdocs/index.xml b/pdf/xdocs/index.xml
index 061b6fc5..a58fa473 100644
--- a/pdf/xdocs/index.xml
+++ b/pdf/xdocs/index.xml
@@ -43,17 +43,22 @@
     <section name="Known issues">
       <ul>
         <li>
-          <p>There is a known problem with the PDF generation tool (Apache's FOP) in that it doesn't allow for table structures with automatic column widths to be generated. Widths are uniformly distributed.</p>
+          There is a known problem with the PDF generation tool (Apache's FOP) in that it doesn't allow for table structures with automatic column widths to be generated. Widths are uniformly distributed.
         </li>
         <li>
-          <p>Due to several problems, it is actually impossible to reference the same file in different items in navigation.xml. You must define another navigation file (using the property <a href="properties.html">"maven.pdf.navigationFile"</a>) which you'll use only with the PDF plug-in. This navigation cannot define several items with the same href.</p>
+          Due to several problems, it is actually impossible to reference the same file in different items in navigation.xml. You must define another navigation file (using the property <a href="properties.html">"maven.pdf.navigationFile"</a>) which you'll use only with the PDF plug-in. This navigation cannot define several items with the same href.
         </li>
         <li>
-          <p>Identical <code>name</code> or <code>id</code> attributes within one document will lead to a build failure. Note in particular that in the current version of the pdf plugin, id's are constructed from sub/section names (in analogy to the xdoc plugin), so identical titles for sections or subsections will make the pdf generation fail. See <a href="http://jira.codehaus.org/browse/MPPDF-40">MPPDF-40</a>.
-          </p>
+          Identical <code>id</code> attributes within one document will lead to a build failure.
         </li>
         <li>
-          <p>Other issues are available in <a href="http://jira.codehaus.org/secure/IssueNavigator.jspa?reset=true&amp;pid=10356&amp;statusIds=1" target="_blank">Jira</a>.</p>
+          Contrary to the xdoc plugin, the pdf plugin does not generate
+          anchors from section or subsection names. If you want to reference
+          a section or subsection you have to use the optional
+          <code>id</code> tag.
+        </li>
+        <li>
+          Other issues are available in <a href="http://jira.codehaus.org/secure/IssueNavigator.jspa?reset=true&amp;pid=10356&amp;statusIds=1" target="_blank">Jira</a>.
         </li>
       </ul>
     </section>