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.

1 files changed, 79 insertions, 20 deletions

diff --git a/lib/erl_docgen/priv/xsl/db_pdf.xsl b/lib/erl_docgen/priv/xsl/db_pdf.xsl
index bef86277ea..e12b4d219a 100644
--- a/lib/erl_docgen/priv/xsl/db_pdf.xsl
+++ b/lib/erl_docgen/priv/xsl/db_pdf.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%
      
      -->
@@ -229,7 +229,9 @@
           <xsl:value-of select="$companyname"/>
         </fo:block>
         <fo:block xsl:use-attribute-sets="cover.inner.copyrightnotice">
-  The contents of this file are subject to the Erlang Public License,
+          <xsl:value-of select="/book/header/legalnotice"/>
+
+        <!--   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
@@ -241,6 +243,7 @@
   under the License.
 
   The Initial Developer of the Original Code is 
+-->
           <xsl:value-of select="$companyname"/>.
         </fo:block>
         <fo:block xsl:use-attribute-sets="cover.inner.date">
@@ -382,7 +385,9 @@
       <xsl:choose>
         <xsl:when test="ancestor::cref">
           <fo:bookmark internal-destination="{generate-id(nametext)}" starting-state="hide">
-            <xsl:variable name="fname"><xsl:value-of select="substring-before(nametext, '(')"/></xsl:variable> 
+            <xsl:variable name="fname">
+              <xsl:value-of select="substring-before(nametext, '(')"/>
+            </xsl:variable> 
             <fo:bookmark-title>
               <xsl:choose>
                 <xsl:when test="string-length($fname) > 0">
@@ -422,8 +427,26 @@
                 <xsl:with-param name="no-of-pars" select="0"/> 
               </xsl:call-template>
             </xsl:variable> 
+
+            <xsl:variable name="fname">
+              <xsl:variable name="fname1">
+                <xsl:value-of select="substring-before(., '(')"/>
+              </xsl:variable>
+              <xsl:variable name="fname2">
+                <xsl:value-of select="substring-after($fname1, 'erlang:')"/>
+              </xsl:variable>
+              <xsl:choose>
+                <xsl:when test="string-length($fname2) > 0">   
+                  <xsl:value-of select="$fname2"/>
+                </xsl:when>
+                <xsl:otherwise>
+                  <xsl:value-of select="$fname1"/>
+                </xsl:otherwise>
+              </xsl:choose>
+            </xsl:variable>
+
             <fo:bookmark-title>
-              <xsl:value-of select="substring-before(., '(')"/>/<xsl:value-of select="$arity"/>
+              <xsl:value-of select="$fname"/>/<xsl:value-of select="$arity"/>
             </fo:bookmark-title>
           </fo:bookmark>
         </xsl:when>
@@ -668,12 +691,12 @@
       <xsl:number level="any" from="part" count="code"/>
     </xsl:variable>
 
-    <fo:block xsl:use-attribute-sets="code" margin-left="1.5em">
+    <fo:block xsl:use-attribute-sets="code">
       <xsl:apply-templates select="text()"/> 
     </fo:block>
 
     <xsl:if test="@caption">
-      <fo:block xsl:use-attribute-sets="caption" margin-left="1.5em">
+      <fo:block xsl:use-attribute-sets="caption">
           Code listing <xsl:value-of select="$partnum"/>.<xsl:value-of select="$codenum"/>:&#160;
           <xsl:value-of select="@caption"/>
       </fo:block>
@@ -687,12 +710,12 @@
       <xsl:number level="any" from="part" count="code"/>
     </xsl:variable>
 
-    <fo:block xsl:use-attribute-sets="code" margin-left="1.5em">
+    <fo:block xsl:use-attribute-sets="code">
       <xsl:apply-templates/> 
     </fo:block>
 
     <xsl:if test="@caption">
-      <fo:block xsl:use-attribute-sets="caption" margin-left="1.5em">
+      <fo:block xsl:use-attribute-sets="caption">
           Code listing <xsl:value-of select="$partnum"/>.<xsl:value-of select="$codenum"/>:&#160;
           <xsl:value-of select="@caption"/>
       </fo:block>
@@ -862,7 +885,7 @@
 
   <!-- Funcs -->
   <xsl:template match="funcs">
-
+    <xsl:param name="partnum"/>
     <fo:block  xsl:use-attribute-sets="h3">
       <xsl:text>Exports</xsl:text>
     </fo:block>
@@ -958,6 +981,7 @@
 
   <!-- Desc -->
   <xsl:template match="desc">
+    <xsl:param name="partnum"/>
 
     <xsl:apply-templates>
       <xsl:with-param name="partnum" select="$partnum"/>
@@ -1103,27 +1127,62 @@
 
   <xsl:template name="remove-paren">
     <xsl:param name="string"/>
+
+    <xsl:variable name="str1">
+      <xsl:call-template name="remove-paren-1">
+        <xsl:with-param name="string" select="$string"/>
+        <xsl:with-param name="start">(</xsl:with-param> 
+        <xsl:with-param name="end">)</xsl:with-param> 
+      </xsl:call-template>    
+    </xsl:variable>
+
+    <xsl:variable name="str2">
+      <xsl:call-template name="remove-paren-1">
+        <xsl:with-param name="string" select="$str1"/>
+        <xsl:with-param name="start">{</xsl:with-param>
+        <xsl:with-param name="end">}</xsl:with-param>
+      </xsl:call-template>    
+    </xsl:variable>
+
+    <xsl:variable name="str3">
+      <xsl:call-template name="remove-paren-1">
+        <xsl:with-param name="string" select="$str2"/>
+        <xsl:with-param name="start">[</xsl:with-param>
+        <xsl:with-param name="end">]</xsl:with-param>
+      </xsl:call-template>    
+    </xsl:variable>
+
+    <xsl:value-of select="$str3"/>
+
+  </xsl:template>
+
+
+  <xsl:template name="remove-paren-1">
+    <xsl:param name="string"/>
+    <xsl:param name="start"/>
+    <xsl:param name="end"/>
    
-    <xsl:variable name="bstring">
-      <xsl:value-of select="substring-before($string, '(')"/>
+    <xsl:variable name="tmp1">
+      <xsl:value-of select="substring-before($string, $start)"/>
     </xsl:variable>
 
     <xsl:choose>
-      <xsl:when test="string-length($bstring) > 0">
-        <xsl:variable name="astring">
-          <xsl:value-of select="substring-after($string, ')')"/>
+      <xsl:when test="string-length($tmp1) > 0 or starts-with($string, $start)">
+        <xsl:variable name="tmp2">
+          <xsl:value-of select="substring-after($string, $end)"/>
         </xsl:variable>
         <xsl:variable name="retstring">
           <xsl:call-template name="remove-paren">
-            <xsl:with-param name="string" select="$astring"/>
+            <xsl:with-param name="string" select="$tmp2"/>
           </xsl:call-template>        
         </xsl:variable>
-        <xsl:value-of select="concat($bstring, $retstring)"/>
+        <xsl:value-of select="concat(concat($tmp1, 'x'), $retstring)"/>
       </xsl:when>
       <xsl:otherwise>
         <xsl:value-of select="$string"/>
       </xsl:otherwise>
     </xsl:choose>
+
   </xsl:template>
 
 </xsl:stylesheet>