darcs - doc

repos / doc / headdiff

Minor corrections. --> to head

Sat Apr 3 21:12:53 CEST 2010 Tobias Rautenkranz <tobias@rautenkranz.ch>

* KDE is split up in kde.ui and kde.core.

Sat Apr 3 21:12:32 CEST 2010 Tobias Rautenkranz <tobias@rautenkranz.ch>

* C++ member variable access

Sun Jan 10 09:57:54 CET 2010 Tobias Rautenkranz <tobias@rautenkranz.ch>

* modular smoke.

Sun Dec 13 14:22:09 CET 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* remove mudballs

Wed Sep 2 14:08:06 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* cl-smoke now supports user conversions for return values.

Sun Aug 30 16:26:13 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Multiple inheritance doc & expand tabs in programmlisting.

Thu Aug 27 13:47:08 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Update for the new smokegenerator

Sun Aug 2 13:24:57 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Remove wrong note about cxx:meta-object

Thu Jul 23 00:59:59 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* add phonon repository

Thu Jul 23 00:53:41 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* phonon & :arg0

Mon Jul 6 23:51:20 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* OpenGL: origami

Fri Jul 3 00:28:43 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* cl-smoke.commonqt & Clozure CL support

Sun Jun 21 11:29:52 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Link Benchmark

Wed Jun 10 14:17:14 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* better Lisp source highlighting

Fri Jun 5 16:17:33 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Lisp syntax highlighting

Thu Jun 4 23:20:49 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* interactive development

Thu Jun 4 00:31:34 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* ASDF & dispatch callback restarts

Tue May 26 12:08:31 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Return value conversions

Sun May 24 17:11:38 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Fixed hash-table multithreading

Tue May 19 16:44:30 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Clozure CL save-application

Thu May 14 14:56:16 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Save core image

Tue May 12 19:03:22 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Note Clozure CL support

Mon May 11 22:23:03 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Rename *.docbook -> *.xml

Mon May 11 22:19:30 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* document setf & cleanup

Fri Apr 17 17:32:31 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* C++ overload resolution

Tue Apr 14 16:08:15 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* FDL license & small updates

Sun Apr 12 22:56:16 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* operators & qt:variant

Sun Apr 12 16:50:23 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* overloading of methods

Thu Apr 9 14:44:58 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Minor corrections.

diff -rN -u old-doc/Makefile new-doc/Makefile

--- old-doc/Makefile 2014-10-30 07:14:03.000000000 +0100

+++ new-doc/Makefile 2014-10-30 07:14:03.000000000 +0100

@@ -1,22 +1,36 @@

# Dependancies:

-# xmllint xsltproc docbook

+# - xmllint

+# - saxon

+# - docbook

+# - xslthl

+# Debian: download the xslthl jar into the doc/ directory; install the remaining dependancies with apt.

+SAXON_JAR := /usr/share/java/saxon.jar

+XSLTHL_JAR := $(firstword $(wildcard xslthl*.jar))

+CLASSPATH := "$(SAXON_JAR):$(XSLTHL_JAR)"

+SAXON := java -classpath $(CLASSPATH) \

+ -Dxslthl.config="file://$(realpath xslthl-config.xml)" \

+ com.icl.saxon.StyleSheet

all: manual.html index.html

-DEPENDANCIES := *docbook *.xsl ../qt.examples/src/*.lisp ../kde.examples/src/*.lisp *.dtd

+DEPENDANCIES := *.xml *.xsl ../qt.examples/src/*.lisp ../kde.examples/src/*.lisp *.dtd

+# validate & process xincludes

+manual.tmp: $(DEPENDANCIES)

+ xmllint --xinclude --postvalid manual.xml > manual.tmp

-manual.html: $(DEPENDANCIES)

- xmllint --xinclude --postvalid manual.docbook > /dev/null

- xsltproc --xinclude -o $@ manual.xsl manual.docbook

+manual.html: manual.tmp

+ $(SAXON) -o manual.html manual.tmp manual.xsl

-index.html: $(DEPENDANCIES)

-# xsltproc --xinclude --stringparam base.dir "manual/" chunk.xsl manual.docbook

- xsltproc --xinclude chunk.xsl manual.docbook

+index.html: manual.tmp

+ $(SAXON) manual.tmp chunk.xsl

.PHONY: clean

clean:

- rm -f -- *.html

+ rm -f -- *.html *.tmp

diff -rN -u old-doc/chunk.xsl new-doc/chunk.xsl

--- old-doc/chunk.xsl 2014-10-30 07:14:03.000000000 +0100

+++ new-doc/chunk.xsl 2014-10-30 07:14:03.000000000 +0100

@@ -2,13 +2,18 @@

<xsl:stylesheet version="1.0"

xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

-<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/xhtml/chunk.xsl"/>

-<xsl:import href="link-apidoc.xsl"/>

+<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/html/chunk.xsl" />

+<xsl:import href="nonlink-apidoc.xsl" />

+<xsl:import href="video.xsl" />

+<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/html/highlight.xsl" />

+<xsl:param name="highlight.source" select="1" />

<!--

<xsl:param name="admon.graphics" select="1"/>

!-->

-<xsl:param name="use.id.as.filename" select="1"/>

+<xsl:param name="use.id.as.filename" select="1" />

</xsl:stylesheet>

Binary files old-doc/commonqt-t14.png and new-doc/commonqt-t14.png differ

diff -rN -u old-doc/fdl-1.3.xml new-doc/fdl-1.3.xml

--- old-doc/fdl-1.3.xml 1970-01-01 01:00:00.000000000 +0100

+++ new-doc/fdl-1.3.xml 2014-10-30 07:14:03.000000000 +0100

@@ -0,0 +1,560 @@

+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">

+<appendix id="fdl">

+ <title>GNU Free Documentation License</title>

+ <simpara>Version 1.3, 3 November 2008</simpara>

+ <simpara>

+ <ulink url="http://www.fsf.org/">Free Software Foundation, Inc.</ulink>

+ </simpara>

+ <simpara>

+ Everyone is permitted to copy and distribute verbatim copies of this

+ license document, but changing it is not allowed.

+ </simpara>

+ <bridgehead id="section0" renderas="sect2">

+ 0. PREAMBLE

+ </bridgehead>

+ <simpara>

+ The purpose of this License is to make a manual, textbook, or other

+ functional and useful document “free” in the sense of freedom:

+ to assure everyone the effective freedom to copy and redistribute it, with

+ or without modifying it, either commercially or

+ noncommercially. Secondarily, this License preserves for the author and

+ publisher a way to get credit for their work, while not being considered

+ responsible for modifications made by others.

+ </simpara>

+ <simpara>

+ This License is a kind of “copyleft”, which means that

+ derivative works of the document must themselves be free in the same

+ sense. It complements the GNU General Public License, which is a copyleft

+ license designed for free software.

+ </simpara>

+ <simpara>

+ We have designed this License in order to use it for manuals for free

+ software, because free software needs free documentation: a free program

+ should come with manuals providing the same freedoms that the software

+ does. But this License is not limited to software manuals; it can be used

+ for any textual work, regardless of subject matter or whether it is

+ published as a printed book. We recommend this License principally for

+ works whose purpose is instruction or reference.

+ </simpara>

+ <bridgehead id="section1" renderas="sect2">

+ 1. APPLICABILITY AND DEFINITIONS

+ </bridgehead>

+ <simpara>

+ This License applies to any manual or other work, in any medium, that

+ contains a notice placed by the copyright holder saying it can be

+ distributed under the terms of this License. Such a notice grants a

+ world-wide, royalty-free license, unlimited in duration, to use that work

+ under the conditions stated herein. The “Document”, below,

+ refers to any such manual or work. Any member of the public is a licensee,

+ and is addressed as “you”. You accept the license if you copy,

+ modify or distribute the work in a way requiring permission under

+ copyright law.

+ </simpara>

+ <simpara>

+ A “Modified Version” of the Document means any work containing

+ the Document or a portion of it, either copied verbatim, or with

+ modifications and/or translated into another language.

+ </simpara>

+ <simpara>

+ A “Secondary Section” is a named appendix or a front-matter

+ section of the Document that deals exclusively with the relationship of

+ the publishers or authors of the Document to the Document’s overall

+ subject (or to related matters) and contains nothing that could fall

+ directly within that overall subject. (Thus, if the Document is in part a

+ textbook of mathematics, a Secondary Section may not explain any

+ mathematics.) The relationship could be a matter of historical connection

+ with the subject or with related matters, or of legal, commercial,

+ philosophical, ethical or political position regarding them.

+ </simpara>

+ <simpara>

+ The “Invariant Sections” are certain Secondary Sections whose

+ titles are designated, as being those of Invariant Sections, in the notice

+ that says that the Document is released under this License. If a section

+ does not fit the above definition of Secondary then it is not allowed to

+ be designated as Invariant. The Document may contain zero Invariant

+ Sections. If the Document does not identify any Invariant Sections then

+ there are none.

+ </simpara>

+ <simpara>

+ The “Cover Texts” are certain short passages of text that are

+ listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says

+ that the Document is released under this License. A Front-Cover Text may

+ be at most 5 words, and a Back-Cover Text may be at most 25 words.

+ </simpara>

+ <simpara>

+ A “Transparent” copy of the Document means a machine-readable

+ copy, represented in a format whose specification is available to the

+ general public, that is suitable for revising the document

+ straightforwardly with generic text editors or (for images composed of

+ pixels) generic paint programs or (for drawings) some widely available

+ drawing editor, and that is suitable for input to text formatters or for

+ automatic translation to a variety of formats suitable for input to text

+ formatters. A copy made in an otherwise Transparent file format whose

+ markup, or absence of markup, has been arranged to thwart or discourage

+ subsequent modification by readers is not Transparent. An image format is

+ not Transparent if used for any substantial amount of text. A copy that is

+ not “Transparent” is called “Opaque”.

+ </simpara>

+ <simpara>

+ Examples of suitable formats for Transparent copies include plain ASCII

+ without markup, Texinfo input format, LaTeX input format, SGML or XML

+ using a publicly available DTD, and standard-conforming simple HTML,

+ PostScript or PDF designed for human modification. Examples of transparent

+ image formats include PNG, XCF and JPG. Opaque formats include proprietary

+ formats that can be read and edited only by proprietary word processors,

+ SGML or XML for which the DTD and/or processing tools are not generally

+ available, and the machine-generated HTML, PostScript or PDF produced by

+ some word processors for output purposes only.

+ </simpara>

+ <simpara>

+ The “Title Page” means, for a printed book, the title page

+ itself, plus such following pages as are needed to hold, legibly, the

+ material this License requires to appear in the title page. For works in

+ formats which do not have any title page as such, “Title Page”

+ means the text near the most prominent appearance of the work’s

+ title, preceding the beginning of the body of the text.

+ </simpara>

+ <simpara>

+ The “publisher” means any person or entity that distributes

+ copies of the Document to the public.

+ </simpara>

+ <simpara>

+ A section “Entitled XYZ” means a named subunit of the Document

+ whose title either is precisely XYZ or contains XYZ in parentheses

+ following text that translates XYZ in another language. (Here XYZ stands

+ for a specific section name mentioned below, such as

+ “Acknowledgements”, “Dedications”,

+ “Endorsements”, or “History”.) To “Preserve

+ the Title” of such a section when you modify the Document means that

+ it remains a section “Entitled XYZ” according to this

+ definition.

+ </simpara>

+ <simpara>

+ The Document may include Warranty Disclaimers next to the notice which

+ states that this License applies to the Document. These Warranty

+ Disclaimers are considered to be included by reference in this License,

+ but only as regards disclaiming warranties: any other implication that

+ these Warranty Disclaimers may have is void and has no effect on the

+ meaning of this License.

+ </simpara>

+ <bridgehead id="section2" renderas="sect2">

+ 2. VERBATIM COPYING

+ </bridgehead>

+ <simpara>

+ You may copy and distribute the Document in any medium, either

+ commercially or noncommercially, provided that this License, the copyright

+ notices, and the license notice saying this License applies to the

+ Document are reproduced in all copies, and that you add no other

+ conditions whatsoever to those of this License. You may not use technical

+ measures to obstruct or control the reading or further copying of the

+ copies you make or distribute. However, you may accept compensation in

+ exchange for copies. If you distribute a large enough number of copies you

+ must also follow the conditions in section 3.

+ </simpara>

+ <simpara>

+ You may also lend copies, under the same conditions stated above, and you

+ may publicly display copies.

+ </simpara>

+ <bridgehead id="section3" renderas="sect2">

+ 3. COPYING IN QUANTITY

+ </bridgehead>

+ <simpara>

+ If you publish printed copies (or copies in media that commonly have

+ printed covers) of the Document, numbering more than 100, and the

+ Document’s license notice requires Cover Texts, you must enclose

+ the copies in covers that carry, clearly and legibly, all these Cover

+ Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the

+ back cover. Both covers must also clearly and legibly identify you as the

+ publisher of these copies. The front cover must present the full title

+ with all words of the title equally prominent and visible. You may add

+ other material on the covers in addition. Copying with changes limited to

+ the covers, as long as they preserve the title of the Document and satisfy

+ these conditions, can be treated as verbatim copying in other respects.

+ </simpara>

+ <simpara>

+ If the required texts for either cover are too voluminous to fit legibly,

+ you should put the first ones listed (as many as fit reasonably) on the

+ actual cover, and continue the rest onto adjacent pages.

+ </simpara>

+ <simpara>

+ If you publish or distribute Opaque copies of the Document numbering more

+ than 100, you must either include a machine-readable Transparent copy

+ along with each Opaque copy, or state in or with each Opaque copy a

+ computer-network location from which the general network-using public has

+ access to download using public-standard network protocols a complete

+ Transparent copy of the Document, free of added material. If you use the

+ latter option, you must take reasonably prudent steps, when you begin

+ distribution of Opaque copies in quantity, to ensure that this Transparent

+ copy will remain thus accessible at the stated location until at least one

+ year after the last time you distribute an Opaque copy (directly or

+ through your agents or retailers) of that edition to the public.

+ </simpara>

+ <simpara>

+ It is requested, but not required, that you contact the authors of the

+ Document well before redistributing any large number of copies, to give

+ them a chance to provide you with an updated version of the Document.

+ </simpara>

+ <bridgehead id="section4" renderas="sect2">

+ 4. MODIFICATIONS

+ </bridgehead>

+ <simpara>

+ You may copy and distribute a Modified Version of the Document under the

+ conditions of sections 2 and 3 above, provided that you release the

+ Modified Version under precisely this License, with the Modified Version

+ filling the role of the Document, thus licensing distribution and

+ modification of the Modified Version to whoever possesses a copy of it. In

+ addition, you must do these things in the Modified Version:

+ </simpara>

+ <orderedlist numeration="upperalpha">

+ <listitem>

+ <simpara>

+ Use in the Title Page (and on the covers, if any) a title distinct

+ from that of the Document, and from those of previous versions (which

+ should, if there were any, be listed in the History section of the

+ Document). You may use the same title as a previous version if the

+ original publisher of that version gives permission.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ List on the Title Page, as authors, one or more persons or entities

+ responsible for authorship of the modifications in the Modified

+ Version, together with at least five of the principal authors of the

+ Document (all of its principal authors, if it has fewer than five),

+ unless they release you from this requirement.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ State on the Title page the name of the publisher of the Modified

+ Version, as the publisher.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ Preserve all the copyright notices of the Document.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ Add an appropriate copyright notice for your modifications adjacent to

+ the other copyright notices.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ Include, immediately after the copyright notices, a license notice

+ giving the public permission to use the Modified Version under the

+ terms of this License, in the form shown in the Addendum below.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ Preserve in that license notice the full lists of Invariant Sections

+ and required Cover Texts given in the Document’s license

+ notice.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ Include an unaltered copy of this License.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ Preserve the section Entitled “History”, Preserve its

+ Title, and add to it an item stating at least the title, year, new

+ authors, and publisher of the Modified Version as given on the Title

+ Page. If there is no section Entitled “History” in the

+ Document, create one stating the title, year, authors, and publisher

+ of the Document as given on its Title Page, then add an item

+ describing the Modified Version as stated in the previous sentence.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ Preserve the network location, if any, given in the Document for

+ public access to a Transparent copy of the Document, and likewise the

+ network locations given in the Document for previous versions it was

+ based on. These may be placed in the “History”

+ section. You may omit a network location for a work that was published

+ at least four years before the Document itself, or if the original

+ publisher of the version it refers to gives permission.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ For any section Entitled “Acknowledgements” or

+ “Dedications”, Preserve the Title of the section, and

+ preserve in the section all the substance and tone of each of the

+ contributor acknowledgements and/or dedications given therein.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ Preserve all the Invariant Sections of the Document, unaltered in

+ their text and in their titles. Section numbers or the equivalent are

+ not considered part of the section titles.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ Delete any section Entitled “Endorsements”. Such a section

+ may not be included in the Modified Version.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ Do not retitle any existing section to be Entitled

+ “Endorsements” or to conflict in title with any Invariant

+ Section.

+ </simpara>

+ </listitem>

+ <listitem>

+ <simpara>

+ Preserve any Warranty Disclaimers.

+ </simpara>

+ </listitem>

+ </orderedlist>

+ <simpara>

+ If the Modified Version includes new front-matter sections or appendices

+ that qualify as Secondary Sections and contain no material copied from the

+ Document, you may at your option designate some or all of these sections

+ as invariant. To do this, add their titles to the list of Invariant

+ Sections in the Modified Version’s license notice. These titles

+ must be distinct from any other section titles.

+ </simpara>

+ <simpara>

+ You may add a section Entitled “Endorsements”, provided it

+ contains nothing but endorsements of your Modified Version by various

+ parties — for example, statements of peer review or that the text

+ has been approved by an organization as the authoritative definition of a

+ standard.

+ </simpara>

+ <simpara>

+ You may add a passage of up to five words as a Front-Cover Text, and a

+ passage of up to 25 words as a Back-Cover Text, to the end of the list of

+ Cover Texts in the Modified Version. Only one passage of Front-Cover Text

+ and one of Back-Cover Text may be added by (or through arrangements made

+ by) any one entity. If the Document already includes a cover text for the

+ same cover, previously added by you or by arrangement made by the same

+ entity you are acting on behalf of, you may not add another; but you may

+ replace the old one, on explicit permission from the previous publisher

+ that added the old one.

+ </simpara>

+ <simpara>

+ The author(s) and publisher(s) of the Document do not by this License give

+ permission to use their names for publicity for or to assert or imply

+ endorsement of any Modified Version.

+ </simpara>

+ <bridgehead id="section5" renderas="sect2">

+ 5. COMBINING DOCUMENTS

+ </bridgehead>

+ <simpara>

+ You may combine the Document with other documents released under this

+ License, under the terms defined in section 4 above for modified versions,

+ provided that you include in the combination all of the Invariant Sections

+ of all of the original documents, unmodified, and list them all as

+ Invariant Sections of your combined work in its license notice, and that

+ you preserve all their Warranty Disclaimers.

+ </simpara>

+ <simpara>

+ The combined work need only contain one copy of this License, and multiple

+ identical Invariant Sections may be replaced with a single copy. If there

+ are multiple Invariant Sections with the same name but different contents,

+ make the title of each such section unique by adding at the end of it, in

+ parentheses, the name of the original author or publisher of that section

+ if known, or else a unique number. Make the same adjustment to the section

+ titles in the list of Invariant Sections in the license notice of the

+ combined work.

+ </simpara>

+ <simpara>

+ In the combination, you must combine any sections Entitled

+ “History” in the various original documents, forming one

+ section Entitled “History”; likewise combine any sections

+ Entitled “Acknowledgements”, and any sections Entitled

+ “Dedications”. You must delete all sections Entitled

+ “Endorsements”.

+ </simpara>

+ <bridgehead id="section6" renderas="sect2">

+ 6. COLLECTIONS OF DOCUMENTS

+ </bridgehead>

+ <simpara>

+ You may make a collection consisting of the Document and other documents

+ released under this License, and replace the individual copies of this

+ License in the various documents with a single copy that is included in

+ the collection, provided that you follow the rules of this License for

+ verbatim copying of each of the documents in all other respects.

+ </simpara>

+ <simpara>

+ You may extract a single document from such a collection, and distribute

+ it individually under this License, provided you insert a copy of this

+ License into the extracted document, and follow this License in all other

+ respects regarding verbatim copying of that document.

+ </simpara>

+ <bridgehead id="section7" renderas="sect2">

+ 7. AGGREGATION WITH INDEPENDENT WORKS

+ </bridgehead>

+ <simpara>

+ A compilation of the Document or its derivatives with other separate and

+ independent documents or works, in or on a volume of a storage or

+ distribution medium, is called an “aggregate” if the copyright

+ resulting from the compilation is not used to limit the legal rights of

+ the compilation’s users beyond what the individual works

+ permit. When the Document is included in an aggregate, this License does

+ not apply to the other works in the aggregate which are not themselves

+ derivative works of the Document.

+ </simpara>

+ <simpara>

+ If the Cover Text requirement of section 3 is applicable to these copies

+ of the Document, then if the Document is less than one half of the entire

+ aggregate, the Document’s Cover Texts may be placed on covers that

+ bracket the Document within the aggregate, or the electronic equivalent of

+ covers if the Document is in electronic form. Otherwise they must appear

+ on printed covers that bracket the whole aggregate.

+ </simpara>

+ <bridgehead id="section8" renderas="sect2">

+ 8. TRANSLATION

+ </bridgehead>

+ <simpara>

+ Translation is considered a kind of modification, so you may distribute

+ translations of the Document under the terms of section 4. Replacing

+ Invariant Sections with translations requires special permission from

+ their copyright holders, but you may include translations of some or all

+ Invariant Sections in addition to the original versions of these Invariant

+ Sections. You may include a translation of this License, and all the

+ license notices in the Document, and any Warranty Disclaimers, provided

+ that you also include the original English version of this License and the

+ original versions of those notices and disclaimers. In case of a

+ disagreement between the translation and the original version of this

+ License or a notice or disclaimer, the original version will prevail.

+ </simpara>

+ <simpara>

+ If a section in the Document is Entitled “Acknowledgements”,

+ “Dedications”, or “History”, the requirement

+ (section 4) to Preserve its Title (section 1) will typically require

+ changing the actual title.

+ </simpara>

+ <bridgehead id="section9" renderas="sect2">

+ 9. TERMINATION

+ </bridgehead>

+ <simpara>

+ You may not copy, modify, sublicense, or distribute the Document except as

+ expressly provided under this License. Any attempt otherwise to copy,

+ modify, sublicense, or distribute it is void, and will automatically

+ terminate your rights under this License.

+ </simpara>

+ <simpara>

+ However, if you cease all violation of this License, then your license

+ from a particular copyright holder is reinstated (a) provisionally, unless

+ and until the copyright holder explicitly and finally terminates your

+ license, and (b) permanently, if the copyright holder fails to notify you

+ of the violation by some reasonable means prior to 60 days after the

+ cessation.

+ </simpara>

+ <simpara>

+ Moreover, your license from a particular copyright holder is reinstated

+ permanently if the copyright holder notifies you of the violation by some

+ reasonable means, this is the first time you have received notice of

+ violation of this License (for any work) from that copyright holder, and

+ you cure the violation prior to 30 days after your receipt of the notice.

+ </simpara>

+ <simpara>

+ Termination of your rights under this section does not terminate the

+ licenses of parties who have received copies or rights from you under this

+ License. If your rights have been terminated and not permanently

+ reinstated, receipt of a copy of some or all of the same material does not

+ give you any rights to use it.

+ </simpara>

+ <bridgehead id="section10" renderas="sect2">

+ 10. FUTURE REVISIONS OF THIS LICENSE

+ </bridgehead>

+ <simpara>

+ The Free Software Foundation may publish new, revised versions of the GNU

+ Free Documentation License from time to time. Such new versions will be

+ similar in spirit to the present version, but may differ in detail to

+ address new problems or concerns. See

+ <ulink url="http://www.gnu.org/copyleft/">Copyleft</ulink>.

+ </simpara>

+ <simpara>

+ Each version of the License is given a distinguishing version number. If

+ the Document specifies that a particular numbered version of this License

+ “or any later version” applies to it, you have the option of

+ following the terms and conditions either of that specified version or of

+ any later version that has been published (not as a draft) by the Free

+ Software Foundation. If the Document does not specify a version number of

+ this License, you may choose any version ever published (not as a draft)

+ by the Free Software Foundation. If the Document specifies that a proxy

+ can decide which future versions of this License can be used, that

+ proxy’s public statement of acceptance of a version permanently

+ authorizes you to choose that version for the Document.

+ </simpara>

+ <bridgehead id="section11" renderas="sect2">

+ 11. RELICENSING

+ </bridgehead>

+ <simpara>

+ “Massive Multiauthor Collaboration Site” (or “MMC

+ Site”) means any World Wide Web server that publishes copyrightable

+ works and also provides prominent facilities for anybody to edit those

+ works. A public wiki that anybody can edit is an example of such a

+ server. A “Massive Multiauthor Collaboration” (or

+ “MMC”) contained in the site means any set of copyrightable

+ works thus published on the MMC site.

+ </simpara>

+ <simpara>

+ “CC-BY-SA” means the Creative Commons Attribution-Share Alike

+ 3.0 license published by Creative Commons Corporation, a not-for-profit

+ corporation with a principal place of business in San Francisco,

+ California, as well as future copyleft versions of that license published

+ by that same organization.

+ </simpara>

+ <simpara>

+ “Incorporate” means to publish or republish a Document, in

+ whole or in part, as part of another Document.

+ </simpara>

+ <simpara>

+ An MMC is “eligible for relicensing” if it is licensed under

+ this License, and if all works that were first published under this

+ License somewhere other than this MMC, and subsequently incorporated in

+ whole or in part into the MMC, (1) had no cover texts or invariant

+ sections, and (2) were thus incorporated prior to November 1, 2008.

+ </simpara>

+ <simpara>

+ The operator of an MMC Site may republish an MMC contained in the site

+ under CC-BY-SA on the same site at any time before August 1, 2009,

+ provided the MMC is eligible for relicensing.

+ </simpara>

+ <bridgehead id="addendum" renderas="sect2">

+ ADDENDUM: How to use this License for your documents

+ </bridgehead>

+ <simpara>

+ To use this License in a document you have written, include a copy of the

+ License in the document and put the following copyright and license

+ notices just after the title page:

+ </simpara>

+Permission is granted to copy, distribute and/or modify this document under the

+terms of the GNU Free Documentation License, Version 1.3 or any later version

+published by the Free Software Foundation; with no Invariant Sections, no

+Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in

+the section entitled “GNU Free Documentation License”.</screen>

+ <simpara>

+ If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,

+ replace the “with… Texts.” line with this:

+ </simpara>

+ <screen>with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts

+being LIST, and with the Back-Cover Texts being LIST.</screen>

+ <simpara>

+ If you have Invariant Sections without Cover Texts, or some other

+ combination of the three, merge those two alternatives to suit the

+ situation.

+ </simpara>

+ <simpara>

+ If your document contains nontrivial examples of program code, we

+ recommend releasing these examples in parallel under your choice of free

+ software license, such as the GNU General Public License, to permit their

+ use in free software.

+ </simpara>

+</appendix>

diff -rN -u old-doc/introduction.docbook new-doc/introduction.docbook

--- old-doc/introduction.docbook 2014-10-30 07:14:03.000000000 +0100

+++ new-doc/introduction.docbook 1970-01-01 01:00:00.000000000 +0100

@@ -1,76 +0,0 @@

-<?xml version="1.0"?>

-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

-<chapter id="introduction">

-<title>Introduction</title>

-<para>

- CL-Smoke provides CLOS bindings for the Qt and KDE libraries.

-</para>

-<section><title>Related</title>

-<itemizedlist>

- <listitem><para><ulink url="http://common-lisp.net/project/commonqt/">

- CommonQt</ulink> (No CLOS, no startup overhead)</para></listitem>

- <listitem><para><ulink url="http://sourceforge.net/projects/lisp-cffi-qt4">

- Lisp-CFFI-Qt4</ulink> (dead)</para></listitem>

-</itemizedlist>

-</section>

-<section><title>Limitations</title>

-<itemizedlist>

- <listitem><para>Bad multithreaded performance

- due to a lock for the global hash-tables.</para></listitem>

- <listitem><para>No C++ style argument conversion.</para></listitem>

- <listitem><para>No custom overloading methods by argument count.</para></listitem>

- <listitem><para>Limited conversions. E.g. <code>QList<T></code> is missing.

- </para></listitem>

- <listitem><para>10 seconds startup time (for <package>qt.examples</package>) on a

- Pentium M 1.7GHz. (Compilation ~20 seconds)</para></listitem>

- <listitem><para>Needs to be recompiled when the Smoke library is updated.</para></listitem>

- <listitem><para>Saving a core image is not supported.</para></listitem>

-</itemizedlist>

-</section>

-<section><title>Installation</title>

-<section><title>Dependencies</title>

-<itemizedlist>

- <listitem><para><ulink

- url="http://techbase.kde.org/Development/Languages/Smoke">Smoke2</ulink>

- bindings 4.2 or later</para></listitem>

- <listitem><para><ulink url="http://qtsoftware.com">Qt</ulink>

- (development package)</para></listitem>

- <listitem><para>

- <ulink url="http://cmake.org">CMake</ulink> 2.6

- </para></listitem>

- <listitem><para>a make program (preferably Gnu Make)</para></listitem>

- <listitem><para>a C++ compiler (GCC)</para></listitem>

-</itemizedlist>

-<para>

-On the Lisp side you need <ulink url="http://mudballs.com">mudballs</ulink>

-and <ulink url="http://tobias.rautenkranz.ch/lisp/sysdef.cmake">sysdef.cmake</ulink>.

-</para>

-</section>

-<section><title>Supported Platforms</title>

-<para>

- SBCL on Linux x86 in works; CMUCL and CLisp currently do not.

- It should be possible to get it to work (with SBCL) on

- other platforms. Contact me if you have any questions.

-</para>

-</section>

-<section><title>Installation</title>

-<para>

- You need to checkout the darcs repositories:

- <programlisting>

-cd <userinput>SOME_DIR</userinput>

-for r in smoke qt qt.test qt.tests qt.examples qt.uitools qt.webkit kde kde.tests kde.examples; do

- darcs get "http://tobias.rautenkranz.ch/lisp/cl-smoke/$r"

-done

- </programlisting>

- Then add the directory <userinput>SOME_DIR</userinput> to the mudballs search paths by adding

- <programlisting>

-(push (wildcard-searcher "<userinput>SOME_DIR</userinput>/*/*.mbd")

- *custom-search-modules*)

- </programlisting>

- to <filename>~/.mudballs</filename>.

-</para>

-</section>

-</chapter>

diff -rN -u old-doc/introduction.xml new-doc/introduction.xml

--- old-doc/introduction.xml 1970-01-01 01:00:00.000000000 +0100

+++ new-doc/introduction.xml 2014-10-30 07:14:03.000000000 +0100

@@ -0,0 +1,129 @@

+<?xml version="1.0"?>

+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

+<chapter id="introduction">

+<title>Introduction</title>

+<para>

+ CL-Smoke provides CLOS bindings for the Qt and KDE libraries.

+</para>

+<section><title>Related</title>

+<itemizedlist>

+ <listitem><para><ulink url="http://common-lisp.net/project/commonqt/">

+ CommonQt</ulink> (No CLOS, no startup overhead)</para></listitem>

+ <listitem><para><ulink url="http://sourceforge.net/projects/lisp-cffi-qt4">

+ Lisp-CFFI-Qt4</ulink> (dead)</para></listitem>

+</itemizedlist>

+</section>

+<section id="limitations"><title>Limitations</title>

+<itemizedlist>

+ <listitem><para>Ownership transfer to / from C++ of non QObject objects is seldom known to cl-smoke.

+ E.g.: cl-smoke might delete an instance even though it is still needed by C++.

