diff options
author | Lars G Thorsen <[email protected]> | 2010-01-29 13:15:42 +0000 |
---|---|---|
committer | Erlang/OTP <[email protected]> | 2010-01-29 13:15:42 +0000 |
commit | cbc470bc904693618cc33ac16cc577401906b2f0 (patch) | |
tree | debd314dded7cb93145d929f07b36acea16b3d75 /lib/erl_docgen | |
parent | fabf2e7b08fedd7e8e8cfcebd0cca059eee92658 (diff) | |
download | otp-cbc470bc904693618cc33ac16cc577401906b2f0.tar.gz otp-cbc470bc904693618cc33ac16cc577401906b2f0.tar.bz2 otp-cbc470bc904693618cc33ac16cc577401906b2f0.zip |
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)
- The legal notice is taken from the xml book file so OTP's build
process can be used for non OTP applications.
Diffstat (limited to 'lib/erl_docgen')
-rw-r--r-- | lib/erl_docgen/priv/xsl/db_html.xsl | 2 | ||||
-rw-r--r-- | lib/erl_docgen/priv/xsl/db_man.xsl | 122 |
2 files changed, 63 insertions, 61 deletions
diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl index c2b58e48ec..5614b02bb7 100644 --- a/lib/erl_docgen/priv/xsl/db_html.xsl +++ b/lib/erl_docgen/priv/xsl/db_html.xsl @@ -702,7 +702,7 @@ <!-- Menu.ref --> <xsl:template name="menu.ref"> - <xsl:param name="$curModule"/> + <xsl:param name="curModule"/> <div id="leftnav"> <div class="innertube"> diff --git a/lib/erl_docgen/priv/xsl/db_man.xsl b/lib/erl_docgen/priv/xsl/db_man.xsl index 300d1ed362..a9a2781a8a 100644 --- a/lib/erl_docgen/priv/xsl/db_man.xsl +++ b/lib/erl_docgen/priv/xsl/db_man.xsl @@ -59,10 +59,7 @@ <xsl:template match="list/item"> <xsl:text> .TP 2 </xsl:text> <xsl:text>* </xsl:text> - <xsl:variable name="content"> - <xsl:apply-templates/> - </xsl:variable> - <xsl:value-of select="normalize-space($content)"/> + <xsl:apply-templates/> <xsl:text> .LP </xsl:text> </xsl:template> @@ -78,37 +75,27 @@ <xsl:apply-templates/><xsl:text>: </xsl:text> </xsl:template> + <xsl:template match="taglist/item"> + <xsl:apply-templates/> + </xsl:template> + <xsl:template match="item/p"> <xsl:variable name="content"> <xsl:apply-templates/> </xsl:variable> <xsl:choose> <xsl:when test="position() = 1"> - <xsl:value-of select="normalize-space($content)"/> + <xsl:value-of select="$content"/> </xsl:when> <xsl:otherwise> <xsl:text> .RS 2</xsl:text> <xsl:text> .LP .LP </xsl:text> - <xsl:value-of select="normalize-space($content)"/> + <xsl:value-of select="$content"/> <xsl:text> .RE</xsl:text> </xsl:otherwise> </xsl:choose> </xsl:template> - <xsl:template match="taglist/item"> - <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> .SS Note:</xsl:text> @@ -125,11 +112,8 @@ <!-- Paragraph --> <xsl:template match="p"> - <xsl:variable name="content"> - <xsl:apply-templates/> - </xsl:variable> <xsl:text> .LP </xsl:text> - <xsl:value-of select="normalize-space($content)"/> + <xsl:apply-templates/> </xsl:template> <!-- Inline elements --> @@ -190,42 +174,72 @@ <!-- 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" </xsl:text> - <xsl:text>.SH NAME </xsl:text> - <xsl:value-of select="module"/><xsl:text> \- </xsl:text><xsl:value-of select="modulesummary"/><xsl:text> </xsl:text> - <xsl:apply-templates/> + <xsl:variable name="companyname"> + <xsl:choose> + <xsl:when test="$company = ''"><xsl:value-of select="header/holder"/></xsl:when> + <xsl:otherwise><xsl:value-of select="$company"/></xsl:otherwise> + </xsl:choose> + </xsl:variable> + <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>" "</xsl:text><xsl:value-of select="$companyname"/><xsl:text>" "Erlang Module Definition" </xsl:text> + <xsl:text>.SH NAME </xsl:text> + <xsl:value-of select="module"/><xsl:text> \- </xsl:text><xsl:value-of select="modulesummary"/><xsl:text> </xsl:text> + <xsl:apply-templates/> </xsl:template> <!-- Comref --> <xsl:template match="/comref"> - <xsl:text>.TH </xsl:text><xsl:value-of select="com"/><xsl:text> 1 "</xsl:text><xsl:value-of select="$appname"/><xsl:text> </xsl:text><xsl:value-of select="$appver"/><xsl:text>" "Ericsson AB" "User Commands" </xsl:text> - <xsl:text>.SH NAME </xsl:text> - <xsl:value-of select="com"/><xsl:text> \- </xsl:text><xsl:value-of select="comsummary"/><xsl:text> </xsl:text> - <xsl:apply-templates/> + <xsl:variable name="companyname"> + <xsl:choose> + <xsl:when test="$company = ''"><xsl:value-of select="header/holder"/></xsl:when> + <xsl:otherwise><xsl:value-of select="$company"/></xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:text>.TH </xsl:text><xsl:value-of select="com"/><xsl:text> 1 "</xsl:text><xsl:value-of select="$appname"/><xsl:text> </xsl:text><xsl:value-of select="$appver"/><xsl:text>" "</xsl:text><xsl:value-of select="$companyname"/><xsl:text>" "User Commands" </xsl:text> + <xsl:text>.SH NAME </xsl:text> + <xsl:value-of select="com"/><xsl:text> \- </xsl:text><xsl:value-of select="comsummary"/><xsl:text> </xsl:text> + <xsl:apply-templates/> </xsl:template> <!-- Cref --> <xsl:template match="/cref"> - <xsl:text>.TH </xsl:text><xsl:value-of select="lib"/><xsl:text> 3 "</xsl:text><xsl:value-of select="$appname"/><xsl:text> </xsl:text><xsl:value-of select="$appver"/><xsl:text>" "Ericsson AB" "C Library Functions" </xsl:text> - <xsl:text>.SH NAME </xsl:text> - <xsl:value-of select="lib"/><xsl:text> \- </xsl:text><xsl:value-of select="libsummary"/><xsl:text> </xsl:text> - <xsl:apply-templates/> + <xsl:variable name="companyname"> + <xsl:choose> + <xsl:when test="$company = ''"><xsl:value-of select="header/holder"/></xsl:when> + <xsl:otherwise><xsl:value-of select="$company"/></xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:text>.TH </xsl:text><xsl:value-of select="lib"/><xsl:text> 3 "</xsl:text><xsl:value-of select="$appname"/><xsl:text> </xsl:text><xsl:value-of select="$appver"/><xsl:text>" "</xsl:text><xsl:value-of select="$companyname"/><xsl:text>" "C Library Functions" </xsl:text> + <xsl:text>.SH NAME </xsl:text> + <xsl:value-of select="lib"/><xsl:text> \- </xsl:text><xsl:value-of select="libsummary"/><xsl:text> </xsl:text> + <xsl:apply-templates/> </xsl:template> <!-- Fileref --> <xsl:template match="/fileref"> - <xsl:text>.TH </xsl:text><xsl:value-of select="file"/><xsl:text> 4 "</xsl:text><xsl:value-of select="$appname"/><xsl:text> </xsl:text><xsl:value-of select="$appver"/><xsl:text>" "Ericsson AB" "Files" </xsl:text> - <xsl:text>.SH NAME </xsl:text> - <xsl:value-of select="file"/><xsl:text> \- </xsl:text><xsl:value-of select="filesummary"/><xsl:text> </xsl:text> - <xsl:apply-templates/> + <xsl:variable name="companyname"> + <xsl:choose> + <xsl:when test="$company = ''"><xsl:value-of select="header/holder"/></xsl:when> + <xsl:otherwise><xsl:value-of select="$company"/></xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:text>.TH </xsl:text><xsl:value-of select="file"/><xsl:text> 5 "</xsl:text><xsl:value-of select="$appname"/><xsl:text> </xsl:text><xsl:value-of select="$appver"/><xsl:text>" "</xsl:text><xsl:value-of select="$companyname"/><xsl:text>" "Files" </xsl:text> + <xsl:text>.SH NAME </xsl:text> + <xsl:value-of select="file"/><xsl:text> \- </xsl:text><xsl:value-of select="filesummary"/><xsl:text> </xsl:text> + <xsl:apply-templates/> </xsl:template> <!-- Appref --> <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" </xsl:text> - <xsl:text>.SH NAME </xsl:text> - <xsl:value-of select="app"/><xsl:text> \- </xsl:text><xsl:value-of select="appsummary"/><xsl:text> </xsl:text> - <xsl:apply-templates/> + <xsl:variable name="companyname"> + <xsl:choose> + <xsl:when test="$company = ''"><xsl:value-of select="header/holder"/></xsl:when> + <xsl:otherwise><xsl:value-of select="$company"/></xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:text>.TH </xsl:text><xsl:value-of select="app"/><xsl:text> 7 "</xsl:text><xsl:value-of select="$appname"/><xsl:text> </xsl:text><xsl:value-of select="$appver"/><xsl:text>" "</xsl:text><xsl:value-of select="$companyname"/><xsl:text>" "Erlang Application Definition" </xsl:text> + <xsl:text>.SH NAME </xsl:text> + <xsl:value-of select="app"/><xsl:text> \- </xsl:text><xsl:value-of select="appsummary"/><xsl:text> </xsl:text> + <xsl:apply-templates/> </xsl:template> <!-- Module|Com|Lib|File|App--> @@ -318,20 +332,12 @@ <!-- 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="startstring"> + <xsl:value-of select="normalize-space()"/><xsl:text> </xsl:text> + </xsl:variable> <xsl:variable name="rep1"> <xsl:call-template name="replace-string"> - <xsl:with-param name="text" select="." /> + <xsl:with-param name="text" select="$startstring" /> <xsl:with-param name="replace" select=""\"" /> <xsl:with-param name="with" select=""\\"" /> </xsl:call-template> @@ -371,8 +377,4 @@ </xsl:choose> </xsl:template> - <xsl:template match="d/text()"> - <xsl:value-of select="normalize-space()"/> - </xsl:template> - </xsl:stylesheet> |