From df88b47cdafcc2e04452456942ea572a7b72e2f2 Mon Sep 17 00:00:00 2001
From: Lars G Thorsen <lars@erlang.org>
Date: Tue, 26 Jan 2010 10:13:35 +0000
Subject: OTP-8343  The documentation is now possible to build in an open
 source           environment after a number of bugs are fixed and some
 features           are added in the documentation build process.

          - The arity calculation is updated.

          - The module prefix used in the function names for bif's are
            removed in the generated links so the links will look like

            http://www.erlang.org/doc/man/erlang.html#append_element-2

            instead of

            http://www.erlang.org/doc/man/erlang.html#erlang:append_element-2

          - Enhanced the menu positioning in the html documentation when a
            new page is loaded.
          - A number of corrections in the generation of man pages (thanks
            to Sergei Golovan)
          - Moved some man pages to more apropriate sections, pages in
            section 4 moved to 5 and pages in 6 moved to 7.
          - The legal notice is taken from the xml book file so OTP's
            build process can be used for non OTP applications.
---
 lib/erl_docgen/priv/xsl/db_man.xsl | 180 +++++++++++++++++++++++++------------
 1 file changed, 125 insertions(+), 55 deletions(-)

(limited to 'lib/erl_docgen/priv/xsl/db_man.xsl')

diff --git a/lib/erl_docgen/priv/xsl/db_man.xsl b/lib/erl_docgen/priv/xsl/db_man.xsl
index c759a77496..300d1ed362 100644
--- a/lib/erl_docgen/priv/xsl/db_man.xsl
+++ b/lib/erl_docgen/priv/xsl/db_man.xsl
@@ -2,20 +2,20 @@
 <!--      
      #
      # %CopyrightBegin%
-     # 
-     # Copyright Ericsson AB 2009. All Rights Reserved.
-     # 
+     #
+     # Copyright Ericsson AB 2009-2010. All Rights Reserved.
+     #
      # The contents of this file are subject to the Erlang Public License,
      # Version 1.1, (the "License"); you may not use this file except in
      # compliance with the License. You should have received a copy of the
      # Erlang Public License along with this software. If not, it can be
      # retrieved online at http://www.erlang.org/.
-     # 
+     #
      # Software distributed under the License is distributed on an "AS IS"
      # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
      # the License for the specific language governing rights and limitations
      # under the License.
-     # 
+     #
      # %CopyrightEnd%
      
      -->
@@ -37,14 +37,12 @@
   
   <!-- *ref/Section -->
   <xsl:template match="erlref/section|comref/section|cref/section|fileref/section|appref/section">
-    <xsl:text>&#10;.RE&#10;</xsl:text>
     <xsl:text>&#10;.SH "</xsl:text><xsl:value-of select="translate(title, 'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/><xsl:text>"&#10;</xsl:text>
     <xsl:apply-templates/>
   </xsl:template>
 
   <!-- *ref/Subsection -->
-  <xsl:template match="erlref/section/section|comref/section/section|cref/section/section|fileref/section/section|appref/section/section">
-    <xsl:text>&#10;.RE&#10;</xsl:text>
+  <xsl:template match="section/section">
     <xsl:text>&#10;.SS "</xsl:text><xsl:value-of select="title"/><xsl:text>"&#10;</xsl:text>
     <xsl:apply-templates/>
   </xsl:template>
@@ -53,9 +51,9 @@
   <!-- Lists -->
   
   <xsl:template match="list">
-    <xsl:text>&#10;.RS 2&#10;</xsl:text>
+    <xsl:text>&#10;.RS 2</xsl:text>
     <xsl:apply-templates/>
-    <xsl:text>&#10;.RE&#10;</xsl:text>
+    <xsl:text>&#10;.RE</xsl:text>
   </xsl:template>
 
   <xsl:template match="list/item">
@@ -65,72 +63,80 @@
       <xsl:apply-templates/>
     </xsl:variable>
     <xsl:value-of select="normalize-space($content)"/>
-    <xsl:text>&#10;.br&#10;</xsl:text>
-    <xsl:text>&#10;.br&#10;</xsl:text>    
+    <xsl:text>&#10;.LP&#10;</xsl:text>
   </xsl:template>
 
   <xsl:template match="taglist">
-    <xsl:text>&#10;.RS 2&#10;</xsl:text>
-    <xsl:apply-templates/>
-    <xsl:text>&#10;.RE&#10;</xsl:text>
+    <xsl:text>&#10;.RS 2</xsl:text>
+    <xsl:apply-templates select="tag|item"/>
+    <xsl:text>&#10;.RE</xsl:text>
   </xsl:template>
   
   <xsl:template match="taglist/tag">
-    <xsl:text>&#10;.TP 4&#10;</xsl:text>
+    <xsl:text>&#10;.TP 2&#10;</xsl:text>
     <xsl:text>.B&#10;</xsl:text>
-    <xsl:apply-templates/>
+    <xsl:apply-templates/><xsl:text>:&#10;</xsl:text>
   </xsl:template>
 
   <xsl:template match="item/p">
     <xsl:variable name="content">
       <xsl:apply-templates/>
     </xsl:variable>
-    <xsl:value-of select="normalize-space($content)"/>
-    <xsl:text>&#10;.br&#10;</xsl:text>
-    <xsl:text>&#10;.br&#10;</xsl:text>
+    <xsl:choose>
+      <xsl:when test="position() = 1">
+        <xsl:value-of select="normalize-space($content)"/>
+      </xsl:when>
+      <xsl:otherwise>
+        <xsl:text>&#10;.RS 2</xsl:text>     
+        <xsl:text>&#10;.LP&#10;&#10;.LP&#10;</xsl:text>     
+        <xsl:value-of select="normalize-space($content)"/>
+        <xsl:text>&#10;.RE</xsl:text>     
+      </xsl:otherwise>
+    </xsl:choose>
   </xsl:template>
 
-
   <xsl:template match="taglist/item">
-    <xsl:text>&#10;</xsl:text>
-    <xsl:apply-templates/>
+    <xsl:choose>
+      <xsl:when test="child::p">
+        <xsl:apply-templates/>        
+      </xsl:when>
+      <xsl:otherwise>
+        <xsl:variable name="content">
+          <xsl:apply-templates/>
+        </xsl:variable>
+        <xsl:value-of select="normalize-space($content)"/>
+      </xsl:otherwise>
+    </xsl:choose>
   </xsl:template>
 
   <!-- Note -->
   <xsl:template match="note">
-    <xsl:text>&#10;.TP 4&#10;.B&#10;Note:&#10;</xsl:text>
+    <xsl:text>&#10;.SS Note:</xsl:text>
     <xsl:apply-templates/>
+    <xsl:text>&#10;</xsl:text>
   </xsl:template>
 
   <!-- Warning -->
   <xsl:template match="warning">
-    <xsl:text>&#10;.TP 4&#10;.B&#10;Warning:&#10;</xsl:text>
+    <xsl:text>&#10;.SS Warning:</xsl:text>
     <xsl:apply-templates/>
+    <xsl:text>&#10;</xsl:text>
   </xsl:template>
 
-  <xsl:template match="warning/p|note/p">
-    <xsl:variable name="content">
-      <xsl:apply-templates/>
-    </xsl:variable>
-    <xsl:value-of select="normalize-space($content)"/>
-    <xsl:text>&#10;.LP&#10;</xsl:text>
-  </xsl:template>
-
-
  <!-- Paragraph -->
   <xsl:template match="p">
-    <xsl:text>&#10;.LP&#10;</xsl:text>
     <xsl:variable name="content">
       <xsl:apply-templates/>
     </xsl:variable>
