MPXDOC-24 : Add navigation bar

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@280371 13f79535-47bb-0310-9956-ffa450edef68

xdoc/src/plugin-resources/site.jsl

@@ -840,6 +840,29 @@
     <jsl:applyTemplates trim="false"/>
   </jsl:template>
 
+  <!-- process a guide-like navbar -->
+  <jsl:template match="navbar" trim="false">
+    <x:set var="_prevlink" select="string(@prev)"/>
+    <x:set var="_homelink" select="string(@home)"/>
+    <x:set var="_nextlink" select="string(@next)"/>
+    <j:set var="prev"><fmt:message key="site.navbar.previous" bundle="${msg}"/></j:set>
+    <j:set var="home"><fmt:message key="site.navbar.home" bundle="${msg}"/></j:set>
+    <j:set var="next"><fmt:message key="site.navbar.next" bundle="${msg}"/></j:set>
+    <hr/>
+    <div align="center" class="navbar">
+      [
+      <j:if test="${ ! empty(_prevlink) }"><a href="${_prevlink}">${prev}</a></j:if>
+      <j:if test="${ empty(_prevlink) }">${prev}</j:if>
+      |
+      <j:if test="${ ! empty(_homelink)}"><a href="${_homelink}">${home}</a></j:if>
+      <j:if test="${ empty(_homelink) }">home</j:if>
+      |
+      <j:if test="${ ! empty(_nextlink)}"><a href="${_nextlink}">${next}</a></j:if>
+      <j:if test="${ empty(_nextlink)}">${next}</j:if>
+      ]
+    </div>
+  </jsl:template>
+
   <!-- element values don't pass through as text -->
   <jsl:template match="@*"/>
 

xdoc/src/plugin-resources/templates/templates.properties

@@ -164,3 +164,6 @@ site.language=Language
 site.goals=Goals
 site.goal=Goal
 site.description=Description
+site.navbar.previous=previous
+site.navbar.home=home
+site.navbar.next=next

xdoc/src/plugin-resources/templates/templates_de.properties

@@ -163,3 +163,6 @@ site.opens_new_window =
 site.language = Sprache
 site.locale.en = Englisch
 site.locale.fr = Französisch
+site.navbar.previous=zurück
+site.navbar.home=Übersicht
+site.navbar.next=weiter

xdoc/src/plugin-resources/templates/templates_fr.properties

@@ -166,3 +166,6 @@ site.language=Langue
 site.goals=Buts
 site.goal=But
 site.description=Description
+site.navbar.previous=précédent
+site.navbar.home=Accueil
+site.navbar.next=suivant

xdoc/xdocs/changes.xml

@@ -27,6 +27,7 @@
   </properties>
   <body>
     <release version="1.10" date="in SVN">
+      <action dev="ltheussl" type="add" issue="MPXDOC-24" due-to="Gilles Dodinet">Add a navigation bar.</action>
       <action dev="ltheussl" type="add" issue="MPXDOC-158">Add an optional id tag to sub/sections, so they can be referenced.</action>
       <action dev="ltheussl" type="add" issue="MPXDOC-144">Add a property to override <code>navigation.xml</code>.</action>
       <action dev="ltheussl" type="add" issue="MPXDOC-127" due-to="Shinobu Kawai Yoshida">Show organization in header even if logo not set.</action>

xdoc/xdocs/index.xml

@@ -53,6 +53,16 @@
     </A>
    </footer>]]></source>
       </subsection>
+      <subsection name="Navigation bar">
+        <p>
+          You can put a navigation bar on bottom of each page by including
+          a <code>&lt;navbar/&gt;</code> element in an xdoc's body.
+          This element takes three optional attributes,
+          <code>prev</code>, <code>home</code> and <code>next</code>, as
+          shown in the following example:
+        </p>
+        <source><![CDATA[<navbar prev="first.html" home="../index.html" next="next.html"/>]]></source>
+      </subsection>
       <subsection name="Google Search">
         <p>If a <code>search</code> element is found in the <code>navigation.xml</code> body, a search navigation menu is generated that uses <a href="http://www.google.com">google</a></p>
       </subsection>