Commit e7ba5b6c authored by Fabien Triolet's avatar Fabien Triolet
Browse files

Added description of new components

parent 207d9a7a
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Id: chapter.dtd,v 1.1 2003-04-09 14:22:36 triolet Exp $-->
<!-- $Id: chapter.dtd,v 1.2 2003-06-06 09:32:00 triolet Exp $-->
<!-- Une DTD trs simplifie pour des livres -->
<!-- Les chapitres -->
......@@ -37,7 +37,9 @@
<!ATTLIST figure
id ID #REQUIRED
src CDATA #REQUIRED
legende CDATA #REQUIRED>
legende CDATA #REQUIRED
height CDATA #IMPLIED
width CDATA #IMPLIED>
<!-- Rfrence une figure -->
<!ELEMENT figref EMPTY>
......
<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- $Id: contrib.xml,v 1.1 2003-04-09 14:22:36 triolet Exp $-->
<!-- $Id: contrib.xml,v 1.2 2003-06-06 09:32:00 triolet Exp $-->
<chapter id="contrib" previous="dev" type="appendice" next="quickref" >
<title>Overview of the contributed modules</title>
<sect1>
......@@ -118,6 +118,27 @@ by Eric M. Burke(O'Reilly)</para>
</serialize>]]></code>
<para>Requires: jfor (0.7.1)</para>
</sect2>
<sect2>
<title>SVGSerializer</title>
<para>Author: Fabien Triolet (INRIA Rhône-Alpes)</para>
<para></para>
<para>Declaration:</para>
<code><![CDATA[<defextern name="SVGSerializer"
class="fr.fluxmedia.tmcontrib.serializer.SVGSerializer"
implements="serializer"/>]]></code>
<para>Parameters:</para>
<para>file - the name of the file to write</para>
<para>transcoder - the type of transcoder to use : JPEG,PNG or TIFF</para>
<para>Classes: SVGSerializer.</para>
<para>Use:</para>
<code><![CDATA[<serialize id="outputSVG" type="SVGSerializer" in="i">
<with-param name="file">aFile.svg</with-param>
<with-param name="transcoder">JPEG</with-param>
</serialize>]]></code>
<para>Requires: batik</para>
</sect2>
</sect1>
<sect1>
<title>Mergers</title>
......@@ -127,6 +148,49 @@ by Eric M. Burke(O'Reilly)</para>
</sect1>
<sect1>
<title>External transformations</title>
<sect2>
<title>Log</title>
<para>Author: Fabien Triolet (INRIA Rhône-Alpes)</para>
<para></para>
<para>Declaration:</para>
<code><![CDATA[<defextern name="log"
class="fr.fluxmedia.tmcontrib.external.Log"/>]]></code>
<para>Parameters:</para>
<para>file - the name of the file to write</para>
<para>Classes: Log.</para>
<para>Use:</para>
<code><![CDATA[<apply-external id="myLog" type="log" in="i" out="o">
<with-param name="file">aFile.log</with-param>
</serialize>]]></code>
<para>Requires: -</para>
</sect2>
<sect2>
<title>SQL external</title>
<para>Author: Fabien Triolet (INRIA Rhône-Alpes)</para>
<para></para>
<para>Declaration:</para>
<code><![CDATA[<defextern name="sql"
class="fr.fluxmedia.tmcontrib.external.SQLExternal"/>]]></code>
<para>Parameters:</para>
<para>driver - the driver class use for the connection to the database</para>
<para>base-url -URL of the database server</para>
<para>base-name - the datadase to use</para>
<para>user -</para>
<para>password -</para>
<para>Classes: SQLExternal.</para>
<para>Use:</para>
<code><![CDATA[<apply-external id="sql" type="sql" in="i" out="o">
<with-param name="driver">org.gjt.mm.mysql.Driver</with-param>
<with-param name="base-url">jdbc:mysql://localhost:3306</with-param>
<with-param name="base-name">myBase</with-param>
<with-param name="user">username</with-param>
<with-param name="password">password</with-param>
</serialize>]]></code>
<para>Requires: driver class</para>
</sect2>
</sect1>
<sect1>
<title>Iterators</title>
......
<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- $Id: dispatch.xml,v 1.1 2003-04-09 14:22:36 triolet Exp $-->
<!-- $Id: dispatch.xml,v 1.2 2003-06-06 09:32:00 triolet Exp $-->
<chapter id="dispatch" type="chapter" previous="generators" next="import">
<title>Dispatchers and Mergers</title>
<sect1>
......@@ -18,7 +18,7 @@
<sect2>
<title>Built-in dispatchers</title>
<para>Transmorpher provides a basic implementation of a dispatcher ( <element>broadcast</element> ), its behavior is to copy the input
<para>Transmorpher provides a basic implementation of a dispatcher ( <element>broadcast</element>, <figref idref="dispatch"/> ), its behavior is to copy the input
to the different outputs. It is used in the bibliography example for dispatching the input: </para>
<para><code><![CDATA[
<dispatch type="broadcast" id="dispatch 2" in="R112" out="D1 D3"/>
......
<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- $Id: examples.xml,v 1.1 2003-04-09 14:22:36 triolet Exp $-->
<!-- $Id: examples.xml,v 1.2 2003-06-06 09:32:00 triolet Exp $-->
<chapter id="examples" type="chapter" previous="introduction" next="model">
<title>Examples</title>
<sect1>
......@@ -13,7 +13,7 @@
<list>
<item><para>An HTML presentation for the whole collection</para></item>
<item><para>An HTML presentation for an artist</para></item>
<item><para>A list</para></item>
<item><para>A vcal file</para></item>
</list>
<code><![CDATA[<?xml version="1.0"?>
<!DOCTYPE music-collection SYSTEM "Music-collection.dtd">
......@@ -37,6 +37,10 @@
<track id="12"><name>Take My Hand</name><time>6:42</time></track>
</cd>
</artist>
<artist>
...
</artist>
...
</music-collection>]]></code>
</sect2>
......@@ -226,6 +230,42 @@ The strip abstract can be done in XML, see here for a discussion on that points.
<apply-external type="xslt" name="XLST32" file="form-xml.xsl" invv="Z2" out="Z3"/>
</process>
</transmorpher>]]></code>
<figure id="schema" src="../refman/images/Schema1_firstOne.jpg" legende="Complexe XSL process" height="308" width="781"/>
<figure id="res1" src="../refman/images/Biblio1.jpg" legende="bibliography sorted by type" height="310" width="253"/>
<figure id="res2" src="../refman/images/Biblio2.jpg" legende="bibliography sorted by date" height="310" width="253"/>
<figure id="res3" src="../refman/images/Biblio3.jpg" legende="bibliography in bibtex" height="310" width="253"/>
</sect2>
<sect2>
<title>Sample 2 : this is a simple transformation</title>
<para>For example :</para>
<para>this description define a complexe transformation
show in figure 1.0</para>
<code><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<transmorpher xmlns:FM="http://www.fluxmedia.org/schema">
<!-- This sample allow to select a set of elementin the bibliography -->
<process name="mySecondprocess" >
<!-- Read the XML input file -->
<generate type="readfile" name="Reader" out="R1" file="./bibexmo.xml"/>
<!-- Select a set of element : only troncy and brunet reference -->
<query type="simpleOne" name="query1" file="query1.xml" in="R1" out="Z1"/>
<!-- Transform the XML to html -->
<apply-externaltype="xslt" name="XLST32" file="form-xml2html.xsl" in="Z1" out="Z2"/>
<!-- Write the HTML -->
<serialize name="SErializer1" in="Z2" file="Answer.html" />
</process>
</transmorpher>
<-- This query allow to select all reference of Troncy and Brunet author -->
<query root="bibliography">
<select expr="bibliography/reference[authors/p/@last='Troncy']"/>
<select expr="bibliography/reference[authors/p/@last='Brunet']"/>
</query> ]]></code>
<figure id="query" src="../refman/images/Schema4_query.jpg" legende="Query sample" height="357" width="583"/>
</sect2>
</sect1>
</chapter>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- $Id: introduction.xml,v 1.1 2003-04-09 14:22:36 triolet Exp $-->
<!-- $Id: introduction.xml,v 1.2 2003-06-06 09:32:00 triolet Exp $-->
<chapter id="introduction" type="chapter" next="examples">
<title>Introduction to Transmorpher</title>
<sect1>
......@@ -39,7 +39,7 @@
</list>
<para>The two first documents must have first been stripped of abstract and non-public information.
The generation of the first three documents can be naturally expressed by the following schema
The generation of the first three documents can be naturally expressed by the following schema (<figref idref="sample"/>)
in which boxes are transformations written in some transformation language (e.g. XSLT) and
<element>strip-abstract</element> is the simple suppression of <element>abstract</element> elements,
of elements marked as private and of mark attributes.</para>
......
<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- $Id: main.xml,v 1.1 2003-04-09 14:22:36 triolet Exp $-->
<!-- $Id: main.xml,v 1.2 2003-06-06 09:32:00 triolet Exp $-->
<chapter id="main" type="chapter" previous="examples" next="generators">
<title>Transmorpher transformations</title>
<para>In Transmorpher, the transformation is the container of all the processes. It often
......@@ -83,7 +83,7 @@
classpath="./lib/transmo.jar"/>]]></code>
<para>Using the task:</para>
<code><![CDATA[
<transmorph debug="2" mode="run" srcfile="../transmorpher/samples/biblio/process.xml" message="yurk">
<transmorph debug="2" mode="run" srcfile="../transmorpher/samples/biblio/process.xml" message="processing bibliography">
<param name="MyParam1" select="value"/>
<param name="MyParam2>value</param>
</transmorph>]]></code>
......
<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- $Id: quickref.xml,v 1.1 2003-04-09 14:22:36 triolet Exp $-->
<!-- $Id: quickref.xml,v 1.2 2003-06-06 09:32:00 triolet Exp $-->
<chapter id="quickref" type="appendice" previous="contrib">
<title>Quick reference</title>
<para></para>
......@@ -18,7 +18,7 @@
The <element>type</element> attribute allows the mapping to a specific generator.</para>
</sect2>
<sect2>
<title>available parameters</title>
<title>specific parameters</title>
<list>
<item>
<para>type=readfile</para>
......@@ -58,7 +58,7 @@
char streams. The <element>type</element> attribute allows the mapping to a specific serializer.</para>
</sect2>
<sect2>
<title>available parameters</title>
<title>specific parameters</title>
<list>
<item><para>type=writefile</para></item>
</list>
......@@ -119,6 +119,46 @@
<cell><para>default value is text/xml</para></cell>
</row>
</table>
<list>
<item><para>type=pdf (contribution)</para></item>
</list>
<table>
<row>
<headercell width="35mm"><para>name</para></headercell>
<headercell width="35mm"><para>value</para></headercell>
<headercell width="35mm"><para>notes</para></headercell>
</row>
<row>
<cell><para>file</para></cell>
<cell><para>the file name to write</para></cell>
<cell><para></para></cell>
</row>
<row>
<cell><para>format</para></cell>
<cell><para>pdf or ps</para></cell>
<cell><para>default is pdf</para></cell>
</row>
</table>
<list>
<item><para>type=svg (contribution)</para></item>
</list>
<table>
<row>
<headercell width="35mm"><para>name</para></headercell>
<headercell width="35mm"><para>value</para></headercell>
<headercell width="35mm"><para>notes</para></headercell>
</row>
<row>
<cell><para>file</para></cell>
<cell><para>the file name to write</para></cell>
<cell><para></para></cell>
</row>
<row>
<cell><para>transcoder</para></cell>
<cell><para>JPEG, TIFF or PNG</para></cell>
<cell><para>default is JPEG</para></cell>
</row>
</table>
</sect2>
</sect1>
......@@ -136,7 +176,7 @@
Built-in implementation of this composent is base on XSLT.</para>
</sect2>
<sect2>
<title>available parameters</title>
<title>specific parameters</title>
<list>
<item><para>type=xslt</para></item>
</list>
......@@ -152,6 +192,66 @@
<cell><para></para></cell>
</row>
</table>
<list>
<item><para>type=log (contribution)</para></item>
</list>
<table>
<row>
<headercell width="35mm"><para>name</para></headercell>
<headercell width="35mm"><para>value</para></headercell>
<headercell width="35mm"><para>notes</para></headercell>
</row>
<row>
<cell><para>file</para></cell>
<cell><para>the log file</para></cell>
<cell><para></para></cell>
</row>
</table>
<list>
<item><para>type=sql (contribution)</para></item>
</list>
<table>
<row>
<headercell width="35mm"><para>name</para></headercell>
<headercell width="35mm"><para>value</para></headercell>
<headercell width="35mm"><para>notes</para></headercell>
</row>
<row>
<cell><para>driver</para></cell>
<cell><para>the driver needed to connect to the database</para></cell>
<cell><para>For example, to connect to MySQL, the requested driver is org.gjt.mm.mysql.Driver</para></cell>
</row>
<row>
<cell><para>base-URL</para></cell>
<cell><para>url of the database server</para></cell>
<cell><para></para></cell>
</row>
<row>
<cell><para>base-name</para></cell>
<cell><para>name of the base</para></cell>
<cell><para></para></cell>
</row>
<row>
<cell><para>user</para></cell>
<cell><para>user name</para></cell>
<cell><para></para></cell>
</row>
<row>
<cell><para>password</para></cell>
<cell><para>the user password</para></cell>
<cell><para></para></cell>
</row>
<row>
<cell><para>resultset-node</para></cell>
<cell><para>the name of the root node</para></cell>
<cell><para>for example, <element>ruleset</element></para></cell>
</row>
<row>
<cell><para>row-node</para></cell>
<cell><para>the name of the row node</para></cell>
<cell><para>for example, <element>row</element></para></cell>
</row>
</table>
</sect2>
</sect1>
......@@ -160,11 +260,13 @@
<sect2>
<title>syntax</title>
<code><![CDATA[<apply-process id="" ref="" in="in labels" out="out labels">
{<with-param name="">value</with-param>}*
{<with-param name="aName">value</with-param>}*
</apply-process>]]></code>
</sect2>
<sect2>
<title>description</title>
<para>An apply-process component is used to call a set of processes defined in a process component.
The requested process is defined by is name and can be called by several apply-process.</para>
</sect2>
</sect1>
......
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id: process.xml,v 1.2 2003-04-09 14:11:28 triolet Exp $ -->
<!-- $Id: process.xml,v 1.3 2003-06-06 09:32:00 triolet Exp $ -->
<!DOCTYPE transmorpher SYSTEM "../../../dtd/transmorpher.dtd">
<transmorpher name="ReferenceManual" version="1.0" xmlns="http://transmorpher.fluxmedia.fr/1.0">
......@@ -21,17 +21,17 @@
<with-param name="path1">$path</with-param>
</apply-external>
<!-- <dispatch id="disp" type="broadcast" in="2" out="3 4"/> -->
<serialize id="writePDF" type="fop" in="2">
<dispatch id="disp" type="broadcast" in="2" out="33 4"/>
<serialize id="writePDF" type="fop" in="33">
<with-param name="file">${path}/manual/refman/output/pdf/refman.pdf</with-param>
<with-param name="format">pdf</with-param>
</serialize>
<!-- <serialize id="output" type="writefile" in="4">
<with-param name="file">../samples/livre/output/livre.fo</with-param>
<serialize id="output" type="writefile" in="4">
<with-param name="file">../samples/manual/refman/output/livre.fo</with-param>
<with-param name="method">xml</with-param>
<with-param name="indent">yes</with-param>
</serialize> -->
</serialize>
<apply-external id="form-HTMLindex" in="12" out="3" type="xslt">
<with-param name="file">${path}/manual/refman/xslt/LivreHTML.xsl</with-param>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment