Skip to content
Snippets Groups Projects
Commit 897288304f9a authored by Emmanuele Bassi's avatar Emmanuele Bassi
Browse files

Generate devhelp2 index file 

The devhelp2 format was introduced in 2005, and the devhelp format was
deprecated in 2017.

Fixes: https://gitlab.gnome.org/GNOME/libxml2/-/issues/295
parent 62e5b217b008
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
doc/devhelp/Makefile.am
+ 7
− 1
View file @ 89728830
devhelpdir = $(datadir)/gtk-doc/html/libxml2 devhelpdir = $(datadir)/gtk-doc/html/libxml2
dist_devhelp_DATA = \ dist_devhelp_DATA = \
libxml2.devhelp2 \
libxml2.devhelp \ libxml2.devhelp \
$(HTML_FILES) \ $(HTML_FILES) \
$(EXTRA_FORMAT) $(EXTRA_FORMAT)
...@@ -69,10 +70,10 @@ ...@@ -69,10 +70,10 @@
EXTRA_DIST = devhelp.xsl html.xsl EXTRA_DIST = devhelp.xsl html.xsl
if REBUILD_DOCS if REBUILD_DOCS
rebuild: libxml2.devhelp $(HTML_FILES) rebuild: libxml2.devhelp2 libxml2.devhelp $(HTML_FILES)
.PHONY: rebuild .PHONY: rebuild
libxml2.devhelp $(HTML_FILES): devhelp.xsl html.xsl $(top_srcdir)/doc/libxml2-api.xml libxml2.devhelp $(HTML_FILES): devhelp.xsl html.xsl $(top_srcdir)/doc/libxml2-api.xml
-@(if [ -x $(XSLTPROC) ] ; then \ -@(if [ -x $(XSLTPROC) ] ; then \
echo Rebuilding devhelp files ; \ echo Rebuilding devhelp files ; \
$(XSLTPROC) --nonet -o $(srcdir)/libxml2.devhelp $(srcdir)/devhelp.xsl $(top_srcdir)/doc/libxml2-api.xml ; fi ); $(XSLTPROC) --nonet -o $(srcdir)/libxml2.devhelp $(srcdir)/devhelp.xsl $(top_srcdir)/doc/libxml2-api.xml ; fi );
...@@ -73,7 +74,12 @@ ...@@ -73,7 +74,12 @@
.PHONY: rebuild .PHONY: rebuild
libxml2.devhelp $(HTML_FILES): devhelp.xsl html.xsl $(top_srcdir)/doc/libxml2-api.xml libxml2.devhelp $(HTML_FILES): devhelp.xsl html.xsl $(top_srcdir)/doc/libxml2-api.xml
-@(if [ -x $(XSLTPROC) ] ; then \ -@(if [ -x $(XSLTPROC) ] ; then \
echo Rebuilding devhelp files ; \ echo Rebuilding devhelp files ; \
$(XSLTPROC) --nonet -o $(srcdir)/libxml2.devhelp $(srcdir)/devhelp.xsl $(top_srcdir)/doc/libxml2-api.xml ; fi ); $(XSLTPROC) --nonet -o $(srcdir)/libxml2.devhelp $(srcdir)/devhelp.xsl $(top_srcdir)/doc/libxml2-api.xml ; fi );
libxml2.devhelp2 $(HTML_FILES): devhelp2.xsl html.xsl $(top_srcdir)/doc/libxml2-api.xml
-@(if [ -x $(XSLTPROC) ] ; then \
echo Rebuilding devhelp2 files ; \
$(XSLTPROC) --nonet -o $(srcdir)/libxml2.devhelp2 $(srcdir)/devhelp2.xsl $(top_srcdir)/doc/libxml2-api.xml ; fi );
endif endif
doc/devhelp/devhelp2.xsl 0 → 100644
+ 127
− 0
View file @ 89728830
<?xml version="1.0"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
xmlns="http://www.devhelp.net/book"
xmlns:exsl="http://exslt.org/common"
xmlns:str="http://exslt.org/strings"
extension-element-prefixes="exsl str"
exclude-result-prefixes="exsl str">
<!-- The stylesheet for the html pages -->
<xsl:import href="html.xsl"/>
<xsl:output method="xml" encoding="UTF-8" indent="yes"/>
<!-- Build keys for all symbols -->
<xsl:key name="symbols" match="/api/symbols/*" use="@name"/>
<xsl:template match="/api">
<book title="{@name} Reference Manual" link="index.html" author="" name="{@name}">
<xsl:apply-templates select="files"/>
<xsl:apply-templates select="symbols"/>
</book>
<xsl:call-template name="generate_index"/>
<xsl:call-template name="generate_general"/>
</xsl:template>
<xsl:template match="/api/files">
<chapters>
<sub name="API" link="general.html">
<xsl:apply-templates select="file"/>
</sub>
</chapters>
</xsl:template>
<xsl:template match="/api/files/file">
<xsl:variable name="module" select="@name"/>
<xsl:variable name="prev" select="string(preceding-sibling::file[position()=1]/@name)"/>
<xsl:variable name="next" select="string(following-sibling::file[position()=1]/@name)"/>
<sub name="{@name}" link="libxml2-{@name}.html"/>
<xsl:document xmlns="" href="libxml2-{@name}.html" method="xml" indent="yes" encoding="UTF-8">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title><xsl:value-of select="concat(@name, ': ', summary)"/></title>
<meta name="generator" content="Libxml2 devhelp stylesheet"/>
<link rel="start" href="index.html" title="libxml2 Reference Manual"/>
<link rel="up" href="general.html" title="API"/>
<link rel="stylesheet" href="style.css" type="text/css"/>
<link rel="chapter" href="general.html" title="API"/>
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<xsl:if test="$prev != ''">
<td><a accesskey="p" href="libxml2-{$prev}.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"/></a></td>
</xsl:if>
<td><a accesskey="u" href="general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"/></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"/></a></td>
<xsl:if test="$next != ''">
<td><a accesskey="n" href="libxml2-{$next}.html"><img src="right.png" width="24" height="24" border="0" alt="Next"/></a></td>
</xsl:if>
<th width="100%" align="center">libxml2 Reference Manual</th>
</tr>
</table>
<h2><span class="refentrytitle"><xsl:value-of select="@name"/></span></h2>
<p><xsl:value-of select="@name"/> - <xsl:value-of select="summary"/></p>
<p><xsl:value-of select="description"/></p>
<xsl:if test="deprecated">
<p> WARNING: this module is deprecated !</p>
</xsl:if>
<p>Author(s): <xsl:value-of select="author"/></p>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<xsl:apply-templates mode="synopsis" select="exports"/>
</pre>
</div>
<div class="refsect1" lang="en">
<h2>Description</h2>
</div>
<div class="refsect1" lang="en">
<h2>Details</h2>
<div class="refsect2" lang="en">
<xsl:apply-templates mode="details" select="/api/symbols/macro[@file=$module]"/>
<xsl:apply-templates mode="details" select="/api/symbols/typedef[@file=$module] | /api/symbols/struct[@file=$module]"/>
<xsl:apply-templates mode="details" select="/api/symbols/functype[@file=$module]"/>
<xsl:apply-templates mode="details" select="/api/symbols/variable[@file=$module]"/>
<xsl:apply-templates mode="details" select="/api/symbols/function[@file=$module]"/>
</div>
</div>
</body>
</html>
</xsl:document>
</xsl:template>
<xsl:template match="/api/symbols">
<functions>
<xsl:apply-templates select="macro"/>
<xsl:apply-templates select="enum"/>
<xsl:apply-templates select="typedef"/>
<xsl:apply-templates select="struct"/>
<xsl:apply-templates select="functype"/>
<xsl:apply-templates select="variable"/>
<xsl:apply-templates select="function"/>
</functions>
</xsl:template>
<xsl:template match="/api/symbols/functype">
<keyword type="function" name="{@name}" link="libxml2-{@file}.html#{@name}"/>
</xsl:template>
<xsl:template match="/api/symbols/function">
<keyword type="function" name="{@name} ()" link="libxml2-{@file}.html#{@name}"/>
</xsl:template>
<xsl:template match="/api/symbols/typedef">
<keyword type="typedef" name="{@name}" link="libxml2-{@file}.html#{@name}"/>
</xsl:template>
<xsl:template match="/api/symbols/enum">
<keyword type="enum" name="{@name}" link="libxml2-{@file}.html#{@name}"/>
</xsl:template>
<xsl:template match="/api/symbols/struct">
<keyword type="struct" name="{@name}" link="libxml2-{@file}.html#{@name}"/>
</xsl:template>
<xsl:template match="/api/symbols/macro">
<keyword type="macro" name="{@name}" link="libxml2-{@file}.html#{@name}"/>
</xsl:template>
<xsl:template match="/api/symbols/variable">
<keyword type="macro" name="{@name}" link="libxml2-{@file}.html#{@name}"/>
</xsl:template>
</xsl:stylesheet>
doc/devhelp/libxml2.devhelp2 0 → 100644
+ 3580
− 0
View file @ 89728830
Source diff could not be displayed: it is too large. Options to address this: view the blob.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment