qtsvg: dok -> md

2 files changed, 169 insertions, 168 deletions

diff --git a/packages/qtsvg/doc/README.md b/packages/qtsvg/doc/README.md
new file mode 100644
index 0000000..2d0cfc7
--- /dev/null
+++ b/packages/qtsvg/doc/README.md
@@ -0,0 +1,169 @@
+<a name="qtsvg.dok"/>
+# QtSvg Bindings #
+
+The package `qtsvg` 
+contains bindings for classes defined by the Qt module
+[QtSvg](http://doc.trolltech.com/4.4/qtsvg.html).
+
+Besides the capabilites reported below,
+all qt variants inherit a set 
+of [default methods](..:qt:index#QVariants),
+and all qt object classes inherit the capabilities from their 
+superclasses and automatically expose 
+[properties, slots and signals](..:qt:index#QObjects).
+
+You can also use the function 
+[qtwidget.newpdf](..:qtwidget:index#qtwidgetnewpdf),
+defined in module `qtwidget`,
+to easily generate SVG files. 
+
+
+<a name="qtsvg_loadsvg"/>
+### qtsvg.loadsvg(filename) ###
+<a name="qtsvg.loadsvg"/>
+
+Returns a Qt object of 
+class [qt.QSvgRenderer](#qsvgrenderer)
+representing the SVG file `filename`.
+
+
+<a name="qtsvg_paintsvg"/>
+### qtsvg.paintsvg(port,svg,...) ###
+<a name="qtsvg.paintsvg"/>
+
+Draws a SVG image.
+
+Argument `port` must be a 
+[qt.QtLuaPainter](..:qtwidget:index#qtluapainter) or a 
+[qtwidget'' high level port descriptor](..:qtwidget:index#highlevel).
+Argument `svg` can be the SVG filename or
+an instance of class [qt.QSvgRenderer](#qsvgrenderer)
+such as those returned by function [qtsvg.loadsvg](#qtsvg_loadsvg).
+The remaining arguments are the same
+as those for the C++ function `QSvgRenderer::render`.
+
+
+<a name="qsvgwidget"/>
+### qt.QSvgWidget ###
+
+Class 
+[QSvgWidget](http://doc.trolltech.com/4.4/qsvgwidget.html)
+provides a widget that is used to display the contents 
+of Scalable Vector Graphics (SVG) files.
+
+<a name="qsvgwidget"/>
+#### qt.QSvgWidget([filename],[parent]) ####
+
+Expression `qt.QSvgWidget(parent)` returns a 
+new widget for rendering SVG data.
+
+The optional argument `filename` specifies the name
+of a file containing the SVG data.  Without this argument,
+you must use slot `qsvgwidget:load()` to load SVG data.
+
+The optional argument `parent` specifies the widget parent.
+New widgets are always created from the main thread using
+the [thread hopping](..:qt:index#qtqcall) mechanism.
+When argument `parent` is `nil` or not specified,
+the new widget is owned by the Lua interpreter 
+and is automatically destroyed when the garbage collector
+determines that it is no longer referenced.
+
+<a name="qsvgwidget.renderer"/>
+#### qsvgwidget:renderer() ####
+
+Returns the [qt.QSvgRenderer](#qsvgrenderer) object 
+associated with this widget.
+
+
+<a name="qsvgrenderer"/>
+### qt.QSvgRenderer ###
+
+Class 
+[QSvgRenderer](http://doc.trolltech.com/4.4/qsvgrenderer.html)
+is used to draw the contents of SVG files onto paint devices.
+You should use instead function 
+[qtsvg.paintsvg](#qtsvg_paintsvg)
+to easily display SVG data.
+
+<a name="qsvgrenderer"/>
+#### qt.QSvgRenderer([filename],[parent]) ####
+
+Creates a new instance of class `QSvgRenderer`.
+
+The optional argument `filename` specifies the name
+of a file containing the SVG data.  Without this argument,
+you must use slot `qsvgwidget:load()` to load SVG data.
+
+The optional argument `parent` specifies the widget parent.
+When argument `parent` is `nil` or not specified,
+the new widget is owned by the Lua interpreter 
+and is automatically destroyed when the garbage collector
+determines that it is no longer referenced.
+
+
+<a name="qtluasvggenerator"/>
+### qt.QtLuaSvgGenerator ###
+
+This is a thin wrapper around the Qt class
+[QSvgGenerator](http://doc.trolltech.com/4.4/qsvggenerator.html).
+
+You should use instead function 
+[qtwidget.newpdf](..:qtwidget:index#qtwidgetnewpdf)
+to easily generate SVG files.
+
+<a name="qtluasvggenerator"/>
+#### qt.QtLuaSvgGenerator([filename],[parent]) ####
+
+Creates a new instance of class `QtLuaSvgGenerator`.
+
+When argument `filename` is present, the SVG data is written
+into the specified file. Otherwise it is written into a memory
+buffer accessible using the method 
+[qsvggenerator:data()](#qtluasvggeneratordata).
+
+The optional argument `parent` specifies the widget parent.
+When argument `parent` is `nil` or not specified,
+the new widget is owned by the Lua interpreter 
+and is automatically destroyed when the garbage collector
+determines that it is no longer referenced.
+
+<a name="qtluasvggeneratordata"/>
+#### qtluasvggenerator:data() ####
+<a name="qtluasvggenerator.data"/>
+
+Assuming the `qtluasvggenerator` was created without the `filename` argument,
+this function returns a [qt.QByteArray](..:qtcore:index#qbytearray)
+containing the generated SVG data.  This data may be incomplete
+until [painter:close()](..:qtwidget:index#painterclose) has
+been closed on all painters operating on `qtluasvggenerator`.
+
+<a name="qtluasvggenerator.description"/>
+#### qtluasvggenerator.description ####
+
+Starting with Qt-4.5, this string property defines 
+the contents of the `<desc>` tag of the SVG file.
+
+<a name="qtluasvggenerator.title"/>
+#### qtluasvggenerator.title ####
+
+Starting with Qt-4.5, this string property defines 
+the contents of the `<title>` tag of the SVG file.
+
+<a name="qtluasvggenerator.size"/>
+#### qtluasvggenerator.size ####
+
+This property contains a [qt.QSize](..:qtcore:index#qsize) 
+variant containing the size of the drawable area.
+This information is shown in the `viewBox` attribute of the `<svg>` tag.
+
+<a name="qtluasvggenerator.resolution"/>
+#### qtluasvggenerator.resolution ####
+
+This integer property defines the resolution, in dots per inch, 
+of the coordinate system.
+Together with `qtluasvggenerator.size`, this property determines
+the contents of the `width` and `height` attributes of the `<svg>` tag.
+
+
+
diff --git a/packages/qtsvg/dok/index.dok b/packages/qtsvg/dok/index.dok
deleted file mode 100644
index 659bf5e..0000000
--- a/packages/qtsvg/dok/index.dok
+++ /dev/null
@@ -1,168 +0,0 @@
-====== QtSvg Bindings ====== 
-{{anchor:qtsvg.dok}}
-
-The package ''qtsvg'' 
-contains bindings for classes defined by the Qt module
-[[http://doc.trolltech.com/4.4/qtsvg.html|QtSvg]].
-
-Besides the capabilites reported below,
-all qt variants inherit a set 
-of [[..:qt:index#QVariants|default methods]],
-and all qt object classes inherit the capabilities from their 
-superclasses and automatically expose 
-[[..:qt:index#QObjects|properties, slots and signals]].
-
-You can also use the function 
-[[..:qtwidget:index#qtwidgetnewpdf|qtwidget.newpdf]],
-defined in module ''qtwidget'',
-to easily generate SVG files. 
-
-
-====  qtsvg.loadsvg(filename) ====
-{{anchor:qtsvg_loadsvg}}
-{{anchor:qtsvg.loadsvg}}
-
-Returns a Qt object of 
-class [[#qsvgrenderer|qt.QSvgRenderer]]
-representing the SVG file ''filename''.
-
-
-====  qtsvg.paintsvg(port,svg,...) ====
-{{anchor:qtsvg_paintsvg}}
-{{anchor:qtsvg.paintsvg}}
-
-Draws a SVG image.
-
-Argument ''port'' must be a 
-[[..:qtwidget:index#qtluapainter|qt.QtLuaPainter]] or a 
-[[..:qtwidget:index#highlevel|qtwidget'' high level port descriptor]].
-Argument ''svg'' can be the SVG filename or
-an instance of class [[#qsvgrenderer|qt.QSvgRenderer]]
-such as those returned by function [[#qtsvg_loadsvg|qtsvg.loadsvg]].
-The remaining arguments are the same
-as those for the C++ function ''QSvgRenderer::render''.
-
-
-====  qt.QSvgWidget ====
-{{anchor:qsvgwidget}}
-
-Class 
-[[http://doc.trolltech.com/4.4/qsvgwidget.html|QSvgWidget]]
-provides a widget that is used to display the contents 
-of Scalable Vector Graphics (SVG) files.
-
-===  qt.QSvgWidget([filename],[parent]) ===
-{{anchor:qsvgwidget}}
-
-Expression ''qt.QSvgWidget(parent)'' returns a 
-new widget for rendering SVG data.
-
-The optional argument ''filename'' specifies the name
-of a file containing the SVG data.  Without this argument,
-you must use slot ''qsvgwidget:load()'' to load SVG data.
-
-The optional argument ''parent'' specifies the widget parent.
-New widgets are always created from the main thread using
-the [[..:qt:index#qtqcall|thread hopping]] mechanism.
-When argument ''parent'' is ''nil'' or not specified,
-the new widget is owned by the Lua interpreter 
-and is automatically destroyed when the garbage collector
-determines that it is no longer referenced.
-
-===  qsvgwidget:renderer() ===
-{{anchor:qsvgwidget.renderer}}
-
-Returns the [[#qsvgrenderer|qt.QSvgRenderer]] object 
-associated with this widget.
-
-
-====  qt.QSvgRenderer ====
-{{anchor:qsvgrenderer}}
-
-Class 
-[[http://doc.trolltech.com/4.4/qsvgrenderer.html|QSvgRenderer]]
-is used to draw the contents of SVG files onto paint devices.
-You should use instead function 
-[[#qtsvg_paintsvg|qtsvg.paintsvg]]
-to easily display SVG data.
-
-===  qt.QSvgRenderer([filename],[parent]) ===
-{{anchor:qsvgrenderer}}
-
-Creates a new instance of class ''QSvgRenderer''.
-
-The optional argument ''filename'' specifies the name
-of a file containing the SVG data.  Without this argument,
-you must use slot ''qsvgwidget:load()'' to load SVG data.
-
-The optional argument ''parent'' specifies the widget parent.
-When argument ''parent'' is ''nil'' or not specified,
-the new widget is owned by the Lua interpreter 
-and is automatically destroyed when the garbage collector
-determines that it is no longer referenced.
-
-
-====  qt.QtLuaSvgGenerator ====
-{{anchor:qtluasvggenerator}}
-
-This is a thin wrapper around the Qt class
-[[http://doc.trolltech.com/4.4/qsvggenerator.html|QSvgGenerator]].
-
-You should use instead function 
-[[..:qtwidget:index#qtwidgetnewpdf|qtwidget.newpdf]]
-to easily generate SVG files.
-
-===  qt.QtLuaSvgGenerator([filename],[parent]) ===
-{{anchor:qtluasvggenerator}}
-
-Creates a new instance of class ''QtLuaSvgGenerator''.
-
-When argument ''filename'' is present, the SVG data is written
-into the specified file. Otherwise it is written into a memory
-buffer accessible using the method 
-[[#qtluasvggeneratordata|qsvggenerator:data()]].
-
-The optional argument ''parent'' specifies the widget parent.
-When argument ''parent'' is ''nil'' or not specified,
-the new widget is owned by the Lua interpreter 
-and is automatically destroyed when the garbage collector
-determines that it is no longer referenced.
-
-===  qtluasvggenerator:data() ===
-{{anchor:qtluasvggeneratordata}}
-{{anchor:qtluasvggenerator.data}}
-
-Assuming the ''qtluasvggenerator'' was created without the ''filename'' argument,
-this function returns a [[..:qtcore:index#qbytearray|qt.QByteArray]]
-containing the generated SVG data.  This data may be incomplete
-until [[..:qtwidget:index#painterclose|painter:close()]] has
-been closed on all painters operating on ''qtluasvggenerator''.
-
-===  qtluasvggenerator.description ===
-{{anchor:qtluasvggenerator.description}}
-
-Starting with Qt-4.5, this string property defines 
-the contents of the ''<desc>'' tag of the SVG file.
-
-===  qtluasvggenerator.title ===
-{{anchor:qtluasvggenerator.title}}
-
-Starting with Qt-4.5, this string property defines 
-the contents of the ''<title>'' tag of the SVG file.
-
-===  qtluasvggenerator.size ===
-{{anchor:qtluasvggenerator.size}}
-
-This property contains a [[..:qtcore:index#qsize|qt.QSize]] 
-variant containing the size of the drawable area.
-This information is shown in the ''viewBox'' attribute of the ''<svg>'' tag.
-
-===  qtluasvggenerator.resolution ===
-{{anchor:qtluasvggenerator.resolution}}
-
-This integer property defines the resolution, in dots per inch, 
-of the coordinate system.
-Together with ''qtluasvggenerator.size'', this property determines
-the contents of the ''width'' and ''height'' attributes of the ''<svg>'' tag.
-
-