api-doc links to generic-functions and macros
Tue Apr 7 13:27:30 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>
* api-doc links to generic-functions and macros
diff -rN -u old-doc/Makefile new-doc/Makefile
--- old-doc/Makefile 2014-10-30 06:55:36.000000000 +0100
+++ new-doc/Makefile 2014-10-30 06:55:36.000000000 +0100
@@ -5,7 +5,7 @@
all: manual.html index.html
-DEPENDANCIES := *docbook *.xsl ../qt.examples/src/*.lisp ../kde.examples/src/*.lisp
+DEPENDANCIES := *docbook *.xsl ../qt.examples/src/*.lisp ../kde.examples/src/*.lisp *.dtd
manual.html: $(DEPENDANCIES)
xmllint --xinclude --postvalid manual.docbook > /dev/null
diff -rN -u old-doc/kde.docbook new-doc/kde.docbook
--- old-doc/kde.docbook 2014-10-30 06:55:36.000000000 +0100
+++ new-doc/kde.docbook 2014-10-30 06:55:36.000000000 +0100
@@ -13,11 +13,11 @@
<para>
The examples can be run with:
<programlisting>
-(mb:load :kde.examples)
+(mb:load <package>:kde.examples</package>)
</programlisting>
An the running the function of the example; e.g.:
<programlisting>
-(kde.examples:mandelbrot)
+(<methodname>kde.examples:mandelbrot</methodname>)
</programlisting>
</para>
<example>
diff -rN -u old-doc/link-api.dtd new-doc/link-api.dtd
--- old-doc/link-api.dtd 1970-01-01 01:00:00.000000000 +0100
+++ new-doc/link-api.dtd 2014-10-30 06:55:36.000000000 +0100
@@ -0,0 +1,7 @@
+<!ELEMENT macro ANY>
+<!ATTLIST macro>
+
+<!ELEMENT genericfunction ANY>
+<!ATTLIST genericfunction>
+
+<!ENTITY % local.para.char.mix "| macro | genericfunction">
diff -rN -u old-doc/link-apidoc.xsl new-doc/link-apidoc.xsl
--- old-doc/link-apidoc.xsl 2014-10-30 06:55:36.000000000 +0100
+++ new-doc/link-apidoc.xsl 2014-10-30 06:55:36.000000000 +0100
@@ -49,4 +49,24 @@
</xsl:call-template>
</xsl:template>
+<xsl:template match="macro">
+ <xsl:call-template name="ulink">
+ <xsl:with-param name="url" select="concat($apidoc-baseurl,
+ substring-before(current(),':'),
+ '/',
+ substring-after(current(),':'),
+ '-macro.html')"/>
+ </xsl:call-template>
+</xsl:template>
+
+<xsl:template match="genericfunction">
+ <xsl:call-template name="ulink">
+ <xsl:with-param name="url" select="concat($apidoc-baseurl,
+ substring-before(current(),':'),
+ '/',
+ substring-after(current(),':'),
+ '-generic-function.html')"/>
+ </xsl:call-template>
+</xsl:template>
+
</xsl:stylesheet>
diff -rN -u old-doc/manual.docbook new-doc/manual.docbook
--- old-doc/manual.docbook 2014-10-30 06:55:36.000000000 +0100
+++ new-doc/manual.docbook 2014-10-30 06:55:36.000000000 +0100
@@ -1,6 +1,9 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+ <!ENTITY % link-api SYSTEM "link-api.dtd">
+ %link-api;
+ ]>
<book id="cl-smoke" lang="en">
<bookinfo>
diff -rN -u old-doc/qt.docbook new-doc/qt.docbook
--- old-doc/qt.docbook 2014-10-30 06:55:36.000000000 +0100
+++ new-doc/qt.docbook 2014-10-30 06:55:36.000000000 +0100
@@ -26,7 +26,7 @@
<section><title>QApplication</title>
<para>
The <classname>qt:application</classname> object should created with:
-<code>qt:with-app</code>. In its body the event loop can be
+<macro>qt:with-app</macro>. In its body the event loop can be
started with <methodname>qt:exec</methodname>.
</para>
<example>
@@ -46,7 +46,7 @@
<section><title>Signal-Slot</title>
<para>
-<methodname>qt:connect</methodname> connects a signal to a slot.
+<genericfunction>qt:connect</genericfunction> connects a signal to a slot.
The signal is either a <classname>qt:qsignal</classname> created with
<methodname>qt:make-signal</methodname> or a C++ signal by using
<methodname>qt:get-signal</methodname>.
@@ -128,8 +128,8 @@
<para>
You can run the examples with:
<programlisting>
-(mb:load :qt.examples)
-(qt.examples:launcher)
+(mb:load <package>:qt.examples</package>)
+(<methodname>qt.examples:launcher</methodname>)
</programlisting>
</para>