Backport of the "Bugfix checklist" panel from trunk. Each module's page gets

a new section on the right panel containing three links:
- httpd changelog
- Bugzilla issues related to the module
- Open a bugzilla issue related to the module
This commit also fixes a minor inconsistency for the "comments" link, that is
now always displayed under "See also"

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1741814 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/docs/manual/style/lang/da.xml b/docs/manual/style/lang/da.xml
index 337623d3e95ed3d2ca1cb29affa5bc17e2d03d82..c7be52ae55ec54bdd369d0f4eb662ef3e4283666 100644 (file)
--- a/docs/manual/style/lang/da.xml
+++ b/docs/manual/style/lang/da.xml
@@ -72,6 +72,10 @@
         <message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZÆØÅ</message>
         <message id="name-section">NAVN</message>
         <message id="hyphenation"></message>
+        <message id="foundabug">Bugfix checklist</message>
+        <message id="httpdchangelog">httpd changelog</message>
+        <message id="httpdknownissues">Known issues</message>
+        <message id="httpdreportabug">Report a bug</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">Syntaks</message>

diff --git a/docs/manual/style/lang/de.xml b/docs/manual/style/lang/de.xml
index 1f98debf5617899e316384a1203367ae74610baf..653f3db0dc8a0588b72902c00203c7e29cfcc542 100644 (file)
--- a/docs/manual/style/lang/de.xml
+++ b/docs/manual/style/lang/de.xml
@@ -67,6 +67,10 @@
         <message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
         <message id="name-section">NAME</message>
         <message id="hyphenation"></message>
+        <message id="foundabug">Bugfix checklist</message>
+        <message id="httpdchangelog">httpd changelog</message>
+        <message id="httpdknownissues">Known issues</message>
+        <message id="httpdreportabug">Report a bug</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">Syntax</message>

diff --git a/docs/manual/style/lang/en.xml b/docs/manual/style/lang/en.xml
index 0ad828cafb4405e496d61edfd621b7e43c4b55c9..4671515297558870cd62e1b09df8f55748836028 100644 (file)
--- a/docs/manual/style/lang/en.xml
+++ b/docs/manual/style/lang/en.xml
@@ -71,6 +71,10 @@
         <message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
         <message id="name-section">NAME</message>
         <message id="hyphenation"></message>
+        <message id="foundabug">Bugfix checklist</message>
+        <message id="httpdchangelog">httpd changelog</message>
+        <message id="httpdknownissues">Known issues</message>
+        <message id="httpdreportabug">Report a bug</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">Syntax</message>

diff --git a/docs/manual/style/lang/es.xml b/docs/manual/style/lang/es.xml
index f4b562a433f105cb62d4736c147b0ac480eafae6..dc2b323cbe92d2b8e1d14b60e6fea5459281df79 100644 (file)
--- a/docs/manual/style/lang/es.xml
+++ b/docs/manual/style/lang/es.xml
@@ -69,6 +69,10 @@
         <message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
         <message id="name-section">NOMBRE</message>
         <message id="hyphenation">Cesura</message>
+        <message id="foundabug">Bugfix checklist</message>
+        <message id="httpdchangelog">httpd changelog</message>
+        <message id="httpdknownissues">Known issues</message>
+        <message id="httpdreportabug">Report a bug</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">Sintaxis</message>

diff --git a/docs/manual/style/lang/fr.xml b/docs/manual/style/lang/fr.xml
index ed2db8a653702b424d153c809a577e52b6db6026..579a8caf0a67a4fe7fd8ebd2aefaaed977912883 100644 (file)
--- a/docs/manual/style/lang/fr.xml
+++ b/docs/manual/style/lang/fr.xml
@@ -71,6 +71,10 @@
         <message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
         <message id="name-section">NOM</message>
         <message id="hyphenation">C&#233;sure</message>
