required changes to include the obsolete stuff.

- new entries in en.xml
- sidebar for moduleindex
- new <hint> element for modulesynopsis
- status attribute for <directive> and <module> in order to
  create correct links (status="obsolete" inserts an 'obs_'
  before the module file name in the href)

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

diff --git a/docs/manual/style/common.dtd b/docs/manual/style/common.dtd
index edb4db283a724a428a8a937fa5ddf3faf4abb8e9..ef957064d4fcf020c7cb1655456035b59ba5df6b 100644 (file)
--- a/docs/manual/style/common.dtd
+++ b/docs/manual/style/common.dtd
@@ -35,10 +35,12 @@
 <!ELEMENT directivelist (directive)+>
 
 <!ELEMENT module (#PCDATA)>
+<!ATTLIST module status CDATA  #IMPLIED>
 
 <!ELEMENT directive (#PCDATA)>
 <!ATTLIST directive  module CDATA  #IMPLIED
-                     type   CDATA  #IMPLIED >
+                     type   CDATA  #IMPLIED
+                     status CDATA  #IMPLIED >
 
 <!ELEMENT p %Inline;>
 <!ATTLIST p class CDATA  #IMPLIED>

diff --git a/docs/manual/style/css/manual-loose-100pc.css b/docs/manual/style/css/manual-loose-100pc.css
index 3c402075d320a515d9f974660c13b6bd65f878bf..493e39d9a5331f929a11ca3ad838ab398942c063 100644 (file)
--- a/docs/manual/style/css/manual-loose-100pc.css
+++ b/docs/manual/style/css/manual-loose-100pc.css
@@ -79,6 +79,7 @@ div#quickview li img {
     margin-right: 19px;
 }
 
+#module-index div#quickview ul#toc,
 #manual-page div#quickview ul#toc,
 div#quickview #topics {
     padding-left: 0;
@@ -88,6 +89,7 @@ div#quickview .seealso {
     padding-left: 34px;
 }
 
+#module-index div#quickview ul#toc li,
 #manual-page div#quickview ul#toc li,
 div#quickview #topics li,
 div#quickview .seealso li {

diff --git a/docs/manual/style/css/manual-print.css b/docs/manual/style/css/manual-print.css
index 26dfc19cff7ebbef67fc0bdc71196768f2b3c200..d36851fb3f3ccbdddf2b7d62a318d64861984b4e 100644 (file)
--- a/docs/manual/style/css/manual-print.css
+++ b/docs/manual/style/css/manual-print.css
@@ -459,12 +459,14 @@ div#quickview li img {
     display: none;
 }
 
+#module-index div#quickview ul#toc,
 #manual-page div#quickview ul#toc,
 div#quickview #topics,
 div#quickview .seealso {
     padding-left: 0;
 }
 
+#module-index div#quickview ul#toc li,
 #manual-page div#quickview ul#toc li,
 div#quickview #topics li,
 div#quickview .seealso li {

diff --git a/docs/manual/style/css/manual.css b/docs/manual/style/css/manual.css
index e66f93a9d18e166bfb5ebcb82a64790d9b0fb0b6..366518f1bcf61a06b7d9f6a8642a9d4d125192aa 100644 (file)
--- a/docs/manual/style/css/manual.css
+++ b/docs/manual/style/css/manual.css
@@ -537,6 +537,7 @@ div#quickview ul#toc {
     padding: 0;
 }
 
+#module-index div#quickview ul#toc,
 #manual-page div#quickview ul#toc {
     margin-left: 0;
 }
@@ -551,12 +552,14 @@ div#quickview li img {
     display: none;
 }
 
+#module-index div#quickview ul#toc,
 #manual-page div#quickview ul#toc,
 div#quickview #topics,
 div#quickview .seealso {
     padding-left: 15px;
 }
 
+#module-index div#quickview ul#toc li,
 #manual-page div#quickview ul#toc li,
 div#quickview #topics li,
 div#quickview .seealso li {
