X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/1840e1bbae56555bbc271056b47bbd602a956a83..773b6ae979ebce76e4857837fd86b42b5e464dd6:/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt

diff --git a/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt b/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt
index 4247b475d..d543bc0ae 100644
--- a/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt
+++ b/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt
@@ -47,6 +47,7 @@
 		<xsl:variable name="book.title">
 			<xsl:call-template name="generate.book.title"/>
 		</xsl:variable>
+
 		<xsl:variable name="book.id">
 			<xsl:call-template name="generate.book.id">
 				<xsl:with-param name="book.title" select="$book.title"/>
@@ -59,55 +60,44 @@
 			</title>
 
 			<!-- Add index chapter -->
-			<xsl:call-template name="generate.top.level.page">
-				<xsl:with-param name="top.level.page" select="compounddef[@kind = 'page' and contains(@id, 'index')]"/>
-			</xsl:call-template>
+			<xsl:apply-templates select="compounddef[@kind = 'page' and @id = 'indexpage']">
+				<xsl:with-param name="element.type" select="'chapter'"/>
+				<xsl:with-param name="page.title"   select="'Library Information'"/>
+			</xsl:apply-templates>
 
 			<!-- Add free-floating chapters -->
-			<xsl:for-each select="compounddef[@kind = 'page' and not(contains(@id, 'index'))]">
-				<xsl:if test="not(//innerpage[@refid = current()/@id])">
-					<xsl:call-template name="generate.top.level.page">
-						<xsl:with-param name="top.level.page" select="current()"/>
-					</xsl:call-template>
-				</xsl:if>
-			</xsl:for-each>
+			<xsl:apply-templates select="compounddef[@kind = 'page' and not(@id = 'indexpage') and not(//innerpage/@refid = @id)]">
+				<xsl:with-param name="element.type" select="'chapter'"/>
+			</xsl:apply-templates>
 
-			<!-- Add Module chapter -->
+			<!-- Add Modules chapter -->
 			<chapter>
 				<title>Modules</title>
-				<xsl:for-each select="compounddef[@kind = 'group']">
-					<xsl:if test="not(//innergroup[@refid = current()/@id])">
-						<xsl:apply-templates select="current()"/>
-					</xsl:if>
-				</xsl:for-each>
+				<xsl:apply-templates select="compounddef[@kind = 'group' and not(//innergroup/@refid = @id)]"/>
 			</chapter>
 		</book>
 	</xsl:template>
 
-	<xsl:template name="generate.top.level.page">
-		<xsl:param name="top.level.page"/>
-
-		<chapter id="{$top.level.page/@id}">
-			<title>
-				<xsl:value-of select="$top.level.page/title"/>
-			</title>
+	<xsl:template match="compounddef[@kind = 'page']">
+		<xsl:param name="element.type" select="'section'"/>
+		<xsl:param name="page.title"   select="title"/>
 
-			<xsl:apply-templates select="$top.level.page/detaileddescription"/>
+		<xsl:element name="{$element.type}">
+			<xsl:attribute name="id">
+				<xsl:value-of select="@id"/>
+			</xsl:attribute>
 
-			<xsl:for-each select="$top.level.page/innerpage">
-				<xsl:apply-templates select="ancestor::*/compounddef[@kind = 'page' and @id = current()/@refid]"/>
-			</xsl:for-each>
-		</chapter>
-	</xsl:template>
+			<xsl:variable name="name">
+				<xsl:text>LUFA.</xsl:text>
+				<xsl:value-of select="translate(compoundname, '_', '/')"/>
+			</xsl:variable>
 
-	<xsl:template match="compounddef">
-		<!-- Discard compounddef elements unless a later template matches -->
-	</xsl:template>
+			<xsl:call-template name="generate.index.id">
+				<xsl:with-param name="name" select="$name"/>
+			</xsl:call-template>
 
-	<xsl:template match="compounddef[@kind = 'page']">
-		<section id="{@id}">
 			<title>
-				<xsl:value-of select="title"/>
+				<xsl:value-of select="$page.title"/>
 			</title>
 
 			<xsl:apply-templates select="detaileddescription"/>
@@ -115,7 +105,7 @@
 			<xsl:for-each select="innerpage">
 				<xsl:apply-templates select="ancestor::*/compounddef[@kind = 'page' and @id = current()/@refid]"/>
 			</xsl:for-each>
-		</section>
+		</xsl:element>
 	</xsl:template>
 
 	<xsl:template match="compounddef[@kind = 'group']">
@@ -124,56 +114,18 @@
 				<xsl:value-of select="title"/>
 			</title>
 
-			<xsl:variable name="book.title">
-				<xsl:call-template name="generate.book.title"/>
-			</xsl:variable>
-
 			<xsl:variable name="name">
-				<xsl:choose>
-					<xsl:when test="contains(compoundname, '_')">
-						<xsl:value-of select="translate(compoundname, '_', '/')"/>
-						<xsl:text>.h</xsl:text>
-					</xsl:when>
-					<xsl:otherwise>
-						<xsl:value-of select="compoundname"/>
-						<xsl:text>.h</xsl:text>
-					</xsl:otherwise>
-				</xsl:choose>
+				<xsl:text>LUFA.</xsl:text>
+				<xsl:value-of select="translate(compoundname, '_', '/')"/>
 			</xsl:variable>
 
-			<xsl:variable name="name.escaped">
-				<xsl:choose>
-					<xsl:when test="contains(compoundname, '_')">
-						<xsl:value-of select="translate(compoundname, '_', '.')"/>
-						<xsl:text>.h</xsl:text>
-					</xsl:when>
-					<xsl:otherwise>
-						<xsl:value-of select="compoundname"/>
-						<xsl:text>.h</xsl:text>
-					</xsl:otherwise>
-				</xsl:choose>
-			</xsl:variable>
-
-			<indexterm id="{$keyword.namespace}.{$name.escaped}">
-				<primary>Header</primary>
-				<secondary>
-					<xsl:value-of select="$name"/>
-				</secondary>
-			</indexterm>
-
 			<xsl:call-template name="generate.index.id">
 				<xsl:with-param name="name" select="$name"/>
 			</xsl:call-template>
 
-			<indexterm>
-				<primary>
-					<xsl:value-of select="$name"/>
-				</primary>
-			</indexterm>
-
-			<xsl:apply-templates select="detaileddescription" />
+			<xsl:apply-templates select="detaileddescription"/>
 
-			<xsl:apply-templates select="sectiondef" />
+			<xsl:apply-templates select="sectiondef"/>
 
 			<xsl:for-each select="innerclass">
 				<xsl:apply-templates select="ancestor::*/compounddef[@id = current()/@refid]"/>
@@ -194,10 +146,12 @@
 					<xsl:when test="@kind = 'struct'">
 						<xsl:text>Struct </xsl:text>
 					</xsl:when>
+
 					<xsl:when test="@kind = 'union'">
 						<xsl:text>Union </xsl:text>
 					</xsl:when>
 				</xsl:choose>
+
 				<xsl:value-of select="$name"/>
 			</title>
 
@@ -207,7 +161,7 @@
 
 			<xsl:apply-templates select="detaileddescription"/>
 
-			<xsl:for-each select="sectiondef[@kind='public-attrib']">
+			<xsl:for-each select="sectiondef[@kind = 'public-attrib']">
 				<table tabstyle="striped">
 					<title>
 						<xsl:value-of select="$name"/>
@@ -227,14 +181,23 @@
 							<xsl:for-each select="memberdef">
 								<row id="{@id}" xreflabel="{name}">
 									<entry>
-										<xsl:apply-templates select="type"/>
+										<xsl:value-of select="type"/>
 									</entry>
 									<entry>
 										<xsl:value-of select="name"/>
 										<xsl:if test="starts-with(argsstring, '[')">
 											<xsl:text>[]</xsl:text>
 										</xsl:if>
-										<indexterm id="{$keyword.namespace}.{$name}.{name}"/>
+
+										<xsl:variable name="struct.element.name">
+											<xsl:value-of select="$name"/>
+											<xsl:text>.</xsl:text>
+											<xsl:value-of select="name"/>
+										</xsl:variable>
+
+										<xsl:call-template name="generate.index.id">
+											<xsl:with-param name="name" select="$struct.element.name"/>
+										</xsl:call-template>
 									</entry>
 									<entry>
 										<xsl:apply-templates select="detaileddescription"/>