+        <message id="foundabug">Bugfix checklist</message>
+        <message id="httpdchangelog">httpd changelog</message>
+        <message id="httpdknownissues">Known issues</message>
+        <message id="httpdreportabug">Report a bug</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">Syntaxe</message>

diff --git a/docs/manual/style/lang/ja.xml b/docs/manual/style/lang/ja.xml
index 744fb0f4884f96e8b5de1d06f96e00b7671c7bc1..060bf2d5a24254fafabfc4c823afa583db435ada 100644 (file)
--- a/docs/manual/style/lang/ja.xml
+++ b/docs/manual/style/lang/ja.xml
@@ -66,6 +66,10 @@
         <message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
         <message id="name-section">NAME</message>
         <message id="hyphenation"></message>
+        <message id="foundabug">Bugfix checklist</message>
+        <message id="httpdchangelog">httpd changelog</message>
+        <message id="httpdknownissues">Known issues</message>
+        <message id="httpdreportabug">Report a bug</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">構文</message>

diff --git a/docs/manual/style/lang/ko.xml b/docs/manual/style/lang/ko.xml
index e8d02b113e3f85f5844fd14ce4e73d444388ec7b..b219246ffb7fda5f579e6aa03d612a4ce6ddaae1 100644 (file)
--- a/docs/manual/style/lang/ko.xml
+++ b/docs/manual/style/lang/ko.xml
@@ -72,6 +72,10 @@
         <message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
         <message id="name-section">NAME</message>
         <message id="hyphenation"></message>
+        <message id="foundabug">Bugfix checklist</message>
+        <message id="httpdchangelog">httpd changelog</message>
+        <message id="httpdknownissues">Known issues</message>
+        <message id="httpdreportabug">Report a bug</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">¹®¹ý</message>

diff --git a/docs/manual/style/lang/pt-br.xml b/docs/manual/style/lang/pt-br.xml
index c25b729b6121485e3f1b987ab6ef3d87904f5552..d2e4ad54862acc488826ae0b82bd2becfaef79ed 100644 (file)
--- a/docs/manual/style/lang/pt-br.xml
+++ b/docs/manual/style/lang/pt-br.xml
@@ -70,6 +70,10 @@
         <!-- Used in manualpage -->
         <message id="relatedmodules">M&#243;dulos Relacionados</message>
         <message id="relateddirectives">Diretrizes Relacionadas</message>
+        <message id="foundabug">Bugfix checklist</message>
+        <message id="httpdchangelog">httpd changelog</message>
+        <message id="httpdknownissues">Known issues</message>
+        <message id="httpdreportabug">Report a bug</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">Sintaxe</message>

diff --git a/docs/manual/style/lang/ru.xml b/docs/manual/style/lang/ru.xml
index 531324d05d5448a90b7a6e1980c610128e3ac5f1..0a7d3df89cd5a843556bd476fab73de5a124d329 100644 (file)
--- a/docs/manual/style/lang/ru.xml
+++ b/docs/manual/style/lang/ru.xml
@@ -70,6 +70,10 @@
         <message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
         <message id="name-section">NAME</message>
         <message id="hyphenation"></message>
+        <message id="foundabug">Bugfix checklist</message>
+        <message id="httpdchangelog">httpd changelog</message>
+        <message id="httpdknownissues">Known issues</message>
+        <message id="httpdreportabug">Report a bug</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">óÉÎÔÁËÓÉÓ</message>

diff --git a/docs/manual/style/lang/tr.xml b/docs/manual/style/lang/tr.xml
index 2e1f723d8aad8b2bec27f3f49851bbf3c24ba789..68d05bec1a87ba0bc422eaa7555a486ece36da77 100644 (file)
--- a/docs/manual/style/lang/tr.xml
+++ b/docs/manual/style/lang/tr.xml
@@ -73,6 +73,10 @@
         <message id="uppercase">ABCÇDEFGĞHIİJKLMNOÖPQRSŞTUÜVWXYZ</message>
         <message id="name-section">İSİM</message>
         <message id="hyphenation">.nh</message>