@@ -761,7 +764,7 @@ div.warning {
 
 div.note p,
 div.warning p {
-    margin: 0;
+    margin: 0.5em 0 0 0;
     padding: 0;
 }
 

diff --git a/docs/manual/style/lang/en.xml b/docs/manual/style/lang/en.xml
index 1ea6e27c1f88a2cd3d7f3e96ab97d2c09b162a0e..0efe75df29adf6f111a547d97ad9afa7dd38ab60 100644 (file)
--- a/docs/manual/style/lang/en.xml
+++ b/docs/manual/style/lang/en.xml
@@ -11,8 +11,10 @@
  <!-- Used for the moduleindex -->
  <message name="corefeatures">Core Features and Multi-Processing Modules</message>
  <message name="othermodules">Other Modules</message>
+ <message name="obsoletemodules">Obsolete Modules</message>
 
  <!-- Used for the modulesynopsis and sitemap -->
+ <message name="obsoleteapachemodule">Obsolete Apache Module</message>
  <message name="apachemodule">Apache Module</message>
  <message name="apachecore">Apache Core Features</message>
  <message name="apachempmcommon">Apache MPM Common Directives</message>

diff --git a/docs/manual/style/modulesynopsis.dtd b/docs/manual/style/modulesynopsis.dtd
index 2bbac0ada99635b723146e6da694dbd213c6e427..4e4ca4842fafb6b3e044b5a2b388ee4ae46853b9 100644 (file)
--- a/docs/manual/style/modulesynopsis.dtd
+++ b/docs/manual/style/modulesynopsis.dtd
@@ -3,7 +3,7 @@
 <!ENTITY % sitemap SYSTEM "sitemap.dtd">
 %sitemap;
 
-<!ELEMENT modulesynopsis (name , description, status , sourcefile?,
+<!ELEMENT modulesynopsis (name , description, status, hint?, sourcefile?,
 identifier? , compatibility? , summary? , seealso* , section*,
 directivesynopsis*)>
 
@@ -15,6 +15,8 @@ usage?, seealso*)>
 
 <!ELEMENT status (#PCDATA)>
 
+<!ELEMENT hint %Inline;>
+
 <!ELEMENT identifier (#PCDATA)>
 
 <!ELEMENT sourcefile (#PCDATA)>

diff --git a/docs/manual/style/xsl/common.xsl b/docs/manual/style/xsl/common.xsl
index 3063119cf3f04699354bc85141d69ee1e4ee4b21..84d76e69142a3829383f685940eb5d63a1f1d49d 100644 (file)
--- a/docs/manual/style/xsl/common.xsl
+++ b/docs/manual/style/xsl/common.xsl
@@ -462,7 +462,11 @@
           </xsl:when>
 
           <xsl:otherwise>
-            <a href="{$path}/mod/{@module}.html#{$lowerdirective}">
+            <xsl:variable name="obs_">
+              <xsl:if test="@status = 'obsolete'">obs_</xsl:if>
+            </xsl:variable>
+
+            <a href="{$path}/mod/{$obs_}{@module}.html#{$lowerdirective}">
               <xsl:if test="@type='section'">&lt;</xsl:if>
               <xsl:value-of select="."/>
               <xsl:if test="@type='section'">&gt;</xsl:if>
@@ -487,8 +491,12 @@
   <!-- Inserts a link to refereed module                  -->
   <!--                                                    -->
   <xsl:template match="module" name="module">
+    <xsl:variable name="obs_">
+      <xsl:if test="@status = 'obsolete'">obs_</xsl:if>
+    </xsl:variable>
+
     <code class="module">
-      <a href="{$path}/mod/{.}.html">
+      <a href="{$path}/mod/{$obs_}{.}.html">
         <xsl:value-of select="."/>
       </a>
     </code>
@@ -647,6 +655,16 @@
   <!-- /description -->
 
 
+  <!--                                                    -->
+  <!-- <hint>                                             -->
+  <!-- Passes through content                             -->
+  <!--                                                    -->
+  <xsl:template match="hint">
+    <xsl:apply-templates/>
+  </xsl:template> 
+  <!-- /description -->
+
+
   <!--                                                    -->
   <!-- <usage>                                            -->
   <!-- Passes through content                             -->

diff --git a/docs/manual/style/xsl/directiveindex.xsl b/docs/manual/style/xsl/directiveindex.xsl
index 50fee821f1390826e9c8d1fad47687eba3876151..704674cf2959173e74acdb32680c4fe2bcba7595 100644 (file)
--- a/docs/manual/style/xsl/directiveindex.xsl
+++ b/docs/manual/style/xsl/directiveindex.xsl
@@ -15,7 +15,7 @@
       <body id="directive-index">
         <xsl:call-template name="top"/>
 
-        <xsl:variable name="directives" select="document(sitemap/category[@id='modules']/modulefilelist/modulefile)/modulesynopsis/directivesynopsis[not(@location)]"/>
+        <xsl:variable name="directives" select="document(sitemap/category[@id='modules']/modulefilelist/modulefile)/modulesynopsis[status!='Obsolete']/directivesynopsis[not(@location)]"/>
 
         <!-- collect the start letters -->
         <xsl:variable name="start-letters">

diff --git a/docs/manual/style/xsl/moduleindex.xsl b/docs/manual/style/xsl/moduleindex.xsl
index 34a737f031fcaef1aec0bf28cf48dbbd19d5462e..26944b0ff9a465119da44b2b3ad8a569acb8efe5 100644 (file)
--- a/docs/manual/style/xsl/moduleindex.xsl
+++ b/docs/manual/style/xsl/moduleindex.xsl
@@ -14,6 +14,7 @@
       <body id="module-index">
         <xsl:call-template name="top"/>  
 
+        <div id="page-content">
         <div id="preamble">
           <h1>
             <xsl:value-of select="title"/>
@@ -22,11 +23,41 @@
           <xsl:apply-templates select="summary" />
         </div>
           
+        <div id="quickview">
+          <ul id="toc">
+            <li>
+              <img src="{$path}/images/down.gif" alt="" />
+              <xsl:text> </xsl:text>
+              <a href="#core">
+                <xsl:value-of select="$messages/message[@name='corefeatures']"/>
+              </a>
+            </li>
+            
+            <li>
+              <img src="{$path}/images/down.gif" alt="" />
+              <xsl:text> </xsl:text>
+              <a href="#other">
+                <xsl:value-of select="$messages/message[@name='othermodules']"/>
+              </a>
+            </li>
+
+            <li>
+              <img src="{$path}/images/down.gif" alt="" />
+              <xsl:text> </xsl:text>
+              <a href="#obsolete">
+                <xsl:value-of select="$messages/message[@name='obsoletemodules']"/>
+              </a>
+            </li>
+          </ul>
+        </div> <!-- /quickview -->
+
         <xsl:call-template name="toplink"/>
 
         <div class="section">
           <h2>
-            <xsl:value-of select="$messages/message[@name='corefeatures']"/>
+            <a name="core" id="core">
+              <xsl:value-of select="$messages/message[@name='corefeatures']"/>
+            </a>
           </h2>
 
           <dl>
@@ -42,6 +73,10 @@
                 <dd>
                   <xsl:apply-templates select="description"/>
                 </dd>
+
+<xsl:text>
+</xsl:text> <!-- insert line break -->
+
               </xsl:if>
             </xsl:for-each>
           </dl>
@@ -52,14 +87,16 @@
 
         <div class="section">
           <h2>
-            <xsl:value-of select="$messages/message[@name='othermodules']"/>
+            <a name="other" id="other">
+              <xsl:value-of select="$messages/message[@name='othermodules']"/>
+            </a>
           </h2>
             
           <dl>
             <xsl:for-each select="document(sitemap/category[@id='modules']/modulefilelist/modulefile)/modulesynopsis">
               <xsl:sort select="name"/>
                 
-              <xsl:if test="status!='MPM' and status!='Core'">
+              <xsl:if test="status!='MPM' and status!='Core' and status!='Obsolete'">
                 <dt>
                   <a href="{name}.html">
                     <xsl:value-of select="name"/>
@@ -68,12 +105,59 @@
                 <dd>
                   <xsl:apply-templates select="description"/>
                 </dd>
+
+<xsl:text>
+</xsl:text> <!-- insert line break -->
+
               </xsl:if>
             </xsl:for-each>
           </dl>
         </div>
         <!-- /modules section -->
 
+        <xsl:call-template name="toplink"/>
+
+        <div class="section">
+          <h2>
+            <a name="obsolete" id="obsolete">
+              <xsl:value-of select="$messages/message[@name='obsoletemodules']"/>
+            </a>
+          </h2>
+            
+          <dl>
+            <xsl:for-each select="document(sitemap/category[@id='modules']/modulefilelist/modulefile)/modulesynopsis">
+              <xsl:sort select="name"/>
+                
+              <xsl:if test="status='Obsolete'">
+                <dt>
+                  <a href="obs_{name}.html">
+                    <xsl:value-of select="name"/>
+                  </a>
+                </dt>
+                <dd>
+                  <xsl:if test="hint">
+                    <em>
+                      <xsl:text>(</xsl:text>
+                      <xsl:apply-templates select="hint"/>
+                      <xsl:text>)</xsl:text>
+                    </em>
+                    <br />
+                  </xsl:if>
+
+                  <xsl:apply-templates select="description"/>
+                </dd>
+
+<xsl:text>
+</xsl:text> <!-- insert line break -->
+
+              </xsl:if>
+            </xsl:for-each>
+          </dl>
+        </div>
+        <!-- /obsolete section -->
+
+        </div> <!-- /page-content -->
+
         <xsl:call-template name="bottom"/>
 
       </body>

diff --git a/docs/manual/style/xsl/quickreference.xsl b/docs/manual/style/xsl/quickreference.xsl
index e56c965b953cff1bd9fe46c6beeb05203df4d5f4..05a5ffda093c38d10f989face468e3825fdf4890 100644 (file)
--- a/docs/manual/style/xsl/quickreference.xsl
+++ b/docs/manual/style/xsl/quickreference.xsl
@@ -28,7 +28,7 @@
 
         <div id="directive-ref">
 
-         <xsl:variable name="directives" select="document(sitemap/category[@id='modules']/modulefilelist/modulefile)/modulesynopsis/directivesynopsis[not(@location)]"/>
+         <xsl:variable name="directives" select="document(sitemap/category[@id='modules']/modulefilelist/modulefile)/modulesynopsis[status!='Obsolete']/directivesynopsis[not(@location)]"/>
 
           <!-- first collect the start letters -->
           <xsl:variable name="start-letters">

diff --git a/docs/manual/style/xsl/sitemap.xsl b/docs/manual/style/xsl/sitemap.xsl
index 870706116904cb65e0f09bd5143b31dc3dd9f093..2a664b7ce795190fcfe31c23a171ec57fe37b81b 100644 (file)
--- a/docs/manual/style/xsl/sitemap.xsl
+++ b/docs/manual/style/xsl/sitemap.xsl
@@ -199,7 +199,7 @@
         <xsl:sort select="document(concat($basedir,'mod/',.))/modulesynopsis/name"/>
         <xsl:variable name="current" select="document(concat($basedir,'mod/',.))/modulesynopsis" />
 
-        <xsl:if test="$current/status!='MPM' and $current/status!='Core'">
+        <xsl:if test="$current/status!='MPM' and $current/status!='Core' and $current/status!='Obsolete'">
           <li>
             <a href="mod/{$current/name}.html">
               <xsl:value-of select="$messages/message[@name='apachemodule']"/>
@@ -214,8 +214,31 @@
         </xsl:if>
       </xsl:for-each>
       <!-- /other modules -->
-
     </ul>
+
+    <!-- obsolete modules -->
+    <ul>
+      <xsl:for-each select="modulefile">
+        <xsl:sort select="document(concat($basedir,'mod/',.))/modulesynopsis/name"/>
+        <xsl:variable name="current" select="document(concat($basedir,'mod/',.))/modulesynopsis" />
+
+        <xsl:if test="$current/status='Obsolete'">
+          <li>
+            <a href="mod/obs_{$current/name}.html">
+              <xsl:value-of select="$messages/message[@name='obsoleteapachemodule']"/>
+              <xsl:text> </xsl:text>
+              <xsl:value-of select="$current/name"/>
+            </a>
+          </li>
+ 
+<xsl:text>
+</xsl:text> <!-- insert line break -->
+
+        </xsl:if>
+      </xsl:for-each>
+      <!-- /other modules -->
+     </ul>
+
   </xsl:template>
   <!-- /category/modulefilelist -->
 

diff --git a/docs/manual/style/xsl/synopsis.xsl b/docs/manual/style/xsl/synopsis.xsl
index 3fd28784b85dc582eec7dc52691219dfca1f2832..d344a80a25cf9813743aa33008b919e8b67ca1ee 100644 (file)
--- a/docs/manual/style/xsl/synopsis.xsl
+++ b/docs/manual/style/xsl/synopsis.xsl
@@ -18,7 +18,12 @@
         <div id="page-content">
           <div id="preamble">
             <h1>
-              <xsl:value-of select="$messages/message[@name='apachemodule']"/>
+              <xsl:if test="status='Obsolete'">
+                <xsl:value-of select="$messages/message[@name='obsoleteapachemodule']"/>
+              </xsl:if>
+              <xsl:if test="status!='Obsolete'">
+                <xsl:value-of select="$messages/message[@name='apachemodule']"/>
+              </xsl:if>
               <xsl:text> </xsl:text> 
               <xsl:value-of select="name"/>
             </h1>
@@ -44,6 +49,15 @@
                 </th>
                 <td>
                   <xsl:value-of select="status"/>
+
+                  <xsl:if test="hint">
+                    <em>
+                      <xsl:text> (</xsl:text>
+                      <xsl:apply-templates select="hint"/>
+                      <xsl:text>)</xsl:text>
+                    </em>
+                    <br />
+                  </xsl:if>
                 </td>
               </tr>
 
@@ -81,7 +95,7 @@
                   </a>
                 </th>
                 <td>
-                  <xsl:value-of select="compatibility"/>
+                  <xsl:apply-templates select="compatibility"/>
                 </td>
               </tr>
               </xsl:if>
@@ -196,6 +210,14 @@
   <!-- /modulesynopsis -->
 
 
+  <!--                                                            -->
+  <!--    modulesynopsis/compatibility                            -->
+  <!--                                                            -->
+  <xsl:template match="modulesynopsis/compatibility">
+    <xsl:apply-templates />
+  </xsl:template>
+
+
   <!--                                                            -->
   <!--    Directivesynopsis                                       -->
   <!--                                                            -->