+    <xsl:text>&#10;.LP&#10;</xsl:text>
     <xsl:value-of select="normalize-space($content)"/>
   </xsl:template>
 
   <!-- Inline elements -->
   <xsl:template match="b">
-    <xsl:text> \fB</xsl:text>
+    <xsl:text>\fB</xsl:text>
     <xsl:apply-templates/>
-    <xsl:text>\fR\&amp;</xsl:text>
+    <xsl:text>\fR\&amp; </xsl:text>
   </xsl:template>
 
   <xsl:template match="br">
@@ -138,19 +144,20 @@
   </xsl:template>
 
   <xsl:template match="c">
-    <xsl:text> \fI</xsl:text><xsl:value-of select="text()"/><xsl:text>\fR\&amp;</xsl:text>
+    <xsl:text>\fI</xsl:text><xsl:apply-templates/><xsl:text>\fR\&amp;</xsl:text>
   </xsl:template>
 
   <xsl:template match="em">
-    <xsl:text> \fI</xsl:text><xsl:value-of select="text()"/><xsl:text>\fR\&amp;</xsl:text>
+    <xsl:text>\fI</xsl:text> <xsl:apply-templates/><xsl:text>\fR\&amp;</xsl:text>
   </xsl:template>
 
   <xsl:template match="seealso">
-    <xsl:text> \fB</xsl:text><xsl:apply-templates/><xsl:text>\fR\&amp;</xsl:text>
+    <xsl:text>\fB</xsl:text><xsl:apply-templates/><xsl:text>\fR\&amp;</xsl:text>
   </xsl:template>
 
   <!-- Code -->
   <xsl:template match="code">
+    <xsl:text>&#10;.LP&#10;</xsl:text>
     <xsl:text>&#10;.nf&#10;</xsl:text>
     <xsl:apply-templates/>
     <xsl:text>&#10;.fi&#10;</xsl:text>
@@ -158,6 +165,7 @@
 
   <!-- Pre -->
   <xsl:template match="pre">
+    <xsl:text>&#10;.LP&#10;</xsl:text>
     <xsl:text>&#10;.nf&#10;</xsl:text>
     <xsl:apply-templates/>
     <xsl:text>&#10;.fi&#10;</xsl:text>
@@ -168,16 +176,7 @@
   <xsl:template match="table">
   </xsl:template>
 
-  <!--xsl:template match="row">
-      <xsl:apply-templates/>
-  </xsl:template>
-
-  <xsl:template match="cell">
-      <xsl:apply-templates/>
-  </xsl:template -->
-
-
-  <!-- Image -->
+ <!-- Image -->
   <xsl:template match="image">
   </xsl:template>
 
@@ -192,7 +191,7 @@
   <!-- Erlref -->
   <xsl:template match="/erlref">
       <xsl:text>.TH </xsl:text><xsl:value-of select="module"/><xsl:text> 3 "</xsl:text><xsl:value-of select="$appname"/><xsl:text> </xsl:text><xsl:value-of select="$appver"/><xsl:text>" "Ericsson AB" "Erlang Module Definition"&#10;</xsl:text>
-      <xsl:text>.SH MODULE&#10;</xsl:text>
+      <xsl:text>.SH NAME&#10;</xsl:text>
       <xsl:value-of select="module"/><xsl:text> \- </xsl:text><xsl:value-of select="modulesummary"/><xsl:text>&#10;</xsl:text>  
       <xsl:apply-templates/>
   </xsl:template>
@@ -225,7 +224,7 @@
   <xsl:template match="/appref">
       <xsl:text>.TH </xsl:text><xsl:value-of select="app"/><xsl:text> 6 "</xsl:text><xsl:value-of select="$appname"/><xsl:text> </xsl:text><xsl:value-of select="$appver"/><xsl:text>" "Ericsson AB" "Erlang Application Definition"&#10;</xsl:text>
       <xsl:text>.SH NAME&#10;</xsl:text>
-      <xsl:value-of select="file"/><xsl:text> \- </xsl:text><xsl:value-of select="filesummary"/><xsl:text>&#10;</xsl:text>  
+      <xsl:value-of select="app"/><xsl:text> \- </xsl:text><xsl:value-of select="appsummary"/><xsl:text>&#10;</xsl:text>  
       <xsl:apply-templates/>
   </xsl:template>
 
@@ -297,9 +296,80 @@
     <!-- This tag is skipped for now. -->
   </xsl:template>
 
-  <!-- xsl:template match="p/text()">
-    <xsl:value-of select="normalize-space()"/>
-  </xsl:template-->
+ 
+  <!-- Authors -->
+  <xsl:template match="authors">
+    <xsl:text>&#10;.SH AUTHORS</xsl:text>
+    <xsl:apply-templates/>
+  </xsl:template>
+
+  <!-- Aname -->
+  <xsl:template match="authors/aname">
+    <xsl:text>&#10;.LP&#10;</xsl:text>
+    <xsl:apply-templates/>
+  </xsl:template>
+
+  <!-- Email -->
+  <xsl:template match="authors/email">
+    <xsl:text>&#10;.I&#10;&lt;</xsl:text>
+    <xsl:apply-templates/>
+    <xsl:text>&gt;</xsl:text>
+  </xsl:template>
+
+  <!-- Replace ' by \&' ans . by \&. -->
+  <xsl:template match="text()">
+    <!-- xsl:variable name="content">
+      <xsl:choose>
+        <xsl:when test="ancestor::code or ancestor::c">
+          <xsl:value-of select="."/>
+        </xsl:when>
+        <xsl:otherwise>
+          <xsl:value-of select="normalize-space()"/>
+        </xsl:otherwise>
+      </xsl:choose>
+    </xsl:variable-->
+
+    <xsl:variable name="rep1">
+      <xsl:call-template name="replace-string">
+        <xsl:with-param name="text" select="." />
+        <xsl:with-param name="replace" select="&quot;\&quot;" />
+        <xsl:with-param name="with" select="&quot;\\&quot;" />
+      </xsl:call-template>
+    </xsl:variable>
+    <xsl:variable name="rep2">
+      <xsl:call-template name="replace-string">
+        <xsl:with-param name="text" select="$rep1" />
+        <xsl:with-param name="replace" select="&quot;&apos;&quot;" />
+        <xsl:with-param name="with" select="&quot;\&amp;&apos;&quot;" />
+      </xsl:call-template>
+    </xsl:variable>
+    <xsl:call-template name="replace-string">
+      <xsl:with-param name="text" select="$rep2" />
+      <xsl:with-param name="replace" select="&quot;.&quot;" />
+      <xsl:with-param name="with" select="&quot;\&amp;.&quot;" />
+    </xsl:call-template>
+  </xsl:template>
+
+  <!-- Template replace-string is borrowed at http://www.dpawson.co.uk/xsl/sect2/replace.html -->
+  <xsl:template name="replace-string">
+    <xsl:param name="text"/>
+    <xsl:param name="replace"/>
+    <xsl:param name="with"/>
+    <xsl:choose>
+      <xsl:when test="contains($text,$replace)">
+        <xsl:value-of select="substring-before($text,$replace)"/>
+        <xsl:value-of select="$with"/>
+        <xsl:call-template name="replace-string">
+          <xsl:with-param name="text" select="substring-after($text,$replace)"/>
+          <xsl:with-param name="replace" select="$replace"/>
+          <xsl:with-param name="with" select="$with"/>
+        </xsl:call-template>
+      </xsl:when>
+      <xsl:otherwise>
+        <xsl:value-of select="$text"/>
+      </xsl:otherwise>
+    </xsl:choose>
+  </xsl:template>
 
   <xsl:template match="d/text()">
     <xsl:value-of select="normalize-space()"/>
-- 
cgit v1.2.3