Hi Apache doc writers,

I discussed in dev@ an idea to put the following banner on each
documentation page of the 2.2 branch:

--------------------
Please note
This document refers to the 2.2 version of Apache httpd that is still
maintained but not actively developed. Please upgrade to the current
version of Apache httpd to get performance improvements and new features.
The migration of the configuration files will require a bit of effort but
it will be definitely worth it in terms of performance and long term
maintainability.

Upgrading to the current version of Apache httpd (link to
http://httpd.apache.org/docs/current/upgrading.html)

You may follow this link to go to the current version of this document.
--------------------

The goal would be to inform and remember to 2.2 users that the migration to
2.4 is strongly suggested. I attached a patch to this email to give you an
idea of what I have in mind.

Main things to discuss since this is a big change:

1) Is the wording ok? Do we need a different banner?
2) I reused the "retirement" scheme that was present since 2.0 to avoid
code repetition, but let me know if you want me to duplicate it.
3) I added the english banner to all the lang.* files, not sure if we need
translations before proceeding.

Let me know your thoughts and ideas :)

Thanks!

Luca
Index: docs/manual/style/lang/de.xml
===================================================================
--- docs/manual/style/lang/de.xml       (revision 1731238)
+++ docs/manual/style/lang/de.xml       (working copy)
@@ -148,13 +148,14 @@
             noch nicht übersetzt. Bitte schauen Sie in die englische
             Version.</message>
 
-        <!-- retirement -->
-        <message id="retired.headline">Bitte beachten!</message>
+        <!-- retirement (needs translation) -->
+        <message id="retired.headline">Please note</message>
         <message id="retired.description">
-            <p>Dieses Dokument bezieht sich auf Version <strong>2.0</strong> 
des Apache httpd, die <strong>nicht mehr gepflegt wird</strong>. Bitte 
aktualisieren Sie die Software und verwenden Sie stattdessen eine aktuelle 
Version des httpd, die an folgender Stelle dokumentiert ist:</p>
+            <p>This document refers to the <strong>2.2</strong> version of 
Apache httpd that is still maintained but not actively developed. Please 
upgrade to the current version of Apache httpd to get performance improvements 
and new features. The migration of the configuration files will require a bit 
of effort but it will be definitely worth it in terms of performance and long 
term maintainability.
+            </p>
         </message>
-        <message id="retired.current">Dokumentation des Apache HTTP Server 
f&#252;r die zuletzt erschienene Version</message>
-        <message id="retired.document">Sie k�nnen <link>diesem Link</link> 
folgen, um zur aktuellen Version dieses Dokuments zu gelangen.</message>
+        <message id="retired.upgrading">Upgrading to the current version of 
Apache httpd</message>
+        <message id="retired.document">You may follow <link>this link</link> 
to go to the current version of this document.</message>
 
     </messages>
 </language>
Index: docs/manual/style/lang/en.xml
===================================================================
--- docs/manual/style/lang/en.xml       (revision 1731238)
+++ docs/manual/style/lang/en.xml       (working copy)
@@ -151,9 +151,10 @@
         <!-- retirement -->
         <message id="retired.headline">Please note</message>
         <message id="retired.description">
-            <p>This document refers to the <strong>2.0</strong> version of 
Apache httpd, which <strong>is no longer maintained</strong>. Upgrade, and 
refer to the current version of httpd instead, documented at:</p>
+            <p>This document refers to the <strong>2.2</strong> version of 
Apache httpd that is still maintained but not actively developed. Please 
upgrade to the current version of Apache httpd to get performance improvements 
and new features. The migration of the configuration files will require a bit 
of effort but it will be definitely worth it in terms of performance and long 
term maintainability.
+            </p>
         </message>
-        <message id="retired.current">Current release version of Apache HTTP 
Server documentation</message>
+        <message id="retired.upgrading">Upgrading to the current version of 
Apache httpd</message>
         <message id="retired.document">You may follow <link>this link</link> 
to go to the current version of this document.</message>
 
     </messages>
Index: docs/manual/style/lang/es.xml
===================================================================
--- docs/manual/style/lang/es.xml       (revision 1731238)
+++ docs/manual/style/lang/es.xml       (working copy)
@@ -148,12 +148,13 @@
             not been translated yet. Please have a look at the English
             version.</message>
 