+        <message id="foundabug">Bugfix checklist</message>
+        <message id="httpdchangelog">httpd changelog</message>
+        <message id="httpdknownissues">Known issues</message>
+        <message id="httpdreportabug">Report a bug</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">Sözdizimi</message>

diff --git a/docs/manual/style/lang/zh-cn.xml b/docs/manual/style/lang/zh-cn.xml
index c4093567c6da591e137c85f929461396c5d12679..04b7f851d4ab1543b7190ef04220c0f10484b83a 100644 (file)
--- a/docs/manual/style/lang/zh-cn.xml
+++ b/docs/manual/style/lang/zh-cn.xml
@@ -69,6 +69,10 @@
         <message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
         <message id="name-section">名称</message>
         <message id="hyphenation"></message>
+        <message id="foundabug">Bugfix checklist</message>
+        <message id="httpdchangelog">httpd changelog</message>
+        <message id="httpdknownissues">Known issues</message>
+        <message id="httpdreportabug">Report a bug</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">语法</message>

diff --git a/docs/manual/style/xsl/manualpage.xsl b/docs/manual/style/xsl/manualpage.xsl
index 4f1073aa1068a62f91d52065595f4b07b382acda..d78c4ea96984643124f487b426a83f1a37593b1d 100644 (file)
--- a/docs/manual/style/xsl/manualpage.xsl
+++ b/docs/manual/style/xsl/manualpage.xsl
@@ -38,12 +38,12 @@
           <xsl:attribute name="class">no-sidebar</xsl:attribute>
         </xsl:if>
 
-        <xsl:call-template name="top"/>          
+        <xsl:call-template name="top"/>
 
         <div id="page-content">
             <xsl:call-template name="retired" />
 
-            <div id="preamble">        
+            <div id="preamble">
                 <h1>
                     <xsl:value-of select="title"/>
                 </h1>&lf;
@@ -52,7 +52,7 @@
 
                 <xsl:apply-templates select="summary" />
             </div>&lf; <!-- /#preamble -->
-          
+
             <xsl:if test="(not($is-chm) and count(section) > 1) or seealso">
                 <div id="quickview">
                     <xsl:if test="not($is-chm) and count(section) > 1">
@@ -61,7 +61,10 @@
                         </ul>
                     </xsl:if>
 
-                    <xsl:if test="seealso">
+                    <!-- The seealso section shows links to related documents
+                         explicitly set in .xml docs or simply the comments. -->
+                    <xsl:if test="seealso or not($is-chm or $is-zip or
+                                                $metafile/basename = 'index')">
                         <h3>
                             <xsl:value-of
                                 select="$message[@id='seealso']" />
@@ -72,15 +75,13 @@
                                 <xsl:apply-templates />
                             </li>
                         </xsl:for-each>
+                        <xsl:if test="not($is-chm or $is-zip or $metafile/basename = 'index')">
+                            <li><a href="#comments_section"><xsl:value-of
+                                        select="$message[@id='comments']" /></a>
+                            </li>
+                        </xsl:if>
                         </ul>
                     </xsl:if>
-                    <xsl:if test="not($is-chm or $is-zip or $metafile/basename = 'index')">
-                    <ul class="seealso">
-                        <li><a href="#comments_section"><xsl:value-of
-                                select="$message[@id='comments']" /></a>
-                        </li>
-                    </ul>
-                    </xsl:if>
                 </div>&lf; <!-- /#quickview -->
             </xsl:if>
 

diff --git a/docs/manual/style/xsl/synopsis.xsl b/docs/manual/style/xsl/synopsis.xsl
index 638747b494525bac662ef644f08cc17b17b0d549..88e03174cac30f951b0e751d0a8e4c50a1128475 100644 (file)
--- a/docs/manual/style/xsl/synopsis.xsl
+++ b/docs/manual/style/xsl/synopsis.xsl
@@ -244,7 +244,72 @@
                         </xsl:choose>
                     </xsl:if> <!-- /!is-chm -->
 
