From: Christophe Jaillet <jailletc36@apache.org>
Date: Sat, 7 Apr 2018 08:55:11 +0000 (+0000)
Subject: Add a permalink functionality to section and diective-section in the generated doc.
X-Git-Tag: 2.5.0-alpha2-ci-test-only~2718
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fa84d342992aa52718e2af2937dbaec1930c5491;p=thirdparty%2Fapache%2Fhttpd.git

Add a permalink functionality to section and diective-section in the generated doc.
This is convenient and consistent with httpd.a.o

Getting a link to a section or a directive is already possible from the TOC, but having it available directly in-place is, IMHO, much more useful.

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

diff --git a/docs/manual/style/lang/da.xml b/docs/manual/style/lang/da.xml
index c7be52ae55e..bca1670ece6 100644
--- a/docs/manual/style/lang/da.xml
+++ b/docs/manual/style/lang/da.xml
@@ -76,6 +76,7 @@
         <message id="httpdchangelog">httpd changelog</message>
         <message id="httpdknownissues">Known issues</message>
         <message id="httpdreportabug">Report a bug</message>
+        <message id="permalink">Permanent link</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 653f3db0dc8..f39113a34b1 100644
--- a/docs/manual/style/lang/de.xml
+++ b/docs/manual/style/lang/de.xml
@@ -71,6 +71,7 @@
         <message id="httpdchangelog">httpd changelog</message>
         <message id="httpdknownissues">Known issues</message>
         <message id="httpdreportabug">Report a bug</message>
+        <message id="permalink">Permanent link</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 4e97a89091f..5c1599e0631 100644
--- a/docs/manual/style/lang/en.xml
+++ b/docs/manual/style/lang/en.xml
@@ -75,6 +75,7 @@
         <message id="httpdchangelog">httpd changelog</message>
         <message id="httpdknownissues">Known issues</message>
         <message id="httpdreportabug">Report a bug</message>
+        <message id="permalink">Permanent link</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 e143f5031c5..213cf2d37fa 100644
--- a/docs/manual/style/lang/es.xml
+++ b/docs/manual/style/lang/es.xml
@@ -79,6 +79,7 @@
         <message id="httpdchangelog">httpd changelog</message>
         <message id="httpdknownissues">Known issues</message>
         <message id="httpdreportabug">Report a bug</message>
+        <message id="permalink">Permanent link</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 52d6aadc239..af325294f88 100644
--- a/docs/manual/style/lang/fr.xml
+++ b/docs/manual/style/lang/fr.xml
@@ -75,6 +75,7 @@
         <message id="httpdchangelog">Journal des modifications de httpd</message>
         <message id="httpdknownissues">Probl&#232;mes connus</message>
         <message id="httpdreportabug">Signaler un bug</message>
+        <message id="permalink">Lien permanent</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 060bf2d5a24..ebe75459ce7 100644
--- a/docs/manual/style/lang/ja.xml
+++ b/docs/manual/style/lang/ja.xml
@@ -70,6 +70,7 @@
         <message id="httpdchangelog">httpd changelog</message>
         <message id="httpdknownissues">Known issues</message>
         <message id="httpdreportabug">Report a bug</message>
+        <message id="permalink">Permanent link</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 b219246ffb7..a2227757d8d 100644
--- a/docs/manual/style/lang/ko.xml
+++ b/docs/manual/style/lang/ko.xml
@@ -76,6 +76,7 @@
         <message id="httpdchangelog">httpd changelog</message>
         <message id="httpdknownissues">Known issues</message>
         <message id="httpdreportabug">Report a bug</message>
+        <message id="permalink">Permanent link</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 d2e4ad54862..b58e6c22569 100644
--- a/docs/manual/style/lang/pt-br.xml
+++ b/docs/manual/style/lang/pt-br.xml
@@ -74,6 +74,7 @@
         <message id="httpdchangelog">httpd changelog</message>
         <message id="httpdknownissues">Known issues</message>
         <message id="httpdreportabug">Report a bug</message>
+        <message id="permalink">Permanent link</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 0a7d3df89cd..37d5e62a913 100644
--- a/docs/manual/style/lang/ru.xml
+++ b/docs/manual/style/lang/ru.xml
@@ -74,6 +74,7 @@
         <message id="httpdchangelog">httpd changelog</message>
         <message id="httpdknownissues">Known issues</message>
         <message id="httpdreportabug">Report a bug</message>
+        <message id="permalink">Permanent link</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 68d05bec1a8..77a90ed62d7 100644
--- a/docs/manual/style/lang/tr.xml
+++ b/docs/manual/style/lang/tr.xml
@@ -77,6 +77,7 @@
         <message id="httpdchangelog">httpd changelog</message>
         <message id="httpdknownissues">Known issues</message>
         <message id="httpdreportabug">Report a bug</message>
+        <message id="permalink">Permanent link</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 04b7f851d4a..8da870e10d6 100644
--- a/docs/manual/style/lang/zh-cn.xml
+++ b/docs/manual/style/lang/zh-cn.xml
@@ -73,6 +73,7 @@
         <message id="httpdchangelog">httpd changelog</message>
         <message id="httpdknownissues">Known issues</message>
         <message id="httpdreportabug">Report a bug</message>
+        <message id="permalink">Permanent link</message>
 
         <!-- Used in description box for directives -->
         <message id="syntax">语法</message>
diff --git a/docs/manual/style/xsl/common.xsl b/docs/manual/style/xsl/common.xsl
index 20701ff16c3..d6905ce0d88 100644
--- a/docs/manual/style/xsl/common.xsl
+++ b/docs/manual/style/xsl/common.xsl
@@ -18,8 +18,9 @@
 -->
 
 <!DOCTYPE xsl:stylesheet [
-    <!ENTITY nbsp SYSTEM "util/nbsp.xml">
     <!ENTITY lf SYSTEM "util/lf.xml">
+    <!ENTITY nbsp SYSTEM "util/nbsp.xml">
+    <!ENTITY para SYSTEM "util/para.xml">
     <!ENTITY % HTTPD-VERSION SYSTEM "../version.ent">
     %HTTPD-VERSION;
 ]>
@@ -522,6 +523,7 @@ if (typeof(prettyPrint) !== 'undefined') {
           <a id="{@id}" name="{@id}">
               <xsl:apply-templates select="title" mode="print" />
           </a>
+          <a class="permalink" href="#{@id}" title="{$message[@id='permalink']}">&para;</a>
         </xsl:when>
 
         <xsl:otherwise>
diff --git a/docs/manual/style/xsl/synopsis.xsl b/docs/manual/style/xsl/synopsis.xsl
index 401ac5ff250..9ab0e5338dd 100644
--- a/docs/manual/style/xsl/synopsis.xsl
+++ b/docs/manual/style/xsl/synopsis.xsl
@@ -19,6 +19,7 @@
 
 <!DOCTYPE xsl:stylesheet [
     <!ENTITY lf SYSTEM "util/lf.xml">
+    <!ENTITY para SYSTEM "util/para.xml">
 ]>
 <xsl:stylesheet version="1.0"
               xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
@@ -425,6 +426,7 @@
                 </a>
             </xsl:otherwise>
             </xsl:choose>
+        <a class="permalink" href="#{$lowername}" title="{$message[@id='permalink']}">&para;</a>
         </h2>&lf;
 
         <!-- Directive header -->
diff --git a/docs/manual/style/xsl/util/para.xml b/docs/manual/style/xsl/util/para.xml
new file mode 100644
index 00000000000..f02d643ec25
--- /dev/null
+++ b/docs/manual/style/xsl/util/para.xml
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<xsl:text disable-output-escaping="yes" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">&amp;para;</xsl:text>