-        <!-- retirement -->
+        <!-- retirement (needs translation) -->
         <message id="retired.headline">Please note</message>
         <message id="retired.description">
-            <p>This document refers to the <strong>2.0</strong> version of 
Apache httpd, which <strong>is no longer maintained</strong>. Upgrade, and 
refer to the current version of httpd instead, documented at:</p>
+            <p>This document refers to the <strong>2.2</strong> version of 
Apache httpd that is still maintained but not actively developed. Please 
upgrade to the current version of Apache httpd to get performance improvements 
and new features. The migration of the configuration files will require a bit 
of effort but it will be definitely worth it in terms of performance and long 
term maintainability.
+            </p>
         </message>
-        <message id="retired.current">Current release version of Apache HTTP 
Server documentation</message>
+        <message id="retired.upgrading">Upgrading to the current version of 
Apache httpd</message>
         <message id="retired.document">You may follow <link>this link</link> 
to go to the current version of this document.</message>
 
     </messages>
Index: docs/manual/style/lang/fr.xml
===================================================================
--- docs/manual/style/lang/fr.xml       (revision 1731238)
+++ docs/manual/style/lang/fr.xml       (working copy)
@@ -149,13 +149,14 @@
        n'a pas encore &eacute;t&eacute; traduite. Veuillez vous reporter 
&agrave; la version
        en langue anglaise.</message>
 
-        <!-- retirement -->
-        <message id="retired.headline">A savoir</message>
+        <!-- retirement (needs translation) -->
+        <message id="retired.headline">Please note</message>
         <message id="retired.description">
-            <p>Ce document concerne la version <strong>2.0</strong> du serveur 
HTTP Apache et celle-ci <strong>n'est plus maintenue</strong>. Si vous utilisez 
cette version, il est fortement recommand&eacute; de mettre &agrave; jour votre 
serveur vers la version actuelle (<strong>2.4</strong>), et de consulter la 
documentation correspondante ici :</p>
+            <p>This document refers to the <strong>2.2</strong> version of 
Apache httpd that is still maintained but not actively developed. Please 
upgrade to the current version of Apache httpd to get performance improvements 
and new features. The migration of the configuration files will require a bit 
of effort but it will be definitely worth it in terms of performance and long 
term maintainability.
+            </p>
         </message>
-        <message id="retired.current">Version actuelle de la documentation du 
serveur HTTP Apache</message>
-        <message id="retired.document">Pour consulter la version actuelle de 
ce document, vous pouvez suivre <link>ce lien</link>.</message>
+        <message id="retired.upgrading">Upgrading to the current version of 
Apache httpd</message>
+        <message id="retired.document">You may follow <link>this link</link> 
to go to the current version of this document.</message>
 
     </messages>
 </language>
Index: docs/manual/style/lang/ja.xml
===================================================================
--- docs/manual/style/lang/ja.xml       (revision 1731238)
+++ docs/manual/style/lang/ja.xml       (working copy)
@@ -147,12 +147,13 @@
             まだ翻訳されていません。英語版をご覧ください。
             </message>
 
-        <!-- retirement -->
+        <!-- retirement (needs translation) -->
         <message id="retired.headline">Please note</message>
         <message id="retired.description">
-            <p>This document refers to the <strong>2.0</strong> version of 
Apache httpd, which <strong>is no longer maintained</strong>. Upgrade, and 
refer to the current version of httpd instead, documented at:</p>
+            <p>This document refers to the <strong>2.2</strong> version of 
Apache httpd that is still maintained but not actively developed. Please 
upgrade to the current version of Apache httpd to get performance improvements 
and new features. The migration of the configuration files will require a bit 
of effort but it will be definitely worth it in terms of performance and long 
term maintainability.
+            </p>
         </message>
-        <message id="retired.current">Current release version of Apache HTTP 
Server documentation</message>
+        <message id="retired.upgrading">Upgrading to the current version of 
Apache httpd</message>
         <message id="retired.document">You may follow <link>this link</link> 
to go to the current version of this document.</message>
 
     </messages>
Index: docs/manual/style/lang/pt-br.xml
===================================================================
--- docs/manual/style/lang/pt-br.xml    (revision 1731238)
+++ docs/manual/style/lang/pt-br.xml    (working copy)
@@ -149,12 +149,13 @@
             not been translated yet. Please have a look at the English
             version.</message>
 