-                    <xsl:if test="seealso">
+                    <h3>
+                       <xsl:value-of select="$message[@id='foundabug']" />
+                    </h3>
+                    <ul class="seealso">
+                        <!-- Bugzilla mpm components are prefixed with
+                            'mpm_', meanwhile the page name in the docs do
+                            not contain it. For example, Bugzilla has
+                            the 'mpm_event' component and the doc has the
+                            'event' page. This creates an inconsistency
+                            in the URL generation, fixed by the following
+                            check. -->
+                        <xsl:variable name="bugzilla_prefix">
+                            <xsl:choose>
+                                <xsl:when test="name='worker' or name='event'
+                                                or name='prefork'">
+                                    <xsl:value-of select="string('mpm_')"/>
+                                </xsl:when>
+                            </xsl:choose>
+                        </xsl:variable>
+                        <li>
+                            <!-- The link below is not dynamic and points only
+                                 to the 2.4 release since it makes sense to keep
+                                 it as reference even for trunk. -->
+                            <a href="https://www.apache.org/dist/httpd/CHANGES_2.4">
+                                <xsl:value-of
+                                    select="$message[@id='httpdchangelog']" />
+                            </a>
+                        </li>
+                        <li>
+                            <!-- Bugzilla mpm components are prefixed with
+                                'mpm_', meanwhile the page name in the docs do
+                                not contain it. For example, Bugzilla has
+                                the 'mpm_event' component and the doc has the
+                                'event' page. This creates a inconsistency
+                                in the URL generation, fixed by the following
+                                check. -->
+                            <xsl:variable name="bugzilla_prefix">
+                                <xsl:choose>
+                                    <xsl:when test="name='worker' or name='event'
+                                                    or name='prefork'">
+                                        <xsl:value-of select="string('mpm_')"/>
+                                    </xsl:when>
+                                </xsl:choose>
+                            </xsl:variable>
+
+                            <!-- The line below is not splitted in multiple
+                                 lines to avoid rendering a broken URL. -->
+                            <a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component={$bugzilla_prefix}{name}">
+
+                                <xsl:value-of
+                                    select="$message[@id='httpdknownissues']" />
+                            </a>
+                        </li>
+                        <li>
+                            <!-- The line below is not splitted in multiple
+                                 lines to avoid rendering a broken URL. -->
+                            <a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component={$bugzilla_prefix}{name}">
+                                <xsl:value-of
+                                    select="$message[@id='httpdreportabug']" />
+                            </a>
+                        </li>
+                    </ul>
+                    <!-- The seealso section shows links to related documents
+                         explicitly set in .xml docs or simply the comments. -->
+                    <xsl:if test="seealso or not($is-chm or $is-zip or
+                                                $metafile/basename = 'index')">
                            <h3>
                             <xsl:value-of select="$message
                                                   [@id='seealso']" />
@@ -256,15 +321,13 @@
                                 <xsl:apply-templates />
                             </li>&lf;
                         </xsl:for-each>
+                        <xsl:if test="not($is-chm or $is-zip or $metafile/basename = 'index')">
+                            <li><a href="#comments_section"><xsl:value-of
+                                    select="$message[@id='comments']" /></a>
+                            </li>
+                        </xsl:if>
                         </ul>
                     </xsl:if>
-                    <xsl:if test="not($is-chm or $is-zip or $metafile/basename = 'index')">
-                    <ul class="seealso">
-                        <li><a href="#comments_section"><xsl:value-of
-                                select="$message[@id='comments']" /></a>
-                        </li>
-                    </ul>
-                    </xsl:if>
                 </div> <!-- /#quickview -->
             </xsl:if>&lf; <!-- have sidebar -->