@@ -249,17 +212,15 @@
 	</xsl:template>
 
 	<xsl:template match="memberdef[@kind = 'function']">
-		<xsl:variable name="name" select="name"/>
-
 		<section id="{@id}" xreflabel="{name}">
 			<title>
 				<xsl:text>Function </xsl:text>
-				<xsl:value-of select="$name"/>
+				<xsl:value-of select="name"/>
 				<xsl:text>()</xsl:text>
 			</title>
 
 			<xsl:call-template name="generate.index.id">
-				<xsl:with-param name="name" select="$name"/>
+				<xsl:with-param name="name" select="name"/>
 			</xsl:call-template>
 
 			<para>
@@ -277,7 +238,7 @@
 				<xsl:text>(</xsl:text>
 
 				<xsl:choose>
-					<xsl:when test="argsstring = '(void)'">
+					<xsl:when test="not(param[1]/declname)">
 						<emphasis role="keyword">void</emphasis>
 					</xsl:when>
 
@@ -286,7 +247,7 @@
 							<xsl:if test="position() > 1">
 								<xsl:text>,</xsl:text>
 							</xsl:if>
-							<xsl:text>&#10;&#9;&#9;</xsl:text>
+							<xsl:text>&#10;&#9;</xsl:text>
 							<emphasis role="keyword">
 								<xsl:value-of select="type"/>
 							</emphasis>
@@ -304,16 +265,14 @@
 	</xsl:template>
 
 	<xsl:template match="memberdef[@kind = 'enum']">
-		<xsl:variable name="name" select="name"/>
-
 		<section id="{@id}" xreflabel="{name}">
 			<title>
 				<xsl:text>Enum </xsl:text>
-				<xsl:value-of select="$name"/>
+				<xsl:value-of select="name"/>
 			</title>
 
 			<xsl:call-template name="generate.index.id">
-				<xsl:with-param name="name" select="$name"/>
+				<xsl:with-param name="name" select="name"/>
 			</xsl:call-template>
 
 			<xsl:apply-templates select="detaileddescription"/>
@@ -333,7 +292,10 @@
 								<entry>
 									<para id="{@id}" xreflabel="{name}">
 										<xsl:value-of select="name"/>
-										<indexterm id="{$keyword.namespace}.{$name}.{name}"/>
+
+										<xsl:call-template name="generate.index.id">
+											<xsl:with-param name="name" select="name"/>
+										</xsl:call-template>
 									</para>
 								</entry>
 								<entry>
@@ -348,8 +310,6 @@
 	</xsl:template>
 
 	<xsl:template match="memberdef[@kind = 'define']">
-		<xsl:variable name="name" select="name"/>
-
 		<section id="{@id}" xreflabel="{name}">
 			<title>
 				<xsl:text>Macro </xsl:text>
@@ -357,7 +317,7 @@
 			</title>
 
 			<xsl:call-template name="generate.index.id">
-				<xsl:with-param name="name" select="$name"/>
+				<xsl:with-param name="name" select="name"/>
 			</xsl:call-template>
 
 			<programlisting language="c">
@@ -378,7 +338,7 @@
 
 					<!-- Split long macro definitions across multiple lines -->
 					<xsl:if test="(string-length(initializer) > 50) or (count(param) > 0)">
-						<xsl:text>\&#10;&#09;&#9;</xsl:text>
+						<xsl:text>\&#10;&#9;</xsl:text>
 					</xsl:if>
 
 					<xsl:value-of select="initializer"/>
@@ -391,21 +351,19 @@
 	</xsl:template>
 
 	<xsl:template match="memberdef[@kind = 'variable' or @kind = 'typedef']">
-		<xsl:variable name="name" select="name"/>
-
 		<section id="{@id}" xreflabel="{name}">
 			<!-- Doxygen gets confused and thinks function pointer type definitions
 				 are variables, so we need to map them to this common section and
 				 check the definition to see which of the two it is. -->
 			<xsl:choose>
-				<xsl:when test="contains(definition,'typedef')">
+				<xsl:when test="contains(definition, 'typedef')">
 					<title>
 						<xsl:text>Type </xsl:text>
 						<xsl:value-of select="name"/>
 					</title>
 
 					<xsl:call-template name="generate.index.id">
-						<xsl:with-param name="name" select="$name"/>
+						<xsl:with-param name="name" select="name"/>
 					</xsl:call-template>
 
 					<programlisting language="c">
@@ -427,7 +385,7 @@
 					</title>
 
 					<xsl:call-template name="generate.index.id">
-						<xsl:with-param name="name" select="$name"/>
+						<xsl:with-param name="name" select="name"/>
 					</xsl:call-template>
 
 					<programlisting language="c">
@@ -444,7 +402,7 @@
 		</section>
 	</xsl:template>
 
-	<xsl:template match="linebreak">
+	<xsl:template match="linebreak | simplesectsep">
 		<literallayout>
 		</literallayout>
 	</xsl:template>
@@ -471,47 +429,47 @@
 
 	<xsl:template match="simplesect">
 		<xsl:choose>
-			<xsl:when test="@kind = 'warning'">
-				<warning>
-					<title>Warning</title>
-					<xsl:apply-templates select="para"/>
-				</warning>
+			<xsl:when test="@kind = 'par'">
+				<note>
+					<title>
+						<xsl:value-of select="title"/>
+					</title>
+					<xsl:apply-templates/>
+				</note>
 			</xsl:when>
 
 			<xsl:when test="@kind = 'return'">
 				<note>
 					<title>Returns</title>
-					<xsl:apply-templates select="para"/>
+					<xsl:apply-templates/>
 				</note>
 			</xsl:when>
 
-			<xsl:when test="@kind = 'pre'">
-				<note>
-					<title>Precondition</title>
-					<xsl:apply-templates select="para"/>
-				</note>
+			<xsl:when test="@kind = 'warning'">
+				<warning>
+					<title>Warning</title>
+					<xsl:apply-templates/>
+				</warning>
 			</xsl:when>
 
-			<xsl:when test="@kind = 'par'">
+			<xsl:when test="@kind = 'pre'">
 				<note>
-					<title>
-						<xsl:value-of select="title"/>
-					</title>
-					<xsl:apply-templates select="para"/>
+					<title>Precondition</title>
+					<xsl:apply-templates/>
 				</note>
 			</xsl:when>
 
 			<xsl:when test="@kind = 'see'">
 				<note>
 					<title>See also</title>
-					<xsl:apply-templates select="para"/>
+					<xsl:apply-templates/>
 				</note>
 			</xsl:when>
 
 			<xsl:when test="@kind = 'note'">
 				<note>
 					<title>Note</title>
-					<xsl:apply-templates select="para"/>
+					<xsl:apply-templates/>
 				</note>
 			</xsl:when>
 
@@ -569,6 +527,7 @@
 						<xsl:when test="not(descendant::parametername/@direction)">
 							<emphasis role="italic">?</emphasis>
 						</xsl:when>
+
 						<xsl:otherwise>
 							<emphasis role="bold">
 								[<xsl:value-of select="descendant::parametername/@direction"/>]
@@ -590,64 +549,70 @@
 		</entry>
 	</xsl:template>
 
-	<xsl:template match="type">
-		<xsl:apply-templates/>
-	</xsl:template>
-
-	<xsl:template match="para">
+	<xsl:template match="parameterdescription">
 		<para>
 			<xsl:apply-templates/>
 		</para>
 	</xsl:template>
 
+	<xsl:template match="type">
+		<xsl:apply-templates/>
+	</xsl:template>
+
 	<xsl:template match="bold">
 		<emphasis role="bold">
-			<xsl:value-of select="."/>
+			<xsl:apply-templates/>
 		</emphasis>
 	</xsl:template>
 
 	<xsl:template match="emphasis">
 		<emphasis role="italic">
-			<xsl:value-of select="."/>
+			<xsl:apply-templates/>
 		</emphasis>
 	</xsl:template>
 
-	<xsl:template match="computeroutput">
-		<computeroutput>
-			<xsl:value-of select="."/>
-		</computeroutput>
+	<xsl:template match="small">
+		<xsl:apply-templates/>
 	</xsl:template>
 
-	<xsl:template match="ulink">
-		<ulink url="{@url}">
-			<xsl:value-of select="."/>
-		</ulink>
+	<xsl:template match="mdash | ndash">
+		<xsl:text>--</xsl:text>
 	</xsl:template>
 
-	<xsl:template match="registered">
-		<xsl:text>&#174;</xsl:text>
+	<xsl:template match="computeroutput | preformatted">
+		<computeroutput>
+			<xsl:apply-templates/>
+		</computeroutput>
 	</xsl:template>
 
-	<xsl:template match="copy">
-		<xsl:text>&#169;</xsl:text>
+	<xsl:template match="codeline">
+			<xsl:apply-templates/>
 	</xsl:template>
 
-	<xsl:template match="trademark">
-		<xsl:text>&#8482;</xsl:text>
+	<xsl:template match="ulink">
+		<ulink url="{@url}">
+			<xsl:value-of select="."/>
+		</ulink>
 	</xsl:template>
 
 	<xsl:template match="superscript">
 		<superscript>
-			<xsl:value-of select="."/>
+			<xsl:apply-templates/>
 		</superscript>
 	</xsl:template>
 
 	<xsl:template match="subscript">
 		<subscript>
-			<xsl:value-of select="."/>
+			<xsl:apply-templates/>
 		</subscript>
 	</xsl:template>
 
+	<xsl:template match="para">
+		<para>
+			<xsl:apply-templates/>
+		</para>
+	</xsl:template>
+
 	<xsl:template match="ref">
 		<xsl:choose>
 			<!-- Don't show links inside program listings -->
@@ -655,6 +620,11 @@
 				<xsl:value-of select="."/>
 			</xsl:when>
 
+			<!-- Don't show links to file compound definitions, as they are discarded -->
+			<xsl:when test="ancestor::*/compounddef[@kind = 'file' and @id = current()/@refid]">
+				<xsl:value-of select="."/>
+			</xsl:when>
+
 			<!-- Show links outside program listings -->
 			<xsl:otherwise>
 				<link linkend="{@refid}">
@@ -664,6 +634,12 @@
 		</xsl:choose>
 	</xsl:template>
 
+	<xsl:template match="entry">
+		<entry>
+			<xsl:apply-templates/>
+		</entry>
+	</xsl:template>
+
 	<xsl:template match="table">
 		<xsl:choose>
 			<xsl:when test="caption">
@@ -671,9 +647,11 @@
 					<title>
 						<xsl:value-of select="caption"/>
 					</title>
+
 					<xsl:call-template name="write.table.content"/>
 				</table>
 			</xsl:when>
+
 			<xsl:otherwise>
 				<informaltable tabstyle="striped">
 					<xsl:call-template name="write.table.content"/>
@@ -687,22 +665,14 @@
 			<thead>
 				<xsl:for-each select="row[1]">
 					<row>
-						<xsl:for-each select="entry">
-							<entry>
-								<xsl:apply-templates select="."/>
-							</entry>
-						</xsl:for-each>
+						<xsl:apply-templates select="entry"/>
 					</row>
 				</xsl:for-each>
 			</thead>
 			<tbody>
 				<xsl:for-each select="row[position() != 1]">
 					<row>
-						<xsl:for-each select="entry">
-							<entry>
-								<xsl:apply-templates select="."/>
-							</entry>
-						</xsl:for-each>
+						<xsl:apply-templates select="entry"/>
 					</row>
 				</xsl:for-each>
 			</tbody>
@@ -711,13 +681,13 @@
 
 	<xsl:template match="itemizedlist">
 		<itemizedlist>
-			<xsl:apply-templates select="listitem"/>
+			<xsl:apply-templates/>
 		</itemizedlist>
 	</xsl:template>
 
 	<xsl:template match="orderedlist">
 		<orderedlist>
-			<xsl:apply-templates select="listitem"/>
+			<xsl:apply-templates/>
 		</orderedlist>
 	</xsl:template>
 
@@ -749,7 +719,7 @@
 	<xsl:template match="image">
 		<mediaobject>
 			<imageobject>
-				<imagedata>
+				<imagedata align="center">
 					<xsl:attribute name="fileref">
 						<xsl:text>images/</xsl:text>
 						<xsl:value-of select="@name"/>
@@ -787,4 +757,10 @@
 
 	<xsl:template match="title"/>
 
+	<xsl:template match="htmlonly"/>
+
+	<xsl:template match="*">
+		<xsl:message>NO XSL TEMPLATE MATCH: <xsl:value-of select="name()"/></xsl:message>
+	</xsl:template>
+
 </xsl:stylesheet>