Ignore:
Timestamp:
Jun 15, 2011, 9:38:34 AM (11 years ago)
Author:
Nicklas Nordborg
Message:

References #1590: Documentation cleanup

Checked and changed the following chapters in Part IV: Developer documentation:

  • Plug-in developer sections 6. Removed documentation about file validators since that is now an extensions.
  • Extensions developer section 8. Added documentation about file set validators.


Made a modification in the docbook templates so that the full package+class name is shown in the link leading to the javadoc.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/lib/docbook/custom-styles/docbook/plain/xsl/customized.chunked.xsl

    r5244 r5654  
    276276  </xsl:template>
    277277 
    278   <xsl:template match="classname">                 
    279     <xsl:call-template name="inline.monoseq"/>   
    280     <xsl:if test = "@docapi != ''">
    281       <xsl:variable name="packagePath">
    282         <xsl:call-template name="replaceCharsInString">
    283           <xsl:with-param name="stringIn" select="string(@docapi)"/>
    284           <xsl:with-param name="charsIn" select="'.'" />
    285           <xsl:with-param name="charsOut" select="'/'" />
    286         </xsl:call-template>
    287         </xsl:variable>
    288        
     278  <xsl:template match="classname">
     279    <xsl:call-template name="inline.monoseq"/>
     280    <xsl:call-template name="linkToJavadoc" />
     281  </xsl:template>
     282 
     283  <xsl:template match="interfacename">
     284    <xsl:call-template name="inline.monoseq"/>
     285    <xsl:call-template name="linkToJavadoc" />
     286  </xsl:template>
     287 
     288  <xsl:template name="linkToJavadoc">
     289    <xsl:if test = "@docapi != ''">
    289290        <xsl:variable name="cleanClassName">
    290291          <xsl:choose>
     
    298299        </xsl:variable>
    299300       
     301        <xsl:variable name="fullClassName">
     302            <xsl:value-of select="concat(@docapi, '.', $cleanClassName)"/>
     303        </xsl:variable>
     304
     305      <xsl:variable name="classPath">
     306        <xsl:call-template name="replaceCharsInString">
     307          <xsl:with-param name="stringIn" select="$fullClassName"/>
     308          <xsl:with-param name="charsIn" select="'.'" />
     309          <xsl:with-param name="charsOut" select="'/'" />
     310        </xsl:call-template>
     311        </xsl:variable>
     312       
    300313        <xsl:variable name="pathtorootdir">
    301314          <xsl:call-template name="pathtorootdir" />
     
    304317      <a>
    305318        <xsl:attribute name="href">
    306           <xsl:value-of select="concat($pathtorootdir, $javadoc.root.path, $packagePath, '/', $cleanClassName, '.html')" />
     319          <xsl:value-of select="concat($pathtorootdir, $javadoc.root.path, $classPath, '.html')" />
    307320        </xsl:attribute>
    308         <xsl:attribute name="title">Javadoc for this class.</xsl:attribute>
     321        <xsl:attribute name="title">
     322          <xsl:value-of select="concat('Javadoc for ', $fullClassName)" />
     323        </xsl:attribute>
    309324        <image>
    310325          <xsl:attribute name="src">
     
    315330        </image>
    316331      </a>
    317     </xsl:if>   
    318   </xsl:template>
    319  
    320   <xsl:template match="interfacename">
    321     <xsl:call-template name="inline.monoseq"/>   
    322     <xsl:if test = "@docapi != ''">
    323       <xsl:variable name="packagePath">
    324         <xsl:call-template name="replaceCharsInString">
    325           <xsl:with-param name="stringIn" select="string(@docapi)"/>
    326           <xsl:with-param name="charsIn" select="'.'" />
    327           <xsl:with-param name="charsOut" select="'/'" />
    328         </xsl:call-template>
    329         </xsl:variable>
    330        
    331         <xsl:variable name="cleanClassName">
    332           <xsl:choose>
    333             <xsl:when test="starts-with(., @docapi)">
    334               <xsl:value-of select="substring-after(., concat(@docapi, '.'))" />
    335             </xsl:when>
    336             <xsl:otherwise>
    337               <xsl:value-of select="." />
    338             </xsl:otherwise>
    339           </xsl:choose>                     
    340         </xsl:variable>
    341            
    342         <xsl:variable name="pathtorootdir">
    343           <xsl:call-template name="pathtorootdir" />
    344         </xsl:variable>
    345       <a>
    346         <xsl:attribute name="href">
    347           <xsl:value-of select="concat($pathtorootdir, $javadoc.root.path, $packagePath, '/', $cleanClassName, '.html')" />
    348         </xsl:attribute>
    349         <xsl:attribute name="title">Javadoc for this interface.</xsl:attribute>
    350        
    351         <image>
    352           <xsl:attribute name="src">
    353           <xsl:value-of select="concat($pathtorootdir, $admon.graphics.path, 'docapi.gif')"/>
    354           </xsl:attribute>
    355           <xsl:attribute name="border">0</xsl:attribute>
    356           <xsl:attribute name="style">padding-left: 4px;</xsl:attribute>
    357         </image>
    358       </a>
    359     </xsl:if>   
     332    </xsl:if>
    360333  </xsl:template>
    361334 
Note: See TracChangeset for help on using the changeset viewer.