| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348 |
- <?xml version="1.0"?>
- <!-- This file is part of the DITA Open Toolkit project hosted on
- Sourceforge.net. See the accompanying license.txt file for
- applicable licenses.-->
- <!-- (c) Copyright IBM Corp. 2004, 2005 All Rights Reserved. -->
- <!--
- Conversion from DITA map or maplist to HTML Help contents file.
- Input = one DITA map file, or a maplist pointing to multiple maps
- Output = one HHC contents file for use with the HTML Help compiler.
-
- Options:
- /OUTEXT = XHTML output extension (default is '.html')
- /WORKDIR = The working directory that contains the document being transformed.
- Needed as a directory prefix for the @href "document()" function calls.
- Default is './'
- -->
- <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
- version="2.0"
- xmlns:dita-ot="http://dita-ot.sourceforge.net/ns/201007/dita-ot"
- exclude-result-prefixes="dita-ot"
- >
- <!-- Include error message template -->
- <xsl:import href="plugin:org.dita.base:xsl/common/output-message.xsl"/>
- <xsl:import href="plugin:org.dita.base:xsl/common/dita-utilities.xsl"/>
- <xsl:import href="plugin:org.dita.base:xsl/common/dita-textonly.xsl"/>
- <!-- Set the prefix for error message numbers -->
- <!-- Deprecated since 2.3 -->
- <xsl:variable name="msgprefix">DOTX</xsl:variable>
- <xsl:variable name="newline"><xsl:text>
- </xsl:text></xsl:variable>
- <!-- *************************** Command line parameters *********************** -->
- <xsl:param name="OUTEXT" select="'.html'"/><!-- "htm" and "html" are valid values -->
- <xsl:param name="WORKDIR" select="'./'"/>
- <!-- *********************************************************************************
- Setup the HTML wrapper for the table of contents
- ********************************************************************************* -->
- <xsl:template match="/">
- <xsl:value-of select="$newline"/>
- <html>
- <xsl:value-of select="$newline"/>
- <head>
- <xsl:value-of select="$newline"/>
- <xsl:comment> Sitemap 1.0 </xsl:comment>
- <xsl:value-of select="$newline"/>
- </head>
- <xsl:value-of select="$newline"/>
- <body>
- <xsl:apply-templates/>
- <xsl:value-of select="$newline"/>
- </body>
- <xsl:value-of select="$newline"/>
- </html>
- </xsl:template>
- <!-- *********************************************************************************
- If processing only a single map, setup the HTML wrapper and output the contents.
- Otherwise, just process the contents.
- ********************************************************************************* -->
- <xsl:template match="/*[contains(@class, ' map/map ')]">
- <xsl:param name="pathFromMaplist"/>
- <xsl:if test=".//*[contains(@class, ' map/topicref ')][not(@toc='no')][not(@processing-role='resource-only')]">
- <xsl:value-of select="$newline"/>
- <UL>
- <xsl:apply-templates select="*[contains(@class, ' map/topicref ')]">
- <xsl:with-param name="pathFromMaplist" select="$pathFromMaplist"/>
- </xsl:apply-templates>
- </UL>
- </xsl:if>
- </xsl:template>
- <!-- *********************************************************************************
- Output each topic as an <OBJECT> in an <LI>. Each object takes 2 parameters:
- - A name must be given. If it is specified on <topicref>, use that, otherwise try
- to open the file and retrieve the title. First look for a navigation title,
- followed by the main topic title. Last, try to use <linktext> specified in the map.
- Failing that, use *** and issue a message.
- - An HREF is optional. If none is specified, this will generate a wrapper (which
- shows up as a book instead of a page in the HTML Help viewer). The HREF is only
- valid for inclusion in the HHC if it is not external, and if it points to a DITA
- or HTML file.
-
- If this topicref has any child topicref's that will be part of the navigation,
- output a <UL> around them and process the contents.
-
- Move the real work to the named template, to easily check @format for
- files that cannot be included.
- ********************************************************************************* -->
- <xsl:template match="*[contains(@class, ' map/topicref ')]">
- <xsl:param name="pathFromMaplist"/>
- <xsl:choose>
- <!-- If TOC is no, go ahead and process children; if TOC is turned back on,
- those topics will rise to this level -->
- <xsl:when test="@toc='no' or @processing-role='resource-only'">
- <xsl:apply-templates select="*[contains(@class, ' map/topicref ')]">
- <xsl:with-param name="pathFromMaplist" select="$pathFromMaplist"/>
- </xsl:apply-templates>
- </xsl:when>
- <!-- If this this a container (no href or href='', no title), just process children -->
- <xsl:when test="(not(@href) or @href='') and not(@navtitle) and not(*[contains(@class, ' map/topicmeta ')]/*[contains(@class, ' topic/navtitle ')]) and
- not(*[contains(@class, ' map/topicmeta ')]/*[contains(@class, ' map/linktext ')])">
- <xsl:apply-templates select="*[contains(@class, ' map/topicref ')][not(contains(@toc,'no'))][not(@processing-role='resource-only')]">
- <xsl:with-param name="pathFromMaplist" select="$pathFromMaplist"/>
- </xsl:apply-templates>
- </xsl:when>
- <!-- If this this a container (no href, with title), output a TOC node with
- the title, and process children -->
- <xsl:when test="not(@href)">
- <xsl:call-template name="output-toc-entry">
- <xsl:with-param name="pathFromMaplist" select="$pathFromMaplist"/>
- </xsl:call-template>
- </xsl:when>
- <xsl:when test="not(@format)">
- <xsl:call-template name="output-toc-entry">
- <xsl:with-param name="pathFromMaplist" select="$pathFromMaplist"/>
- </xsl:call-template>
- </xsl:when>
- <xsl:when test="@format='dita'">
- <xsl:call-template name="output-toc-entry">
- <xsl:with-param name="pathFromMaplist" select="$pathFromMaplist"/>
- </xsl:call-template>
- </xsl:when>
- <xsl:when test="(contains(@format,'htm') or contains(@format,'HTM')) and (@scope='external' or @scope='peer')">
- <!-- The html file is not available, so of course it cannot be included -->
- <xsl:if test="not(contains(@href,'://'))">
- <!-- Seems to be a local file, but marked external or peer, so we can't tell if it's available -->
- <xsl:call-template name="output-message">
- <xsl:with-param name="id" select="'DOTX048I'"/>
- <xsl:with-param name="msgparams">%1=<xsl:value-of select="@href"/></xsl:with-param>
- </xsl:call-template>
- </xsl:if>
- <xsl:call-template name="output-toc-entry">
- <xsl:with-param name="pathFromMaplist" select="$pathFromMaplist"/>
- </xsl:call-template>
- </xsl:when>
- <xsl:when test="contains(@format,'htm') or contains(@format,'HTM')">
- <xsl:call-template name="output-toc-entry">
- <xsl:with-param name="pathFromMaplist" select="$pathFromMaplist"/>
- </xsl:call-template>
- </xsl:when>
- <xsl:otherwise>
- <!-- @format is not DITA and not HTML, so the target will be ignored for HTML Help -->
- <xsl:call-template name="output-message">
- <xsl:with-param name="id" select="'DOTX007I'"/>
- <xsl:with-param name="msgparams">%1=<xsl:value-of select="@href"/></xsl:with-param>
- </xsl:call-template>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:template>
-
- <xsl:template name="output-toc-entry">
- <xsl:param name="pathFromMaplist"/>
- <xsl:variable name="WORKDIR">
- <xsl:apply-templates select="/processing-instruction('workdir-uri')[1]" mode="get-work-dir"/>
- </xsl:variable>
- <xsl:value-of select="$newline"/>
- <!-- if current node is not topicgroup and not empty or current node
- is empty but there is a valid child, we will generate
- the entry in toc -->
- <xsl:if test="not(contains(@class,' mapgroup-d/topicgroup '))and (@href and not(@href='') or .//*[@href and not(@href='')])">
- <LI> <OBJECT type="text/sitemap">
- <xsl:element name="param">
- <xsl:attribute name="name">Name</xsl:attribute>
- <xsl:attribute name="value">
- <xsl:choose>
-
- <!-- If navtitle is specified, use it -->
- <xsl:when test="*[contains(@class,'- map/topicmeta ')]/*[contains(@class, '- topic/navtitle ')]">
- <xsl:apply-templates select="*[contains(@class,'- map/topicmeta ')]/*[contains(@class, '- topic/navtitle ')]" mode="dita-ot:text-only"/>
- </xsl:when>
- <xsl:when test="not(*[contains(@class,'- map/topicmeta ')]/*[contains(@class, '- topic/navtitle ')]) and @navtitle"><xsl:value-of select="@navtitle"/></xsl:when>
- <!-- If this references a DITA file (has @href, not "local" or "external"),
- try to open the file and get the title -->
-
- <xsl:when test="@href and not(@href='') and
- not ((ancestor-or-self::*/@scope)[last()]='external') and
- not ((ancestor-or-self::*/@scope)[last()]='peer') and
- not ((ancestor-or-self::*/@type)[last()]='external') and
- not ((ancestor-or-self::*/@type)[last()]='local')">
- <!-- Need to worry about targeting a nested topic? Not for now. -->
- <!--<xsl:variable name="FileWithPath"><xsl:value-of select="$WORKDIR"/><xsl:choose>-->
- <xsl:variable name="FileWithPath"><xsl:choose>
- <xsl:when test="@copy-to"><xsl:value-of select="$WORKDIR"/><xsl:value-of select="@copy-to"/></xsl:when>
- <xsl:when test="contains(@href,'#')"><xsl:value-of select="$WORKDIR"/><xsl:value-of select="substring-before(@href,'#')"/></xsl:when>
- <xsl:otherwise><xsl:value-of select="$WORKDIR"/><xsl:value-of select="@href"/></xsl:otherwise></xsl:choose></xsl:variable>
- <xsl:variable name="TargetFile" select="document($FileWithPath,/)"/>
-
- <xsl:choose>
- <xsl:when test="not($TargetFile)"> <!-- DITA file does not exist -->
- <xsl:choose>
- <xsl:when test="*[contains(@class, ' map/topicmeta ')]/*[contains(@class, ' map/linktext ')]"> <!-- attempt to recover by using linktext -->
- <xsl:apply-templates select="*[contains(@class, ' map/topicmeta ')]/*[contains(@class, ' map/linktext ')]" mode="dita-ot:text-only"/>
- </xsl:when>
- <xsl:otherwise>
- <xsl:call-template name="output-message">
- <xsl:with-param name="id" select="'DOTX008W'"/>
- <xsl:with-param name="msgparams">%1=<xsl:value-of select="@href"/></xsl:with-param>
- </xsl:call-template>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:when>
- <!-- First choice for navtitle: topic/titlealts/navtitle -->
- <xsl:when test="$TargetFile/*[contains(@class,' topic/topic ')]/*[contains(@class,' topic/titlealts ')]/*[contains(@class,' topic/navtitle ')]">
- <xsl:apply-templates select="$TargetFile/*[contains(@class,' topic/topic ')]/*[contains(@class,' topic/titlealts ')]/*[contains(@class,' topic/navtitle ')]" mode="dita-ot:text-only"/>
- </xsl:when>
- <!-- Second choice for navtitle: topic/title -->
- <xsl:when test="$TargetFile/*[contains(@class,' topic/topic ')]/*[contains(@class,' topic/title ')]">
- <xsl:apply-templates select="$TargetFile/*[contains(@class,' topic/topic ')]/*[contains(@class,' topic/title ')]" mode="dita-ot:text-only"/>
- </xsl:when>
- <!-- This might be a combo article; modify the same queries: dita/topic/titlealts/navtitle -->
- <xsl:when test="$TargetFile/dita/*[contains(@class,' topic/topic ')]/*[contains(@class,' topic/titlealts ')]/*[contains(@class,' topic/navtitle ')]">
- <xsl:apply-templates select="$TargetFile/dita/*[contains(@class,' topic/topic ')]/*[contains(@class,' topic/titlealts ')]/*[contains(@class,' topic/navtitle ')]" mode="dita-ot:text-only"/>
- </xsl:when>
- <!-- Second choice: dita/topic/title -->
- <xsl:when test="$TargetFile/dita/*[contains(@class,' topic/topic ')]/*[contains(@class,' topic/title ')]">
- <xsl:apply-templates select="$TargetFile/dita/*[contains(@class,' topic/topic ')]/*[contains(@class,' topic/title ')]" mode="dita-ot:text-only"/>
- </xsl:when>
- <!-- Last choice: use the linktext specified within the topicref -->
- <xsl:when test="*[contains(@class, ' map/topicmeta ')]/*[contains(@class, ' map/linktext ')]">
- <xsl:apply-templates select="*[contains(@class, ' map/topicmeta ')]/*[contains(@class, ' map/linktext ')]" mode="dita-ot:text-only"/>
- </xsl:when>
- <xsl:otherwise>
- <xsl:call-template name="output-message">
- <xsl:with-param name="id" select="'DOTX009W'"/>
- <xsl:with-param name="msgparams">%1=<xsl:value-of select="@TargetFile"/>;%2=***</xsl:with-param>
- </xsl:call-template>
- <xsl:text>***</xsl:text>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:when>
- <!-- If there is no title and none can be retrieved, check for <linktext> -->
- <xsl:when test="*[contains(@class, ' map/topicmeta ')]/*[contains(@class, ' map/linktext ')]">
- <xsl:apply-templates select="*[contains(@class, ' map/topicmeta ')]/*[contains(@class, ' map/linktext ')]" mode="dita-ot:text-only"/>
- </xsl:when>
- <!-- No local title, and not targeting a DITA file. Could be just a container setting
- metadata, or a file reference with no title. Issue message for the second case. -->
- <xsl:otherwise>
- <xsl:if test="@href and not(@href='')">
- <xsl:call-template name="output-message">
- <xsl:with-param name="id" select="'DOTX009W'"/>
- <xsl:with-param name="msgparams">%1=<xsl:value-of select="@href"/>;%2=<xsl:value-of select="@href"/></xsl:with-param>
- </xsl:call-template>
- <xsl:value-of select="@href"/>
- </xsl:if>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:attribute> <!-- End of @value (the title) -->
- </xsl:element> <!-- End of <param> element -->
- <!-- If there is a reference to a DITA or HTML file, and it is not external:
- allow non-dita, external values in navigation. -->
- <xsl:if test="@href">
- <xsl:variable name="topicID">
- <xsl:choose>
- <xsl:when test="contains(@href, '#')">
- <xsl:value-of select="concat('#', substring-after(@href, '#'))"/>
- </xsl:when>
- <xsl:otherwise>
- <xsl:value-of select="''"/>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:variable>
- <xsl:element name="param">
- <xsl:attribute name="name">Local</xsl:attribute>
- <xsl:choose> <!-- What if targeting a nested topic? Need to keep the ID? -->
- <xsl:when test="@copy-to and (not(@format) or @format = 'dita')">
- <xsl:attribute name="value">
- <xsl:value-of select="$pathFromMaplist"/>
- <xsl:call-template name="replace-extension">
- <xsl:with-param name="filename" select="@copy-to"/>
- <xsl:with-param name="extension" select="$OUTEXT"/>
- <xsl:with-param name="ignore-fragment" select="true()"/>
- </xsl:call-template>
- <xsl:value-of select="$topicID"/>
- </xsl:attribute>
- </xsl:when>
- <xsl:when test="@href and (not(@format) or @format = 'dita')">
- <xsl:attribute name="value">
- <xsl:value-of select="$pathFromMaplist"/>
- <xsl:call-template name="replace-extension">
- <xsl:with-param name="filename" select="@href"/>
- <xsl:with-param name="extension" select="$OUTEXT"/>
- </xsl:call-template>
- </xsl:attribute>
- </xsl:when>
- <xsl:when test="contains(@href,'.htm') and @scope!='external'">
- <xsl:attribute name="value"><xsl:value-of select="$pathFromMaplist"/><xsl:value-of select="@href"/></xsl:attribute>
- </xsl:when>
- <xsl:otherwise> <!-- If non-DITA, keep the href as-is -->
- <xsl:attribute name="value"><xsl:value-of select="@href"/></xsl:attribute>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:element>
- </xsl:if>
- </OBJECT>
- <!-- If there are any children that should be in the TOC, process them -->
- <xsl:if test="descendant::*[contains(@class, ' map/topicref ')][not(contains(@toc,'no'))][not(@processing-role='resource-only')]">
- <UL>
- <xsl:apply-templates select="*[contains(@class, ' map/topicref ')]">
- <xsl:with-param name="pathFromMaplist" select="$pathFromMaplist"/>
- </xsl:apply-templates>
- </UL>
- </xsl:if>
- <xsl:value-of select="$newline"/>
- </LI>
- </xsl:if>
- </xsl:template>
- <!-- These are here just to prevent accidental fallthrough -->
- <xsl:template match="*[contains(@class, ' map/navref ')]"/>
- <xsl:template match="*[contains(@class, ' map/anchor ')]"/>
- <xsl:template match="*[contains(@class, ' map/reltable ')]"/>
- <xsl:template match="*[contains(@class, ' map/topicmeta ')]"/>
- <xsl:template match="*">
- <xsl:apply-templates/>
- </xsl:template>
- <!-- Template to get the relative path to a map -->
- <xsl:template name="getRelativePath">
- <xsl:param name="remainingPath" select="@file"/>
- <xsl:choose>
- <xsl:when test="contains($remainingPath,'/')">
- <xsl:value-of select="substring-before($remainingPath,'/')"/><xsl:text>/</xsl:text>
- <xsl:call-template name="getRelativePath">
- <xsl:with-param name="remainingPath" select="substring-after($remainingPath,'/')"/>
- </xsl:call-template>
- </xsl:when>
- <xsl:when test="contains($remainingPath,'\')">
- <xsl:value-of select="substring-before($remainingPath,'\')"/><xsl:text>/</xsl:text>
- <xsl:call-template name="getRelativePath">
- <xsl:with-param name="remainingPath" select="substring-after($remainingPath,'\')"/>
- </xsl:call-template>
- </xsl:when>
- </xsl:choose>
- </xsl:template>
- </xsl:stylesheet>
|