-        <!-- retirement -->
+        <!-- retirement (needs translation) -->
         <message id="retired.headline">Please note</message>
         <message id="retired.description">
-            <p>This document refers to the <strong>2.0</strong> version of 
Apache httpd, which <strong>is no longer maintained</strong>. Upgrade, and 
refer to the current version of httpd instead, documented at:</p>
+            <p>This document refers to the <strong>2.2</strong> version of 
Apache httpd that is still maintained but not actively developed. Please 
upgrade to the current version of Apache httpd to get performance improvements 
and new features. The migration of the configuration files will require a bit 
of effort but it will be definitely worth it in terms of performance and long 
term maintainability.
+            </p>
         </message>
-        <message id="retired.current">Current release version of Apache HTTP 
Server documentation</message>
+        <message id="retired.upgrading">Upgrading to the current version of 
Apache httpd</message>
         <message id="retired.document">You may follow <link>this link</link> 
to go to the current version of this document.</message>
 
     </messages>
Index: docs/manual/style/lang/ru.xml
===================================================================
--- docs/manual/style/lang/ru.xml       (revision 1731238)
+++ docs/manual/style/lang/ru.xml       (working copy)
@@ -144,12 +144,13 @@
             not been translated yet. Please have a look at the English
             version.</message>
 
-        <!-- retirement -->
+        <!-- retirement (needs translation) -->
         <message id="retired.headline">Please note</message>
         <message id="retired.description">
-            <p>This document refers to the <strong>2.0</strong> version of 
Apache httpd, which <strong>is no longer maintained</strong>. Upgrade, and 
refer to the current version of httpd instead, documented at:</p>
+            <p>This document refers to the <strong>2.2</strong> version of 
Apache httpd that is still maintained but not actively developed. Please 
upgrade to the current version of Apache httpd to get performance improvements 
and new features. The migration of the configuration files will require a bit 
of effort but it will be definitely worth it in terms of performance and long 
term maintainability.
+            </p>
         </message>
-        <message id="retired.current">Current release version of Apache HTTP 
Server documentation</message>
+        <message id="retired.upgrading">Upgrading to the current version of 
Apache httpd</message>
         <message id="retired.document">You may follow <link>this link</link> 
to go to the current version of this document.</message>
 
     </messages>
Index: docs/manual/style/lang/tr.xml
===================================================================
--- docs/manual/style/lang/tr.xml       (revision 1731238)
+++ docs/manual/style/lang/tr.xml       (working copy)
@@ -146,14 +146,14 @@
         <!-- directive not translated yet -->
         <message id="nottranslated">Bu yönergenin belgesi henüz Türkçeye 
çevrilmedi.
             Lütfen İngilizce sürümüne bakınız.</message>
-
-        <!-- retirement -->
+        
+        <!-- retirement (needs translation) -->
         <message id="retired.headline">Please note</message>
         <message id="retired.description">
-            <p>This document refers to the <strong>2.0</strong> version of 
Apache httpd, which <strong>is no longer maintained</strong>. Upgrade, and 
refer to the current version of httpd instead, documented at:</p>
+            <p>This document refers to the <strong>2.2</strong> version of 
Apache httpd that is still maintained but not actively developed. Please 
upgrade to the current version of Apache httpd to get performance improvements 
and new features. The migration of the configuration files will require a bit 
of effort but it will be definitely worth it in terms of performance and long 
term maintainability.
+            </p>
         </message>
-        <message id="retired.current">Current release version of Apache HTTP 
Server documentation</message>
+        <message id="retired.upgrading">Upgrading to the current version of 
Apache httpd</message>
         <message id="retired.document">You may follow <link>this link</link> 
to go to the current version of this document.</message>
-
     </messages>
 </language>
Index: docs/manual/style/lang/zh-cn.xml
===================================================================
--- docs/manual/style/lang/zh-cn.xml    (revision 1731238)
+++ docs/manual/style/lang/zh-cn.xml    (working copy)
@@ -141,12 +141,13 @@
         <!-- directive not translated yet -->
         <message id="nottranslated">此指令的文档还没有被翻译。请阅读英文版。</message>
 
-        <!-- retirement -->
+        <!-- retirement (needs translation) -->
         <message id="retired.headline">Please note</message>
         <message id="retired.description">
