From c802fc460b24276cc1191c16742c11c869953bc0 Mon Sep 17 00:00:00 2001
From: ltheussl <ltheussl@13f79535-47bb-0310-9956-ffa450edef68>
Date: Sun, 30 Oct 2005 05:33:27 +0000
Subject: [PATCH] Replace maven.faq.toplinks property by toplink attribute in
 the fml file (m1 - m2 compatibility)

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@329522 13f79535-47bb-0310-9956-ffa450edef68
---
 faq/maven.xml                        |  3 +++
 faq/plugin.jelly                     |  3 +++
 faq/plugin.properties                |  3 ---
 faq/src/plugin-resources/faq.jsl     | 11 ++++++-----
 faq/src/plugin-resources/xsd/faq.xsd |  1 +
 faq/xdocs/changes.xml                |  1 +
 faq/xdocs/faq.fml                    |  4 ++--
 faq/xdocs/index.xml                  |  2 +-
 faq/xdocs/properties.xml             |  4 +---
 9 files changed, 18 insertions(+), 14 deletions(-)

diff --git a/faq/maven.xml b/faq/maven.xml
index 9d90bfed..f15d4ebe 100644
--- a/faq/maven.xml
+++ b/faq/maven.xml
@@ -22,6 +22,9 @@
       <fileset dir="${maven.docs.src}">
         <include name="**/*.fml"/>
       </fileset>
+      <fileset dir="${basedir}/src/plugin-resources/xsd">
+        <include name="faq.xsd"/>
+      </fileset>
     </copy>
   </postGoal>
 </project>
diff --git a/faq/plugin.jelly b/faq/plugin.jelly
index dbc2e026..a616f3db 100644
--- a/faq/plugin.jelly
+++ b/faq/plugin.jelly
@@ -88,6 +88,9 @@
           <j:set var="outFile" value="${mapper.mapFileName(outFileForward).0}"/>
 
           <echo>Generating ${outFile} from ${faqFile}</echo>
+          <j:if test="${maven.faq.toplinks == 'true'}">
+            <echo>WARNING: the property maven.faq.toplinks is depreated! Use the 'toplink' attribute in your fml file instead.</echo>
+          </j:if>
 
           <!-- produce a output xdoc xml file from parsed .fml source -->
           <doc:jslFile
diff --git a/faq/plugin.properties b/faq/plugin.properties
index b17850f3..f1a15f21 100644
--- a/faq/plugin.properties
+++ b/faq/plugin.properties
@@ -23,6 +23,3 @@ maven.faq.src=${maven.docs.src}
 
 # Destination directory where output xdocs file are produced
 maven.faq.dest=${maven.gen.docs}
-
-# Whether to generate links to the top of the page
-maven.faq.toplinks=true
diff --git a/faq/src/plugin-resources/faq.jsl b/faq/src/plugin-resources/faq.jsl
index d1624621..208a5891 100644
--- a/faq/src/plugin-resources/faq.jsl
+++ b/faq/src/plugin-resources/faq.jsl
@@ -29,6 +29,7 @@
   trim="true">
   <jsl:template match="faqs" trim="false">
     <j:set var="title"><x:expr select="@title" /></j:set>
+    <j:set var="toplinks"><x:expr select="@toplink" /></j:set>
     <document>
       <properties>
         <title>${title}</title>
@@ -81,11 +82,11 @@
   <jsl:template match="answer">
     <dd>
         <jsl:applyTemplates trim="true" />
-        <j:if test="${context.getVariable('maven.faq.toplinks') == 'true'}">
-        <j:set var="top"><x:expr select="../../../@title"/></j:set>
-        <j:set var="_top">#<doc:escapeNameToken value="${top}"/></j:set>
-        <div class="xright"><a href="${_top}">[top]</a></div>
-        <br/>
+        <j:if test="${toplinks != 'false'}">
+          <j:set var="top"><x:expr select="../../../@title"/></j:set>
+          <j:set var="_top">#<doc:escapeNameToken value="${top}"/></j:set>
+          <div class="xright"><a href="${_top}">[top]</a></div>
+          <br/>
         </j:if>
     </dd>
   </jsl:template> 
diff --git a/faq/src/plugin-resources/xsd/faq.xsd b/faq/src/plugin-resources/xsd/faq.xsd
index 573058e0..7332a809 100644
--- a/faq/src/plugin-resources/xsd/faq.xsd
+++ b/faq/src/plugin-resources/xsd/faq.xsd
@@ -58,6 +58,7 @@
                 <xsd:element ref="part" minOccurs="1" maxOccurs="unbounded"/>
             </xsd:sequence>
             <xsd:attribute name="title" type="xsd:string" use="optional"/>
+            <xsd:attribute name="toplink" type="xsd:string" use="optional"/>
         </xsd:complexType>
     </xsd:element>
 
diff --git a/faq/xdocs/changes.xml b/faq/xdocs/changes.xml
index e06b9cb0..fea10df8 100644
--- a/faq/xdocs/changes.xml
+++ b/faq/xdocs/changes.xml
@@ -23,6 +23,7 @@
   </properties>
   <body>
     <release version="1.6-SNAPSHOT" date="In SVN">
+      <action dev="ltheussl" type="update">Deprecated <code>maven.faq.toplinks</code> property. Use the <code>toplink</code> attribute in the fml file instead.</action>
       <action dev="aheritier" type="update" issue="MAVEN-1712">Update dependencies to match ones in maven 1.1 core and to unify them between plugins. The following dependencies are updated : 
         <ul>
           <li>commons-jelly-tags-xml v1.0 -> v1.1</li>
diff --git a/faq/xdocs/faq.fml b/faq/xdocs/faq.fml
index a6d56b54..1fe36e9b 100644
--- a/faq/xdocs/faq.fml
+++ b/faq/xdocs/faq.fml
@@ -17,7 +17,7 @@
  */
  -->
 
-<faqs title="Frequently Asked Questions">
+<faqs title="Frequently Asked Questions" toplink="false">
 
   <part id="general">
     <title>General</title>
@@ -57,4 +57,4 @@
       </answer>
     </faq>
   </part>  
-</faqs>
\ No newline at end of file
+</faqs>
diff --git a/faq/xdocs/index.xml b/faq/xdocs/index.xml
index c1f03f63..dd1b8943 100644
--- a/faq/xdocs/index.xml
+++ b/faq/xdocs/index.xml
@@ -38,7 +38,7 @@
         <a href="faq.xsd">here</a>.
       </p>  
       <p>  
-        Please note that the the FAQ description has to be in a file with a
+        <strong>Note</strong>: the FAQ description has to be in a file with a
         <code>.fml</code> extension.
       </p>
       <p>
diff --git a/faq/xdocs/properties.xml b/faq/xdocs/properties.xml
index c943b68a..acd02b68 100644
--- a/faq/xdocs/properties.xml
+++ b/faq/xdocs/properties.xml
@@ -48,9 +48,7 @@
           <td>maven.faq.toplinks</td>
           <td>Yes</td>
           <td>
-            Specifies whether links to the top of the page should be
-            generated after each answer.
-            Defaults to <code>true</code>.
+            <strong>DEPRECATED</strong>: use the <code>toplink</code> attribute in the fml file instead.
           </td>
         </tr>
       </table>