+ (One that is known is <ulink url="http://doc.qtsoftware.com/4.5-snapshot/qundostack.html#push">QUndoStack::push()</ulink>.)

+ </para></listitem>

+ <listitem><para>Limited conversions to and from C++. You will get an NO-APPLICABLE-CXX-METHOD error

+ when a Lisp to C++ conversion is missing and a pointer will be returned when there is no C++ to Lisp

+ conversion.

+ </para></listitem>

+ <listitem><para>6 seconds startup time<footnote>

+ <para>

+ Using a core image it is around 1 second.

+ (see <xref linkend="core-image"/>)

+ </para></footnote>

+ (for <package>qt.examples</package>) on a

+ Pentium M 1.7GHz. </para></listitem>

+ <listitem><para>Needs to be recompiled when the Smoke library is updated.</para></listitem>

+ <listitem><para>Could be faster</para></listitem>

+</itemizedlist>

+<section><title>Performance</title>

+<para>

+Method calling is near 3000 times slower than native C++. The overhead is mainly in the overload

+resolution and to/from foreign object translation. Some measurements by

+<code><ulink url="http://tobias.rautenkranz.ch/darcsweb/darcsweb.cgi?r=cl-smoke/benchmark;a=summary">:cl-smoke.benchmark</ulink></code>

+are in

+<filename><ulink url="../benchmark.pdf">benchmark.pdf</ulink></filename>.

+</para>

+</section>

+<section id="installation"><title>Installation</title>

+<section><title>Dependencies</title>

+<itemizedlist>

+ <listitem><para><ulink

+ url="http://techbase.kde.org/Development/Languages/Smoke">Smoke2</ulink>

+ bindings from svn.

+ <footnote><para>

+ The new smokegenerator is needed (developed by Arno Rehn for the GSOC 09).

+ </para></footnote>

+ </para></listitem>

+ <listitem><para><ulink url="http://qtsoftware.com">Qt</ulink>

+ (development package)</para></listitem>

+ <listitem><para>

+ <ulink url="http://cmake.org">CMake</ulink> 2.6

+ </para></listitem>

+ <listitem><para>a C++ compiler (GCC)</para></listitem>

+</itemizedlist>

+<para>

+<itemizedlist>

+<listitem><para><ulink url="http://common-lisp.net/project/alexandria/">alexandria</ulink></para></listitem>

+<listitem><para><ulink url="http://common-lisp.net/project/bordeaux-threads/">bordeaux-threads</ulink></para></listitem>

+<listitem><para><ulink url="http://common-lisp.net/project/cffi/">cffi</ulink></para></listitem>

+<listitem><para><ulink url="http://common-lisp.net/project/closer/closer-mop.html">closer-mop</ulink></para></listitem>

+<listitem><para><ulink url="http://www.cliki.net/trivial-garbage">trivial-garbage</ulink></para></listitem>

+</itemizedlist>

+</para>

+</section>

+<section><title>Supported Platforms</title>

+<section><title>Working</title>

+ <itemizedlist>

+ <listitem><para>

+ <ulink url="http://www.sbcl.org">SBCL</ulink> on Linux x86 (and x86_64)

+ </para></listitem>

+ <listitem> <para>

+ <ulink url="http://trac.clozure.com/openmcl">Clozure CL</ulink> on Linux x86.

+ </para></listitem>

+ </itemizedlist>

+</section>

+<section><title>Not Working</title>

+ <itemizedlist>

+ <listitem><para>

+ <ulink url="http://www.cons.org/cmucl/">CMUCL</ulink>

+ </para></listitem>

+ <listitem><para>

+ <ulink url="http://clisp.cons.org/">CLISP</ulink>

+ </para></listitem>

+ </itemizedlist>

+</section>

+<section><title>Installation</title>

+<para>

+ You need to checkout the darcs repositories:

+ <programlisting>

+cd <userinput>SOME_DIR</userinput>

+for r in smoke qt.core qt.gui qt.network qt.test qt.tests qt.examples qt.uitools qt.webkit qt.phonon; do

+ darcs get "http://tobias.rautenkranz.ch/lisp/cl-smoke/$r"

+done

+ </programlisting>

+ <note>

+ <para>

+ There are also the following repositories: qt.svg qt.dbus kde.core kde.ui kde.tests kde.examples

+ </para>

+ </note>

+ </para>

+ <para>

+ Build and install the <package>:smoke</package> and <package>:qt.core</package> C wrapper libraries with:

+ <informalexample>

+ <programlisting>cmake ./ && make && sudo make install</programlisting>

+ </informalexample>

+ in the <filename>smoke/</filename> and <filename>qt/</filename> directories.

+ </para>

+ <para>

+ When you have symlinked the <filename>.asd</filename> system files, you

+ should be able to load the systems. The system name has a

+ <code>:cl-smoke.</code> prefix. e.g.:

+ <informalexample>