-            <p>This document refers to the <strong>2.0</strong> version of 
Apache httpd, which <strong>is no longer maintained</strong>. Upgrade, and 
refer to the current version of httpd instead, documented at:</p>
+            <p>This document refers to the <strong>2.2</strong> version of 
Apache httpd that is still maintained but not actively developed. Please 
upgrade to the current version of Apache httpd to get performance improvements 
and new features. The migration of the configuration files will require a bit 
of effort but it will be definitely worth it in terms of performance and long 
term maintainability.
+            </p>
         </message>
-        <message id="retired.current">Current release version of Apache HTTP 
Server documentation</message>
+        <message id="retired.upgrading">Upgrading to the current version of 
Apache httpd</message>
         <message id="retired.document">You may follow <link>this link</link> 
to go to the current version of this document.</message>
 
     </messages>
Index: docs/manual/style/manual.de.xsl
===================================================================
--- docs/manual/style/manual.de.xsl     (revision 1731238)
+++ docs/manual/style/manual.de.xsl     (working copy)
@@ -29,9 +29,9 @@
 <xsl:variable name="output-encoding">ISO-8859-1</xsl:variable>
 <xsl:variable name="is-chm" select="false()"/>
 <xsl:variable name="is-zip" select="false()"/>
-<xsl:variable name="is-retired" select="false()"/>
+<xsl:variable name="is-retired" select="true()"/>
 
 <!-- Now get the real guts of the stylesheet -->
 <xsl:include href="xsl/common.xsl"/>
 
-</xsl:stylesheet>
\ No newline at end of file
+</xsl:stylesheet>
Index: docs/manual/style/manual.en.xsl
===================================================================
--- docs/manual/style/manual.en.xsl     (revision 1731238)
+++ docs/manual/style/manual.en.xsl     (working copy)
@@ -29,7 +29,7 @@
 <xsl:variable name="output-encoding">ISO-8859-1</xsl:variable>
 <xsl:variable name="is-chm" select="false()"/>
 <xsl:variable name="is-zip" select="false()"/>
-<xsl:variable name="is-retired" select="false()"/>
+<xsl:variable name="is-retired" select="true()"/>
 
 <!-- Now get the real guts of the stylesheet -->
 <xsl:include href="xsl/common.xsl"/>
Index: docs/manual/style/manual.es.xsl
===================================================================
--- docs/manual/style/manual.es.xsl     (revision 1731238)
+++ docs/manual/style/manual.es.xsl     (working copy)
@@ -29,9 +29,9 @@
 <xsl:variable name="output-encoding">ISO-8859-1</xsl:variable>
 <xsl:variable name="is-chm" select="false()"/>
 <xsl:variable name="is-zip" select="false()"/>
-<xsl:variable name="is-retired" select="false()"/>
+<xsl:variable name="is-retired" select="true()"/>
 
 <!-- Now get the real guts of the stylesheet -->
 <xsl:include href="xsl/common.xsl"/>
 
-</xsl:stylesheet>
\ No newline at end of file
+</xsl:stylesheet>
Index: docs/manual/style/manual.fr.xsl
===================================================================
--- docs/manual/style/manual.fr.xsl     (revision 1731238)
+++ docs/manual/style/manual.fr.xsl     (working copy)
@@ -29,9 +29,9 @@
 <xsl:variable name="output-encoding">ISO-8859-1</xsl:variable>
 <xsl:variable name="is-chm" select="false()"/>
 <xsl:variable name="is-zip" select="false()"/>
-<xsl:variable name="is-retired" select="false()"/>
+<xsl:variable name="is-retired" select="true()"/>
 
 <!-- Now get the real guts of the stylesheet -->
 <xsl:include href="xsl/common.xsl"/>
 
-</xsl:stylesheet>
\ No newline at end of file
+</xsl:stylesheet>
Index: docs/manual/style/manual.ja.xsl
===================================================================
--- docs/manual/style/manual.ja.xsl     (revision 1731238)
+++ docs/manual/style/manual.ja.xsl     (working copy)
@@ -29,9 +29,9 @@
 <xsl:variable name="output-encoding">UTF-8</xsl:variable>
 <xsl:variable name="is-chm" select="false()"/>
 <xsl:variable name="is-zip" select="false()"/>
-<xsl:variable name="is-retired" select="false()"/>
+<xsl:variable name="is-retired" select="true()"/>
 
 <!-- Now get the real guts of the stylesheet -->
 <xsl:include href="xsl/common.xsl"/>
 
-</xsl:stylesheet>
\ No newline at end of file
+</xsl:stylesheet>
Index: docs/manual/style/manual.pt-br.xsl
===================================================================
--- docs/manual/style/manual.pt-br.xsl  (revision 1731238)
+++ docs/manual/style/manual.pt-br.xsl  (working copy)
@@ -29,9 +29,9 @@
 <xsl:variable name="output-encoding">ISO-8859-1</xsl:variable>
 <xsl:variable name="is-chm" select="false()"/>
 <xsl:variable name="is-zip" select="false()"/>
-<xsl:variable name="is-retired" select="false()"/>
+<xsl:variable name="is-retired" select="true()"/>
 
 <!-- Now get the real guts of the stylesheet -->
 <xsl:include href="xsl/common.xsl"/>
 
-</xsl:stylesheet>
\ No newline at end of file
+</xsl:stylesheet>
Index: docs/manual/style/manual.ru.xsl
===================================================================
--- docs/manual/style/manual.ru.xsl     (revision 1731238)
+++ docs/manual/style/manual.ru.xsl     (working copy)
@@ -29,9 +29,9 @@
 <xsl:variable name="output-encoding">KOI8-R</xsl:variable>
 <xsl:variable name="is-chm" select="false()"/>
 <xsl:variable name="is-zip" select="false()"/>
-<xsl:variable name="is-retired" select="false()"/>
+<xsl:variable name="is-retired" select="true()"/>
 
 <!-- Now get the real guts of the stylesheet -->
 <xsl:include href="xsl/common.xsl"/>
 
-</xsl:stylesheet>
\ No newline at end of file
+</xsl:stylesheet>
Index: docs/manual/style/manual.tr.xsl
===================================================================
--- docs/manual/style/manual.tr.xsl     (revision 1731238)
+++ docs/manual/style/manual.tr.xsl     (working copy)
@@ -29,9 +29,9 @@
 <xsl:variable name="output-encoding">UTF-8</xsl:variable>
 <xsl:variable name="is-chm" select="false()"/>
 <xsl:variable name="is-zip" select="false()"/>
-<xsl:variable name="is-retired" select="false()"/>
+<xsl:variable name="is-retired" select="true()"/>
 
 <!-- Now get the real guts of the stylesheet -->
 <xsl:include href="xsl/common.xsl"/>
 
-</xsl:stylesheet>
\ No newline at end of file
+</xsl:stylesheet>
Index: docs/manual/style/manual.zh-cn.xsl
===================================================================
--- docs/manual/style/manual.zh-cn.xsl  (revision 1731238)
+++ docs/manual/style/manual.zh-cn.xsl  (working copy)
@@ -29,9 +29,9 @@
 <xsl:variable name="output-encoding">UTF-8</xsl:variable>
 <xsl:variable name="is-chm" select="false()"/>
 <xsl:variable name="is-zip" select="false()"/>
-<xsl:variable name="is-retired" select="false()"/>
+<xsl:variable name="is-retired" select="true()"/>
 
 <!-- Now get the real guts of the stylesheet -->
 <xsl:include href="xsl/common.xsl"/>
 
-</xsl:stylesheet>
\ No newline at end of file
+</xsl:stylesheet>
Index: docs/manual/style/xsl/common.xsl
===================================================================
--- docs/manual/style/xsl/common.xsl    (revision 1731238)
+++ docs/manual/style/xsl/common.xsl    (working copy)
@@ -317,11 +317,8 @@
     <div class="retired">
         <h4><xsl:value-of select="$message[@id='retired.headline']" /></h4>
         <xsl:apply-templates select="$message[@id='retired.description']" />
-        <ul>
-            <li><a href="http://httpd.apache.org/docs/current/";>
-                <xsl:value-of select="$message[@id='retired.current']" /></a>
-            </li>
-        </ul>
+        <a href="http://httpd.apache.org/docs/current/upgrading.html";>
+                <xsl:value-of select="$message[@id='retired.upgrading']" /></a>
         <xsl:if test="not($future = '')">
             <p><xsl:apply-templates select="$message[@id='retired.document']" 
mode="retired" /></p>
         </xsl:if>
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscr...@httpd.apache.org
For additional commands, e-mail: docs-h...@httpd.apache.org

Reply via email to