From: markt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Date: Fri, 9 Jul 2010 09:41:25 +0000 (+0000)
Subject: Documentation improvements:
X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=5908a4b033226a841d4adbb18eb5adb977a34f34;p=tomcat7.0

Documentation improvements:
- Explicit version number in <title ../>
- Add version and date to every page
- Remove duplicate "Apache Tomcat 7" and promote real page title
- Automate copyright end date

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@962466 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/build.xml b/build.xml
index 8bd434c8e..438609ac7 100644
--- a/build.xml
+++ b/build.xml
@@ -591,10 +591,10 @@
         <include name="docs/appdev/*.txt"/>
         <include name="docs/appdev/sample/**"/>
       </fileset>
-        <fileset dir="webapps">
-          <include name="docs/architecture/**"/>
-          <exclude name="docs/architecture/*.xml"/>
-        </fileset>
+      <fileset dir="webapps">
+        <include name="docs/architecture/**"/>
+        <exclude name="docs/architecture/*.xml"/>
+      </fileset>
     </copy>
     <copy todir="${tomcat.build}/webapps/docs" encoding="ISO-8859-1">
       <filterset refid="version.filters"/>
@@ -620,6 +620,9 @@
           excludes="build.xml project.xml"
           includes="*.xml">
       <param name="relative-path" expression="."/>
+      <param name="version" expression="${version}"/>
+      <param name="build-date" expression="${today}"/>
+      <param name="year" expression="${year}"/>
     </xslt>
     <xslt basedir="webapps/docs/appdev"
            destdir="${tomcat.build}/webapps/docs/appdev"
@@ -628,6 +631,9 @@
           excludes="project.xml"
           includes="*.xml">
       <param name="relative-path" expression=".."/>
+      <param name="version" expression="${version}"/>
+      <param name="build-date" expression="${today}"/>
+      <param name="year" expression="${year}"/>
     </xslt>
     <xslt basedir="webapps/docs/funcspecs"
            destdir="${tomcat.build}/webapps/docs/funcspecs"
@@ -636,6 +642,9 @@
           excludes="project.xml"
           includes="*.xml">
       <param name="relative-path" expression=".."/>
+      <param name="version" expression="${version}"/>
+      <param name="build-date" expression="${today}"/>
+      <param name="year" expression="${year}"/>
     </xslt>
     <xslt basedir="webapps/docs/config"
            destdir="${tomcat.build}/webapps/docs/config"
@@ -644,6 +653,9 @@
           excludes="project.xml"
           includes="*.xml">
       <param name="relative-path" expression=".."/>
+      <param name="version" expression="${version}"/>
+      <param name="build-date" expression="${today}"/>
+      <param name="year" expression="${year}"/>
     </xslt>
     <xslt basedir="webapps/docs/architecture"
            destdir="${tomcat.build}/webapps/docs/architecture"
@@ -652,6 +664,9 @@
           excludes="project.xml"
           includes="*.xml">
       <param name="relative-path" expression=".."/>
+      <param name="version" expression="${version}"/>
+      <param name="build-date" expression="${today}"/>
+      <param name="year" expression="${year}"/>
     </xslt>
 
     <xslt basedir="webapps/docs/tribes"
@@ -660,7 +675,10 @@
                  style="webapps/docs/tomcat-docs.xsl"
               excludes="project.xml"
               includes="*.xml">
-          <param name="relative-path" expression=".."/>
+      <param name="relative-path" expression=".."/>
+      <param name="version" expression="${version}"/>
+      <param name="build-date" expression="${today}"/>
+      <param name="year" expression="${year}"/>
     </xslt>
   </target>
 
diff --git a/webapps/docs/architecture/project.xml b/webapps/docs/architecture/project.xml
index 628ed3b3f..db6583643 100644
--- a/webapps/docs/architecture/project.xml
+++ b/webapps/docs/architecture/project.xml
@@ -15,10 +15,10 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<project name="Apache Tomcat Architecture"
+<project name="Apache Tomcat 7 Architecture"
         href="http://tomcat.apache.org/">
 
-    <title>Apache Tomcat Architecture</title>
+    <title>Apache Tomcat 7 Architecture</title>
 
     <logo href="/images/tomcat.gif">
       The Apache Tomcat Servlet/JSP Container
diff --git a/webapps/docs/config/project.xml b/webapps/docs/config/project.xml
index 567340b7c..f400f6cce 100644
--- a/webapps/docs/config/project.xml
+++ b/webapps/docs/config/project.xml
@@ -15,10 +15,10 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<project name="Apache Tomcat Configuration Reference"
+<project name="Apache Tomcat 7 Configuration Reference"
         href="http://tomcat.apache.org/">
 
-  <title>Apache Tomcat Configuration Reference</title>
+  <title>Apache Tomcat 7 Configuration Reference</title>
 
   <logo href="/images/tomcat.gif">
     The Apache Tomcat Servlet/JSP Container
diff --git a/webapps/docs/project.xml b/webapps/docs/project.xml
index faac4b3d6..6012a6127 100644
--- a/webapps/docs/project.xml
+++ b/webapps/docs/project.xml
@@ -18,7 +18,7 @@
 <project name="Apache Tomcat Documentation"
         href="http://tomcat.apache.org/">
 
-    <title>Apache Tomcat 7.0</title>
+    <title>Apache Tomcat 7</title>
 
     <logo href="/images/tomcat.gif">
       The Apache Tomcat Servlet/JSP Container
diff --git a/webapps/docs/tomcat-docs.xsl b/webapps/docs/tomcat-docs.xsl
index 569fdb08e..80e06d4b2 100644
--- a/webapps/docs/tomcat-docs.xsl
+++ b/webapps/docs/tomcat-docs.xsl
@@ -36,6 +36,9 @@
   <xsl:param    name="printer-logo"     select="'/images/printer.gif'"/>
   <xsl:param    name="apache-logo"      select="'/images/asf-logo.gif'"/>
   <xsl:param    name="relative-path"    select="'.'"/>
+  <xsl:param    name="version"          select="'7.0.x'"/>
+  <xsl:param    name="build-date"       select="'MMM d yyyy'"/>
+  <xsl:param    name="year"             select="'yyyy'"/>
   <xsl:param    name="void-image"       select="'/images/void.gif'"/>
   <xsl:param    name="project-menu"     select="'menu'"/>
   <xsl:param    name="standalone"       select="''"/>
@@ -61,7 +64,7 @@
               select="document('project.xml')/project"/>
     <html>
     <head>
-    <title><xsl:value-of select="project/title"/> - <xsl:value-of select="properties/title"/></title>
+    <title><xsl:value-of select="project/title"/> (<xsl:value-of select="$version"/>) - <xsl:value-of select="properties/title"/></title>
     <xsl:for-each select="properties/author">
       <xsl:variable name="name">
         <xsl:value-of select="."/>
@@ -106,7 +109,10 @@
         </xsl:if>
         </td>
         <td>
-          <h1><font face="arial,helvetica,sanserif"><xsl:value-of select="$project/title"/></font></h1>
+          <font face="arial,helvetica,sanserif">
+            <h1><xsl:value-of select="$project/title"/></h1>
+            Version <xsl:value-of select="$version"/>, <xsl:value-of select="$build-date"/>
+          </font>
         </td>
         <td>
           <xsl:comment>APACHE LOGO</xsl:comment>
@@ -138,8 +144,7 @@
 
         <xsl:comment>RIGHT SIDE MAIN BODY</xsl:comment>
         <td width="80%" valign="top" align="left" id="mainBody">
-          <h1><xsl:value-of select="project/title"/></h1>
-          <h2><xsl:value-of select="properties/title"/></h2>
+          <h1><xsl:value-of select="properties/title"/></h1>
           <xsl:apply-templates select="body/section"/>
         </td>
 
@@ -155,7 +160,7 @@
       <xsl:comment>PAGE FOOTER</xsl:comment>
       <tr><td colspan="2">
         <div align="center"><font color="{$body-link}" size="-1"><em>
-        Copyright &#169; 1999-2010, Apache Software Foundation
+        Copyright &#169; 1999-<xsl:value-of select="$year"/>, Apache Software Foundation
         </em></font></div>
       </td></tr>