+ <programlisting language="lisp">(asdf:oos 'asdf:load-op :cl-smoke.qt.examples) </programlisting>

+ </informalexample>

+ </para>

+</section>

+</chapter>

diff -rN -u old-doc/kde.docbook new-doc/kde.docbook

--- old-doc/kde.docbook 2014-10-30 07:14:03.000000000 +0100

+++ new-doc/kde.docbook 1970-01-01 01:00:00.000000000 +0100

@@ -1,64 +0,0 @@

-<?xml version="1.0"?>

-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

-<chapter id="kde">

-<title>KDE</title>

-<para>

-Besiedes the <package>:kde</package> package there

-is <package>:kde.tests</package> for the unit tests and

-<package>:kde.examples</package> containing the examples.

-</para>

-<section><title>Examples</title>

-<para>

-The examples can be run with:

-<programlisting>

-(mb:load <package>:kde.examples</package>)

-</programlisting>

-An the running the function of the example; e.g.:

-<programlisting>

-(<methodname>kde.examples:mandelbrot</methodname>)

-</programlisting>

-</para>

-<example>

-<title>Hello World</title>

-<screenshot>

-<mediaobject>

-<imageobject>

- <imagedata fileref="kde.hello-world.png" format="PNG"/>

-</imageobject>

-</mediaobject>

-</screenshot>

-<programlisting language="lisp">

-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"

- href="../kde.examples/src/hello-world.lisp" parse="text" />

-</programlisting>

-</example>

-<example>

-<title>KMandelbrot</title>

-<screenshot>

-<mediaobject>

-<imageobject>

- <imagedata fileref="kmandelbrot.png" format="PNG"/>

-</imageobject>

-</mediaobject>

-</screenshot>

-<para>

- A port of the

- <ulink url="http://doc.trolltech.com/4.5/threads-mandelbrot.html">

- Qt Mandelbrot example</ulink> to KDE.

- <blockquote>

- <para>

-The Mandelbrot example shows how to use a worker thread to perform heavy computations without blocking the main thread's event loop.

- </para>

- </blockquote>

- The sources can be found in the

- <filename><ulink url="../kde.examples/src/mandelbrot/">src/mandelbrot/</ulink></filename>

- directory of the <package>:kde.examples</package> package

-</para>

-</example>

-</section>

-</chapter>

diff -rN -u old-doc/kde.xml new-doc/kde.xml

--- old-doc/kde.xml 1970-01-01 01:00:00.000000000 +0100

+++ new-doc/kde.xml 2014-10-30 07:14:03.000000000 +0100

@@ -0,0 +1,68 @@

+<?xml version="1.0"?>

+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

+<chapter id="kde">

+<title>KDE</title>

+<para>

+To use the KDE libraries use the <package>:cl-smoke.kde.ui</package>

+(Depends on <package>:cl-smoke.kde.core</package>).

+</para>

+<para>

+Besides these packages there

+is <package>:kde.tests</package> for the unit tests and

+<package>:kde.examples</package> containing the examples.

+</para>

+<section id="kde_examples"><title>Examples</title>

+<para>

+The examples can be run with:

+<programlisting language="lisp">

+(asdf:oos 'asdf:load-op <package>:cl-smoke.kde.examples</package>)

+</programlisting>

+And then running the function of the example; e.g.:

+<programlisting language="lisp">

+(<methodname>kde.examples:mandelbrot</methodname>)

+</programlisting>

+</para>

+<example>

+<title>Hello World</title>

+<screenshot>

+<mediaobject>

+<imageobject>

+ <imagedata fileref="kde.hello-world.png" format="PNG"/>

+</imageobject>

+</mediaobject>

+</screenshot>

+<programlisting language="lisp">

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"

+ href="../kde.examples/src/hello-world.lisp" parse="text" />

+</programlisting>

+</example>

+<example>

+<title>KMandelbrot</title>

+<screenshot>

+<mediaobject>

+<imageobject>

+ <imagedata fileref="kmandelbrot.png" format="PNG"/>

+</imageobject>

+</mediaobject>

+</screenshot>

+<para>

+ A port of the

+ <ulink url="http://doc.trolltech.com/4.5/threads-mandelbrot.html">

+ Qt Mandelbrot example</ulink> to KDE.

+ <blockquote>

+ <para>

+The Mandelbrot example shows how to use a worker thread to perform heavy computations without blocking the main thread's event loop.

+ </para>

+ </blockquote>

+ The sources can be found in the

+ <filename><ulink url="http://tobias.rautenkranz.ch/darcsweb/darcsweb.cgi?r=cl-smoke/kde.examples;a=tree;f=/src/mandelbrot">src/mandelbrot/</ulink></filename>

+ directory of the <package>:kde.examples</package> package

+</para>

+</example>

+</section>

+</chapter>

diff -rN -u old-doc/link-apidoc.xsl new-doc/link-apidoc.xsl

--- old-doc/link-apidoc.xsl 2014-10-30 07:14:03.000000000 +0100

+++ new-doc/link-apidoc.xsl 2014-10-30 07:14:03.000000000 +0100

@@ -1,4 +1,29 @@

<?xml version='1.0'?>

+<!--

+Permission is hereby granted, free of charge, to any person

+obtaining a copy of this software and associated documentation

+files (the "Software"), to deal in the Software without

+restriction, including without limitation the rights to use,

+copy, modify, merge, publish, distribute, sublicense, and/or sell

+copies of the Software, and to permit persons to whom the

+Software is furnished to do so, subject to the following

+conditions:

+The above copyright notice and this permission notice shall be

+included in all copies or substantial portions of the Software.

+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

+OTHER DEALINGS IN THE SOFTWARE.

+!-->

<xsl:stylesheet version="1.0"

xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

diff -rN -u old-doc/lisp-hl.xml new-doc/lisp-hl.xml

--- old-doc/lisp-hl.xml 1970-01-01 01:00:00.000000000 +0100

+++ new-doc/lisp-hl.xml 2014-10-30 07:14:03.000000000 +0100

@@ -0,0 +1,167 @@

+<?xml version="1.0" encoding="UTF-8"?>

+

+<highlighters>

+ <highlighter type="word">

+ <word>call-next-method</word>

+ <word>do-external-symbols</word>

+ <word>do</word>

+ <word>do*</word>

+ <word>eval-when</word>

+ <word>handler-bind</word>

+ <word>handler-case</word>

+ <word>in-package</word>

+ <word>let*</word>

+ <word>multiple-value-bind</word>

+ <word>restart-bind</word>

+ <word>restart-case</word>

+ <word>return-from</word>

+ <word>signal</word>

+ <word>unwind-protect</word>

+ <style>keyword</style>

+ <ignoreCase />

+ </highlighter>

+ <highlighter type="keywords">

+ <keyword>assert</keyword>

+ <keyword>block</keyword>

+ <keyword>case</keyword>

+ <keyword>catch</keyword>

+ <keyword>ccase</keyword>

+ <keyword>cerror</keyword>

+ <keyword>check-type</keyword>

+ <keyword>declaim</keyword>

+ <keyword>declare</keyword>

+ <keyword>defclass</keyword>

+ <keyword>defconstant</keyword>

+ <keyword>defgeneric</keyword>

+ <keyword>define-condition</keyword>

+ <keyword>defmacro</keyword>

+ <keyword>defmethod</keyword>

+ <keyword>defpackage</keyword>

+ <keyword>defparameter</keyword>

+ <keyword>defstruct</keyword>

+ <keyword>deftype</keyword>

+ <keyword>defun</keyword>

+ <keyword>defvar</keyword>

+ <keyword>dolist</keyword>

+ <keyword>dotimes</keyword>

+ <keyword>ecase</keyword>

+ <keyword>error</keyword>

+ <keyword>flet</keyword>

+ <keyword>go</keyword>

+ <keyword>if</keyword>

+ <keyword>labels</keyword>

+ <keyword>lambda</keyword>

+ <keyword>let</keyword>

+ <keyword>loop</keyword>

+ <keyword>proclaim</keyword>

+ <keyword>prog1</keyword>

+ <keyword>prog2</keyword>

+ <keyword>progn</keyword>

+ <keyword>progv</keyword>

+ <keyword>return</keyword>

+ <keyword>tagbody</keyword>

+ <keyword>throw</keyword>

+ <keyword>typecase</keyword>

+ <keyword>unless</keyword>

+ <keyword>warn</keyword>

+ <keyword>when</keyword>

+ <ignoreCase />

+ </highlighter>

+

+ <highlighter type="regex">

+ <pattern>(?<=\()(\S+[:])?(with-\S+)</pattern>

+ <style>keyword</style>

+ </highlighter>

+

+ <highlighter type="multiline-comment">

+ <start>#|</start>

+ <end>|#</end>

+ <style>comment</style>

+ </highlighter>

+ <highlighter type="oneline-comment">

+ ;

+ </highlighter>

+

+ <highlighter type="string">

+ <string>"</string>

+ <spanNewLines/>

+ </highlighter>

+

+ <highlighter type="regex">

+ <pattern>(?<=[ $])(:[^\s$]+)</pattern>

+ <style>attribute</style>

+ </highlighter>

+

+ <highlighter type="word">

+ <word>&allow-other-keys</word>

+ <word>&aux</word>

+ <word>&body</word>

+ <word>&environment</word>

+ <word>&key</word>

+ <word>&optional</word>

+ <word>&rest</word>

+ <word>&whole</word>

+ <style>attribute</style>

+ <ignoreCase />

+ </highlighter>

+

+

+ <highlighter type="regex">

+ <pattern>(?<=defclass\s)(\S+)</pattern>

+ <style>directive</style>

+ <flags>CASE_INSENSITIVE</flags>

+ </highlighter>

+

+ <highlighter type="regex">

+ <pattern>(?<=defun\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+

+ <highlighter type="regex">

+ <pattern>(?<=defmacro\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+

+ <highlighter type="regex">

+ <pattern>(?<=defgeneric\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+

+ <highlighter type="regex">

+ <pattern>(?<=defmethod\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+

+ <highlighter type="regex">

+ <pattern>(?<=defvar\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+

+ <highlighter type="regex">

+ <pattern>(?<=defparameter\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+

+ <highlighter type="regex">

+ <pattern>(?<=defconstant\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+

+ <highlighter type="regex">

+ <pattern>(?<=defstruct\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+

+ <highlighter type="regex">

+ <pattern>(?<=define-condition\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+</highlighters>

diff -rN -u old-doc/manual.docbook new-doc/manual.docbook

--- old-doc/manual.docbook 2014-10-30 07:14:03.000000000 +0100

+++ new-doc/manual.docbook 1970-01-01 01:00:00.000000000 +0100

@@ -1,38 +0,0 @@

-<?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" [

- <!ENTITY % link-api SYSTEM "link-api.dtd">

- %link-api;

- ]>

-<book id="cl-smoke" lang="en">

-<bookinfo>

-<title>CL-Smoke</title>

-<authorgroup>

-<author>

-<firstname>Tobias</firstname>

-<surname>Rautenkranz</surname>

-<email>mail #\@ tobias #\. rautenkranz #\. ch</email>

-</author>

-</authorgroup>

-<copyright>

-<year>2009</year>

-<holder>Tobias Rautenkranz</holder>

-</copyright>

-<legalnotice><para>FDL</para></legalnotice>

-<date>2009-03-25</date>

-<releaseinfo>0.0.1</releaseinfo>

-<abstract>

-<para>

-Common Lisp bindings for Qt and KDE using Smoke.

-</para>

-</abstract>

-</bookinfo>

-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="introduction.docbook" />

-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="smoke.docbook" />

-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="qt.docbook" />

-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="kde.docbook" />

-</book>

diff -rN -u old-doc/manual.xml new-doc/manual.xml

--- old-doc/manual.xml 1970-01-01 01:00:00.000000000 +0100

+++ new-doc/manual.xml 2014-10-30 07:14:03.000000000 +0100

@@ -0,0 +1,47 @@

+<?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" [

+ <!ENTITY % link-api SYSTEM "link-api.dtd">

+ %link-api;

+ ]>

+<book id="cl-smoke" lang="en">

+<bookinfo>

+<title>CL-Smoke</title>

+<authorgroup>

+<author>

+<firstname>Tobias</firstname>

+<surname>Rautenkranz</surname>

+<email>mail #\@ tobias #\. rautenkranz #\. ch</email>

+</author>

+</authorgroup>

+<copyright>

+<year>2009</year>

+<holder>Tobias Rautenkranz</holder>

+</copyright>

+<legalnotice><para>

+Permission is granted to copy, distribute and/or modify this document

+under the terms of the GNU Free Documentation License, Version 1.3

+or any later version published by the Free Software Foundation;

+with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.

+A copy of the license is included in the section entitled "GNU

+Free Documentation License".

+</para></legalnotice>

+<date>2009-03-25</date>

+<releaseinfo>0.0.1</releaseinfo>

+<abstract>

+<para>

+Common Lisp bindings for Qt and KDE using Smoke.

+</para>

+</abstract>

+</bookinfo>

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="introduction.xml" />

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="smoke.xml" />

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="qt.xml" />

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="kde.xml" />

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="fdl-1.3.xml" />

+</book>

diff -rN -u old-doc/manual.xsl new-doc/manual.xsl

--- old-doc/manual.xsl 2014-10-30 07:14:03.000000000 +0100

+++ new-doc/manual.xsl 2014-10-30 07:14:03.000000000 +0100

@@ -2,7 +2,13 @@

<xsl:stylesheet version="1.0"

xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

-<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.xsl"/>

-<xsl:import href="link-apidoc.xsl"/>

+<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/html/docbook.xsl"/>

+<xsl:import href="nonlink-apidoc.xsl"/>

+<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/html/highlight.xsl"/>

+<xsl:import href="video.xsl" />

+<xsl:param name="highlight.source" select="1"/>

</xsl:stylesheet>

diff -rN -u old-doc/nonlink-apidoc.xsl new-doc/nonlink-apidoc.xsl

--- old-doc/nonlink-apidoc.xsl 1970-01-01 01:00:00.000000000 +0100

+++ new-doc/nonlink-apidoc.xsl 2014-10-30 07:14:03.000000000 +0100

@@ -0,0 +1,41 @@

+<?xml version='1.0'?>

+<!--

+Permission is hereby granted, free of charge, to any person

+obtaining a copy of this software and associated documentation

+files (the "Software"), to deal in the Software without

+restriction, including without limitation the rights to use,

+copy, modify, merge, publish, distribute, sublicense, and/or sell

+copies of the Software, and to permit persons to whom the

+Software is furnished to do so, subject to the following

+conditions:

+The above copyright notice and this permission notice shall be

+included in all copies or substantial portions of the Software.

+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

+OTHER DEALINGS IN THE SOFTWARE.

+!-->

+<xsl:stylesheet version="1.0"

+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

+<xsl:template match="macro">

+ <xsl:call-template name="ulink">

+ </xsl:call-template>

+</xsl:template>

+<xsl:template match="genericfunction">

+ <xsl:call-template name="ulink">

+ </xsl:call-template>

+</xsl:template>

+</xsl:stylesheet>

Binary files old-doc/origami.ogg and new-doc/origami.ogg differ

Binary files old-doc/origami.png and new-doc/origami.png differ

diff -rN -u old-doc/qt.docbook new-doc/qt.docbook

--- old-doc/qt.docbook 2014-10-30 07:14:03.000000000 +0100

+++ new-doc/qt.docbook 1970-01-01 01:00:00.000000000 +0100

@@ -1,174 +0,0 @@

-<?xml version="1.0"?>

-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

-<chapter id="qt">

-<title>Qt</title>

-<para>

-Besieds the <package>:qt</package> there are these packages: with

-<itemizedlist>

- <listitem><para>

- <package>:qt.uitools</package>

- <ulink url="http://doc.trolltech.com/4.5/qtuitools.html">

- QtUiTools</ulink></para></listitem>

- <listitem><para><package>:qt.test</package>

- <ulink url="http://doc.trolltech.com/4.5/qttest.html">

- QtTest</ulink></para></listitem>

- <listitem><para><package>:qt.webkit</package>

- <ulink url="http://doc.trolltech.com/4.5/qtwebkit.html">

- QtWebKit</ulink>

- </para></listitem>

-</itemizedlist>

-which provied bindings for their Qt module.

-Additionally there is the <package>:qt.tests</package> system, containing

-the unit tests and <package>:qt.examples</package> for various examples.

-</para>

-<section><title>QApplication</title>

-<para>

-The <classname>qt:application</classname> object should created with:

-<macro>qt:with-app</macro>. In its body the event loop can be

-started with <methodname>qt:exec</methodname>.

-</para>

-<example>

-<title>Hello World</title>

-<screenshot>

-<mediaobject>

-<imageobject>

- <imagedata fileref="hello-world.png" format="PNG"/>

-</imageobject>

-</mediaobject>

-</screenshot>

-<programlisting language="lisp">

-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../qt.examples/src/hello-world.lisp" parse="text" />

-</programlisting>

-</example>

-</section>

-<section><title>Signal-Slot</title>

-<para>

-<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>.

-The slot can be a slot returned by <classname>qt:make-slot</classname>, a function

-or a C++ slot a return from <methodname>qt:get-slot</methodname>.

-</para>

-<example><title>Quit</title>

-<programlisting>

-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../qt.examples/src/hello-world-quit.lisp" parse="text" />

-</programlisting>

-</example>

-<para>

-When the argument types for a slot or signal are not specified they are determined when

-the first connection is made. Note that when connecting a <classname>qt:qsignal</classname>

-to a <classname>qt:qslot</classname> at least one must have its arguments types specified.

-</para>

-<para>

-The functionality of the Qt <code>SIGNAL</code> and <code>SLOT</code> macros is

-provided by <methodname>qt:qsignal</methodname> and <methodname>qt:qslot</methodname>.

-</para>

-</section>

-<section><title>Properties</title>

-<para>

-<classname>qt:object</classname> properties can be accessed with

-<methodname>qt:property</methodname> (setf-able).

-The name of the property can be either a string in C++ style or a symbol in Lisp style.

-</para>

-<informalexample>

-<programlisting>

-(let ((object (make-instance '<classname>qt:object</classname>)))

- (setf (<methodname>qt:property</methodname> object 'object-name) "Foo")

- (assert (string= "Foo" (<methodname>qt:property</methodname> object "objectName"))))

-</programlisting>

-</informalexample>

-</section>

-<section><title>i18n</title>

-<para>

-You can use <methodname>qt:tr</methodname> to translate strings.

-</para>

-<example>

-<title>i18n Hello World</title>

-<screenshot>

-<mediaobject>

-<imageobject>

- <imagedata fileref="i18n-hello-world.png" format="PNG"/>

-</imageobject>

-</mediaobject>

-</screenshot>

-<programlisting language="po">

-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"

-href="../qt.examples/src/i18n-hello-world.lisp" parse="text" />

-</programlisting>

-<formalpara>

-<title><filename>hello-world_de.po</filename></title>

-<para>

-<programlisting language="po">

-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../qt.examples/src/hello-world_de.po" parse="text" />

-</programlisting>

-</para>

-</formalpara>

-</example>

-<para>

-Gettext is used to extract the i18n strings and compile the message catalog.

-See <filename><ulink url="../qt.examples/src/CMakeLists.txt">CMakeLists.txt</ulink></filename>

-and <filename><ulink url="../qt.examples/src/UseClQti18n.cmake">UseClQti18n.cmake</ulink></filename>

-in the <filename class="directory">src</filename> directory of <package>:qt.examples</package> how to do this.

-</para>

-</section>

-<section><title>Examples</title>

-<para>

-You can run the examples with:

-<programlisting>

-(mb:load <package>:qt.examples</package>)

-(<methodname>qt.examples:launcher</methodname>)

-</programlisting>

-</para>

-<example>

-<title>Repl</title>

-<para>

-Use a <classname>qt:string-list-model</classname> with a <classname>qt:list-view</classname>

-to show evaluated lisp expressions.

-</para>

-<screenshot>

-<mediaobject>

-<imageobject>

- <imagedata fileref="repl.png" format="PNG"/>

-</imageobject>

-</mediaobject>

-</screenshot>

-<programlisting language="lisp">

-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../qt.examples/src/repl.lisp" parse="text" />

-</programlisting>

-</example>

-<example>

-<title>Class Browser</title>

-<para>Qt Classes browser using <package>:qt.webkit</package> to display the

-API doc and a custom <classname>qt:list-model</classname>

-for the <classname>qt:list-view</classname> of the available classes.

-</para>

-<screenshot>

-<mediaobject>

-<imageobject>

- <imagedata fileref="class-browser.png" format="PNG"/>

-</imageobject>

-</mediaobject>

-</screenshot>

-<programlisting language="lisp">

-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../qt.examples/src/class-browser.lisp" parse="text" />

-</programlisting>

-</example>

-</section>

-</chapter>

diff -rN -u old-doc/qt.xml new-doc/qt.xml

--- old-doc/qt.xml 1970-01-01 01:00:00.000000000 +0100

+++ new-doc/qt.xml 2014-10-30 07:14:03.000000000 +0100

@@ -0,0 +1,248 @@

+<?xml version="1.0"?>

+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

+<chapter id="qt">

+<title>Qt</title>

+<para>

+Besides the <package>:cl-smoke.qt.gui</package> there are these modules:

+<itemizedlist>

+ <listitem><para>

+ <package>:cl-smoke.qt.uitools</package>

+ <ulink url="http://doc.trolltech.com/4.5/qtuitools.html">

+ QtUiTools</ulink></para></listitem>

+ <listitem><para><package>:cl-smoke.qt.test</package>

+ <ulink url="http://doc.trolltech.com/4.5/qttest.html">

+ QtTest</ulink></para></listitem>

+ <listitem><para><package>:cl-smoke.qt.webkit</package>

+ <ulink url="http://doc.trolltech.com/4.5/qtwebkit.html">

+ QtWebKit</ulink>

+ </para></listitem>

+ <listitem><para><package>:cl-smoke.qt.phonon</package>

+ <ulink url="http://doc.trolltech.com/4.5/phonon.html">

+ Phonon</ulink>

+ </para></listitem>

+ <listitem><para><package>:cl-smoke.qt.network</package>

+ The network classes of Qt.

+ </para></listitem>

+ <listitem><para><package>:cl-smoke.qt.core</package>

+ the nogui Qt core.

+ </para></listitem>

+</itemizedlist>

+which provide bindings for their Qt module. The class names of this modules are in

+the <package>:qt</package> package. (E.g. Phonon::VideoPlayer is <code>'qt:phonon.video-player</code>

+and QTest is <code>'qt:test</code>)

+</para>

+<para>

+Additionally there is the <package>:cl-smoke.qt.tests</package> system, containing

+the unit tests and <package>:cl-smoke.qt.examples</package> for various examples.

+</para>

+<section id="qapplication"><title>qt:application</title>

+<para>

+The <classname>qt:application</classname> object should created with:

+<macro>qt:with-app</macro>. In its body the event loop can be

+started with <methodname>qt:exec</methodname>.

+</para>

+<example>

+<title>Hello World</title>

+<screenshot>

+<mediaobject>

+<imageobject>

+ <imagedata fileref="hello-world.png" format="PNG"/>

+</imageobject>

+</mediaobject>

+</screenshot>

+<programlisting language="lisp">

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../qt.examples/src/hello-world.lisp" parse="text" />

+</programlisting>

+</example>

+<para>

+Subclasses of <classname>qt:paint-device</classname> (e.g. <classname>qt:widget</classname>) can only be used when

+a <classname>qt:application</classname> instance exists. When there are, for example, <classname>qt:widget</classname> instances

+at the end of <macro>qt:with-app</macro>, they are deleted by the <classname>qt:application</classname> destructor.

+</para>

+<para>

+Custom <methodname>cxx:paint-event</methodname> methods can use <macro>qt:with-painter</macro>

+to ensure that the <classname>qt:painter</classname> is deactivated at the end of the method.

+</para>

+<section><title>Interactive Development</title>

+<para>

+The <package>:cl-smoke.repl</package> allows you to start a <classname>qt:application</classname> event loop in the background for

+interactive development in SLIME.

+To start the event loop use <methodname>cl-smoke.repl:start-event-loop-in-background</methodname> (or

+<methodname>cl-smoke.repl:start-event-loop-in-repl</methodname>).

+<footnote>

+<para>

+Currently <code>START-EVENT-LOOP-IN-BACKGROUND</code> is recommended.

+</para>

+</footnote>

+As long as you do not kill the thread or unwind over a foreign function, you should be fine.

+</para>

+</section>

+<section id="signal_slot"><title>Signal-Slot</title>

+<para>

+<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>.

+The slot can be a slot returned by <classname>qt:make-slot</classname>, a function

+or a C++ slot a return from <methodname>qt:get-slot</methodname>.

+</para>

+<example><title>Quit</title>

+<programlisting language="lisp">

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../qt.examples/src/hello-world-quit.lisp" parse="text" />

+</programlisting>

+</example>

+<para>

+When the argument types for a slot or signal are not specified they are determined when

+the first connection is made. Note that when connecting a <classname>qt:qsignal</classname>

+to a <classname>qt:qslot</classname> at least one must have its arguments types specified. Type specifier <code>T</code>

+allows to pass a Lisp object as is from a Lisp signal to a Lisp slot.

+</para>

+<para>

+The functionality of the Qt <code>SIGNAL</code> and <code>SLOT</code> macros is

+provided by <methodname>qt:qsignal</methodname> and <methodname>qt:qslot</methodname>.

+</para>

+</section>

+<section id="properties"><title>Properties</title>

+<para>

+<classname>qt:object</classname> properties can be accessed with

+<methodname>qt:property</methodname> (setf-able).

+The name of the property can be either a string in C++ style or a symbol in Lisp style.

+The predefined Qt properties can be accessed with symbols in the keyword package.

+</para>

+<informalexample>

+<programlisting language="lisp">

+(let ((object (make-instance '<classname>qt:object</classname>)))

+ (setf (<methodname>qt:property</methodname> object :object-name) "Foo")

+ (assert (string= "Foo" (<methodname>qt:property</methodname> object "objectName"))))

+</programlisting>

+</informalexample>

+</section>

+<section id="variant"><title>Variant</title>

+<para>

+A <classname>qt:variant</classname> can be constructed with <methodname>qt:make-variant</methodname>

+or to pass a Lisp object with <methodname>qt:make-lisp-variant</methodname>.

+Its value is returned by <genericfunction>qt:value</genericfunction>.

+</para>

+</section>

+<section id="i18n"><title>i18n</title>

+<para>

+You can use <methodname>qt:tr</methodname> to translate strings.

+</para>

+<example>

+<title>i18n Hello World</title>

+<screenshot>

+<mediaobject>

+<imageobject>

+ <imagedata fileref="i18n-hello-world.png" format="PNG"/>

+</imageobject>

+</mediaobject>

+</screenshot>

+<programlisting language="lisp">

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"

+href="../qt.examples/src/i18n-hello-world.lisp" parse="text" />

+</programlisting>

+<formalpara>

+<title><filename>hello-world_de.po</filename></title>

+<para>

+<programlisting language="po">

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../qt.examples/src/hello-world_de.po" parse="text" />

+</programlisting>

+</para>

+</formalpara>

+</example>

+<para>

+Gettext is used to extract the i18n strings and compile the message catalog.

+See <filename><ulink url="../qt.examples/src/CMakeLists.txt">CMakeLists.txt</ulink></filename>

+and <filename><ulink url="../qt.examples/src/UseClQti18n.cmake">UseClQti18n.cmake</ulink></filename>

+in the <filename class="directory">src/</filename> directory of <package>:cl-smoke.qt.examples</package> on how to do this.

+</para>

+</section>

+<section id="qt_examples"><title>Examples</title>

+<para>

+You can run the examples with:

+<programlisting language="lisp">

+(asdf:oos 'asdf:load-op <package>:cl-smoke.qt.examples</package>)

+(<methodname>qt.examples:launcher</methodname>)

+</programlisting>

+</para>

+<example>

+<title>Repl</title>

+<para>

+Use a <classname>qt:string-list-model</classname> with a <classname>qt:list-view</classname>

+to show evaluated lisp expressions.

+</para>

+<screenshot>

+<mediaobject>

+<imageobject>

+ <imagedata fileref="repl.png" format="PNG"/>

+</imageobject>

+</mediaobject>

+</screenshot>

+<programlisting language="lisp">

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../qt.examples/src/repl.lisp" parse="text" />

+</programlisting>

+</example>

+<example>

+<title>Class Browser</title>

+<para>Qt Classes browser using <package>:cl-smoke.qt.webkit</package> to display the

+API doc and a custom <classname>qt:list-model</classname>

+for the <classname>qt:list-view</classname> of the available classes.

+</para>

+<screenshot>

+<mediaobject>

+<imageobject>

+ <imagedata fileref="class-browser.png" format="PNG"/>

+</imageobject>

+</mediaobject>

+</screenshot>

+<programlisting language="lisp">

+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../qt.examples/src/class-browser.lisp" parse="text" />

+</programlisting>

+</example>

+</section>

+<section id="opengl"><title>OpenGL</title>

+<para>

+For OpenGL a binding is needed (e.g.:

+<ulink url="http://common-lisp.net/project/cl-opengl/">cl-opengl</ulink>).

+</para>

+<example><title>Origami</title>

+<para>

+<ulink url="http://tobias.rautenkranz.ch/darcsweb/darcsweb.cgi?r=cl-smoke/qt.examples;a=tree;f=/src/origami">Origami</ulink>

+draws a pleated hyperbolic paraboloid using the method described in

+<ulink url="http://arxiv.org/abs/0906.4747">(Non)existence of Pleated Folds: How Paper Folds Between Creases</ulink>

+</para>

+<mediaobject>

+<videoobject>

+<videodata fileref='origami.ogg'/>

+</videoobject>

+</mediaobject>

+<para>

+<note>

+<para>

+<ulink url="http://axiom-wiki.newsynthesis.org/FrontPage">Axiom</ulink> is needed to generate the lisp source to that

+calculates the vertices.

+</para>

+</note>

+</para>

+</example>

+</section>

+</chapter>

diff -rN -u old-doc/smoke.docbook new-doc/smoke.docbook

--- old-doc/smoke.docbook 2014-10-30 07:14:03.000000000 +0100

+++ new-doc/smoke.docbook 1970-01-01 01:00:00.000000000 +0100

@@ -1,101 +0,0 @@

-<?xml version="1.0"?>

-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

-<chapter id="smoke">

-<title>Usage</title>

-<para></para>

-<section><title>Symbols</title>

-<para>

-C++ names are converted to Lisp symbols by converting <code>camelCase</code>

-to <code>camel-case</code>. Underscores <code>#\_</code> are replaced with

-<code>#\-</code> and a leading uppercase K or Q is removed.

-</para>

-<para>

-E.g.: <code>QHelloWorld_foo</code> becomes <code>hello-world-foo</code>.

-</para>

-</section>

-<section><title>Class</title>

-<para>

-C++ classes have a corresponding CLOS class. The can be used like any CLOS class; E.g:

-to make a <code>QObject</code> instance:

-<informalexample>

-<programlisting>

-(make-instance '<classname>qt:object</classname>)

-</programlisting>

-</informalexample>

-Suppy arguments as list to the <code>:args</code> keyword:

-<informalexample>

-<programlisting>

-(let ((parent (make-instance '<classname>qt:object</classname>)))

- (make-instance '<classname>qt:object</classname> :args (list parent)))

-</programlisting>

-</informalexample>

-</para>

-<para>

-To extend a C++ class you have to use <classname>cxx:class</classname> as metaclass:

-<informalexample>

-<programlisting>

-(defclass my-object (<classname>qt:object</classname>)

- ()

- (:metaclass <classname>cxx:class</classname>))

-</programlisting>

-</informalexample>

-</para>

-</section>

-<section><title>Methods</title>

-<para>

-The C++ methods are generic functions in the <code>:cxx</code> package.

-Their lambda list is: <code>(object &rest args)</code>.

-</para>

-<para>

-The C++ method call: <code>myInstance->frob(1);</code> is in Lisp:

-<informalexample>

-<programlisting>(frob my-instance 1)</programlisting>

-</informalexample>

-</para>

-<para>

-You can extend the <package>:cxx</package> generic functions by

-adding methods. <code>:around</code>, <code>:before</code>, <code>:after</code>

-and <code>(call-next-method)</code> are supported.

-</para>

-</section>

-<section><title>Static Methods</title>

-<para>

-The static C++ method <code>QByteArray::number(int n, int base=10)</code>

-can be called by:

-<informalexample>

-<programlisting>(<methodname>qt:byte-array.number</methodname> 37)</programlisting>

-</informalexample>

-which is equivalent to the C++ code <code>QByteArray::number(37);</code>.

-Or with:

-<informalexample>

-<programlisting>(cxx:number (find-class '<classname>qt:byte-array</classname>) 37)</programlisting>

-</informalexample>

-</para>

-</section>

-<section><title>Constants</title>

-<para>

- C++ Class enums available as constants. E.g.:

- <code>QColor::Rgb</code> is <constant>qt:color.+rgb+</constant>.

- See <package>:cxx-support</package>.

-</para>

-</section>

-<section><title>Garbage Collection</title>

-<para>

-You should be able to use C++ Class instances like normal Lisp object.

-</para>

-<para>

-C++ classes are automaticly deleted when their lisp object gets garbage collected;

-except when they (QObjects) have a parent and thus the parent is responsible for

-their deletion. When a <classname>qt:object</classname> has a parent, a strong

-reference is kept to prevent its garbage collection until the parent is deleted.

-</para>

-</section>

-</chapter>

diff -rN -u old-doc/smoke.xml new-doc/smoke.xml

--- old-doc/smoke.xml 1970-01-01 01:00:00.000000000 +0100

+++ new-doc/smoke.xml 2014-10-30 07:14:03.000000000 +0100

@@ -0,0 +1,294 @@

+<?xml version="1.0"?>

+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

+<chapter id="usage">

+<title>Usage</title>

+<para></para>

+<section><title>Symbols</title>

+<para>

+C++ names are converted to Lisp symbols by converting <code>camelCase</code>

+to <code>camel-case</code>. Underscores <code>#\_</code> are replaced with

+<code>#\-</code> and a leading uppercase K or Q is removed.

+</para>

+<informalexample>

+<para>

+E.g.: <code>QHelloWorld_foo</code> becomes <code>hello-world-foo</code>.

+</para>

+</informalexample>

+</section>

+<section id="classes"><title>Class</title>

+<para>

+C++ classes have a corresponding CLOS class. The can be used like any CLOS class; E.g:

+to make a <code>QObject</code> instance:

+<informalexample>

+<programlisting language="lisp">

+(make-instance '<classname>qt:object</classname>)

+</programlisting>

+</informalexample>

+Supply arguments as list to the <code>:args</code> keyword:

+<informalexample>

+<programlisting language="lisp">

+(let ((parent (make-instance '<classname>qt:object</classname>)))

+ (make-instance '<classname>qt:object</classname> :args (list parent)))

+</programlisting>

+</informalexample>

+or use <code>:arg0</code>, <code>:arg1</code> and <code>:arg2</code>.

+<informalexample>

+<programlisting language="lisp">

+(let ((parent (make-instance '<classname>qt:object</classname>)))

+ (make-instance '<classname>qt:object</classname> :arg0 parent))

+</programlisting>

+</informalexample>

+</para>

+<para>

+To extend a C++ class you have to use <classname>cxx:class</classname> as metaclass:

+<informalexample>

+<programlisting language="lisp">

+(defclass my-object (<classname>qt:object</classname>)

+ ()

+ (:metaclass <classname>cxx:class</classname>))

+(make-instance 'my-object)

+</programlisting>

+</informalexample>

+The first superclass must be a Smoke class. When you define a class that has several Smoke superclasses,

+they will be constructed with their default constructor. For the first Smoke superclass you can supply arguments

+with the <code>:args</code> and <code>:arg0</code> etc. keywords.

+<informalexample>

+<programlisting language="lisp">

+(defclass my-graphics-object (<classname>qt:object</classname> <classname>qt:graphics-item</classname>)

+ ()

+ (:metaclass <classname>cxx:class</classname>))

+</programlisting>

+</informalexample>

+</para>

+</section>

+<section id="methods"><title>Methods</title>

+<para>

+C++ methods are generic functions in the <package>:cxx</package> package.

+</para>

+<para>

+The C++ method call: <code>myInstance->frob(1);</code> is in Lisp:

+<informalexample>

+<programlisting language="lisp">(frob my-instance 1)</programlisting>

+</informalexample>

+</para>

+<section><title>Overload Resolution</title>

+<para>

+C++ style overload resolution with conversion sequences is supported. For example this:

+<informalexample>

+<programlisting language="lisp">

+(<genericfunction>cxx:set-pen</genericfunction> (make-instance '<classname>qt:painter</classname>) (make-instance '<classname>qt:color</classname> :args '("green")))

+</programlisting>

+</informalexample>

+is equivalent to:

+<informalexample>

+<programlisting language="lisp">

+(<genericfunction>cxx:set-pen</genericfunction> (make-instance '<classname>qt:painter</classname>) "green")

+</programlisting>

+</informalexample>

+In the second case a temporary <classname>qt:color</classname> instance is implicitly created.

+</para>

+</section>

+<section><title>Setter Methods</title>

+<para>

+Instead of calling a setter method that takes no additional arguments,

+<informalexample>

+<programlisting language="lisp">

+(<genericfunction>cxx:set-object-name</genericfunction> (make-instance '<classname>qt:object</classname>) "foo")

+</programlisting>

+</informalexample>

+you can use its <code>setf</code>able getter.

+<informalexample>

+<programlisting language="lisp">

+(setf (<genericfunction>cxx:object-name</genericfunction> (make-instance '<classname>qt:object</classname>)) "foo")

+</programlisting>

+</informalexample>

+</para>

+</section>

+<section><title><code>defmethod</code></title>

+<para>

+You can extend the <package>:cxx</package> generic functions by

+adding methods. <code>:around</code>, <code>:before</code>, <code>:after</code>

+and <code>(call-next-method)</code> are supported.

+</para>

+<informalexample>

+<programlisting language="lisp">(defclass the-object-does-nothing (<classname>qt:object</classname>)

+ ()

+ (:metaclass <classname>cxx:class</classname>))

+(defmethod <genericfunction>cxx:timer-event</genericfunction> ((object the-object-does-nothing) event)

+ (declare (ignore object event))

+ (call-next-method))

+</programlisting>

+</informalexample>

+<para>

+<package>:cxx</package> generic functions can be overload by argument count. Lambda list

+keywords (e.g.: <code>&rest</code> and <code>&key</code>) are not supported.

+</para>

+<note><para>

+Make sure you have the right number of arguments when adding a method; otherwise it will

+not be called.

+</para></note>

+<caution><para>

+The arguments of the method might have dynamic extend; i.e.: they are only valid in the body of the method.

+</para></caution>

+<section><title>Condition</title>

+<para>

+Unwinding of the C++ stack is not supported. This means that you must not invoke a restart that skips any foreign function.

+You will most likely encounter this problem when an error is signaled in a virtual method you have overwritten.

+<footnote>

+<para>

+For example an event handler that is called from the C++ library.

+</para>

+</footnote>. For this case restarts are provide that allow to return a value for the failed method,

+call the default C++ implementation instead (something like <code>#'call-next-method</code>) or retry.

+</para>

+</section>

+<section><title>Operators</title>

+<para>

+Instead of using the various <code>cxx:operator</code> methods you can use their Lisp equivalent

+in the <package>:cxx</package> package.

+<simplelist type='horiz' columns='4'>

+<member><code>cxx:></code></member>

+<member><code>cxx:>=</code></member>

+</simplelist>

+<simplelist type='horiz' columns='4'>

+<member><code>cxx:=</code></member>

+<member><code>cxx:/=</code></member>

+</simplelist>

+<simplelist type='horiz' columns='4'>

+<member><code>cxx:<=</code></member>

+<member><code>cxx:<</code></member>

+</simplelist>

+<simplelist type='horiz' columns='4'>

+<member><code>cxx:+</code></member>

+<member><code>cxx:-</code></member>

+<member><code>cxx:*</code></member>

+<member><code>cxx:/</code></member>

+<member><code>cxx:1+</code></member>

+<member><code>cxx:1-</code></member>

+</simplelist>

+<simplelist type='horiz' columns='4'>

+<member><methodname>cxx:incf</methodname></member>

+<member><methodname>cxx:decf</methodname></member>

+</simplelist>

+<simplelist>

+<member><methodname>cxx:aref</methodname></member>

+</simplelist>

+</para>

+</section>

+<section id="static_methods"><title>Static Methods</title>

+<para>

+The static C++ method <code>QByteArray::number(int n, int base=10)</code>

+can be called by:

+<informalexample>

+<programlisting language="lisp">(<methodname>qt:byte-array.number</methodname> 37)</programlisting>

+</informalexample>

+which is equivalent to the C++ code <code>QByteArray::number(37);</code>.

+Or with:

+<informalexample>

+<programlisting language="lisp">(<genericfunction>cxx:number</genericfunction> (find-class '<classname>qt:byte-array</classname>) 37)</programlisting>

+</informalexample>

+or:

+<informalexample>

+<programlisting language="lisp">(<genericfunction>cxx:number</genericfunction> (make-instance '<classname>qt:byte-array</classname>) 37)</programlisting>

+</informalexample>

+</para>

+</section>

+<section id="constants"><title>Constants</title>

+<para>

+ C++ Class enums available as constants. E.g.:

+ <code>QColor::Rgb</code> is <constant>qt:color.+rgb+</constant>.

+ See <package>:cxx-support</package>.

+</para>

+</section>

+<section id="members"><title>Member variables</title>

+<para>

+C++ member variables of an instance can be accessed by using <code>slot-value</code>; e.g.:

+<informalexample>

+<programlisting language="lisp">(slot-value (make-instance 'qt:object) :static-meta-object)</programlisting>

+</informalexample>

+or

+<informalexample>

+<programlisting language="lisp">(slot-value (find-class 'qt:object) :static-meta-object)</programlisting>

+</informalexample>

+Usually they can also be accessed using methods from the <package>:cxx</package> package.

+</para>

+</section>

+<section id="gc"><title>Garbage Collection</title>

+<para>

+You should be able to use C++ Class instances like normal Lisp object.

+</para>

+<para>

+C++ classes are automatically deleted when their Lisp object gets garbage collected;

+except when they (QObjects) have a parent and thus the parent is responsible for

+their deletion. When a <classname>qt:object</classname> has a parent, a strong

+reference is kept to prevent the garbage collection removing it until the parent is deleted.

+</para>

+<caution>

+<para>

+ Ownership transfer for non QObject instances is mostly unimplemented.

+</para>

+</caution>

+</section>

+<section id="core-image"><title>Saving a Core Image</title>

+<para>

+For near instant startup you can save an image. Since saving C++ instances is not supported,

+it is best to save the image immediately after loading the packages.

+</para>

+<note><para>

+Initializing the Smoke bindings when the image is loaded is implementation dependent. It is implemented

+for SBCL and Clozure CL.

+</para></note>

+<section><title>SBCL</title>

+<para>To save an image in SBCL you can use:

+<ulink url="http://www.sbcl.org/manual/Saving-a-Core-Image.html"><code>sb-ext:save-lisp-and-die</code></ulink>

+</para>

+<section><title>Bundle</title>

+<para>

+To create a bundle containing an SBCL image and the required C wrappers libraries you can use

+<methodname>smoke:save-bundle</methodname>.

+The bundle is created using <ulink url="http://megastep.org/makeself/">makeself</ulink>.

+See

+<ulink url="http://tobias.rautenkranz.ch/darcsweb/darcsweb.cgi?r=cl-smoke/qt.examples;a=headblob;f=/make-bundle.sh">make-bundle.sh</ulink> in <package>:qt.examples</package> for an example.

+</para>

+</section>

+<section><title>Clozure CL</title>

+<para>

+To save an image in CCL

+<ulink url="http://ccl.clozure.com/manual/chapter4.7.html#Saving-Applications">

+<code>ccl:save-application</code></ulink> is usually used.

+</para>

+<caution>

+<para>

+To allow the image to find the C wrapper libraries, they have to be installed with:

+<informalexample>

+<programlisting>

+sudo make install

+</programlisting>

+</informalexample>

+run in the <filename>smoke/</filename> and <filename>qt/</filename> directory.

+</para>

+</caution>

+</section>

+</chapter>

diff -rN -u old-doc/video.xsl new-doc/video.xsl

--- old-doc/video.xsl 1970-01-01 01:00:00.000000000 +0100

+++ new-doc/video.xsl 2014-10-30 07:14:03.000000000 +0100

@@ -0,0 +1,27 @@

+<?xml version='1.0'?>

+<xsl:stylesheet version="1.0"

+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

+

+<xsl:template match="videodata">

+ <video controls="true">

+ <xsl:attribute name="src">

+ <xsl:value-of select="@fileref" />

+ </xsl:attribute>

+ <img>

+ <xsl:attribute name="src">

+ <xsl:value-of select="concat(substring-before(@fileref, 'ogg'),'png')" />

+ </xsl:attribute>

+ </img>

+ <p>

+ <a>

+ <xsl:attribute name="href">

+ <xsl:value-of select="@fileref" />

+ </xsl:attribute>

+ <xsl:text>Download Video</xsl:text>

+ </a>

+ </p>

+ </video>

+</xsl:template>

+</xsl:stylesheet>

diff -rN -u old-doc/xslthl-config.xml new-doc/xslthl-config.xml

--- old-doc/xslthl-config.xml 1970-01-01 01:00:00.000000000 +0100

+++ new-doc/xslthl-config.xml 2014-10-30 07:14:03.000000000 +0100

@@ -0,0 +1,5 @@

+<?xml version="1.0" encoding="UTF-8"?>

+<xslthl-config>

+ <highlighter id="lisp" file="lisp-hl.xml" />

+ <namespace prefix="xslthl" uri="http://xslthl.sf.net" />

+</xslthl-config>

Crece desde el pueblo el futuro / crece desde el pie

RSS