vhardy 2002/06/19 00:02:19
Modified: xdocs site-book.xml status.xml svgrasterizer.xml
Log:
Fixed errors reported by Robert, a couple issues in the status page and removed ^M
in svgrasterizer
Revision Changes Path
1.31 +2 -2 xml-batik/xdocs/site-book.xml
Index: site-book.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/site-book.xml,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- site-book.xml 18 Jun 2002 07:23:00 -0000 1.30
+++ site-book.xml 19 Jun 2002 07:02:19 -0000 1.31
@@ -31,7 +31,6 @@
<external label="Download"
href="http://xml.apache.org/batik/dist" />
<page id="install" label="Install"
source="installing.xml"/>
<page id="batikDemo" label="Demo"
source="batikDemo.xml"/>
- <external label="Demo"
href="batikDemo.html"/>
<separator/>
<!-- ======================= -->
@@ -56,6 +55,7 @@
<!-- Developer's Guides and Tutorials -->
<!-- ==================================== -->
<page id="architecture" label="Architecture"
source="architecture.xml"/>
+ <external id="javadoc" label="API (Javadoc)"
href="javadoc/index.html"/>
<page id="svggen" label="Generator"
source="svggen.xml" />
<page id="domapi" label="DOM API"
source="domTutorial.xml" />
<page id="svgcanvas" label="JSVGCanvas"
source="jsvgcanvas.xml" />
1.22 +2 -4 xml-batik/xdocs/status.xml
Index: status.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/status.xml,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- status.xml 17 Jun 2002 16:28:00 -0000 1.21
+++ status.xml 19 Jun 2002 07:02:19 -0000 1.22
@@ -98,8 +98,6 @@
Batik toolkit rendering components (i.e., the
<code>ImageTranscoder</code> and the
<code>JSVGCanvas</code> Swing component). </p>
- <p>Insert <strong>CSS Properties support here</strong></p>
-
</s1>
<anchor id="domLevel2Status" />
@@ -243,7 +241,7 @@
<anchor id="metrics" />
<s1 title="Batik Metrics">
- <p>The following numbers are as of November 7th 2001</p>
+ <p>The following numbers are as of May 7th 2002</p>
<p><strong>Modules Binary size</strong></p>
<table>
1.12 +60 -52 xml-batik/xdocs/svgrasterizer.xml
Index: svgrasterizer.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/svgrasterizer.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- svgrasterizer.xml 17 Jun 2002 16:28:01 -0000 1.11
+++ svgrasterizer.xml 19 Jun 2002 07:02:19 -0000 1.12
@@ -41,7 +41,7 @@
The SVG Rasterizer is a utility that can convert SVG files to a
raster format. The tool can convert individual files or sets of
files, making it easy to convert entire directories of SVG
- files. The provided formats are JPEG, PNG, and Tiff, however the
+ files. The provided formats are JPEG, PNG, and Tiff, however the
design allows new formats to be added easily.
</p>
@@ -52,8 +52,8 @@
<p>Refer to the <link href="install.html">install page</link> and the
<link href="dist">download area</link> to find out what to download and
how to
- install it. Remember that you can get either the <link
href="install.html#distributions">source distribution</link>
- or the <link href="install.html#distributions">binary
distribution</link>.</p>
+ install it. Remember that you can get either the <link
href="install.html#distributions">source distribution</link>
+ or the <link href="install.html#distributions">binary
distribution</link>.</p>
</s1>
<anchor id="using" />
@@ -66,76 +66,79 @@
<s2 title="Using the binary distribution" >
<p>If you downloaded the binary distribution of Batik, you should
have
- gotten a file called <em>batik-1.5beta3.zip</em>, and, after
expanding that
- file, a JAR (Java ARchive) file called
<code>batik-rasterizer.jar</code>.
+ gotten a file called <em>batik-1.5beta3.zip</em>, and, after
expanding that
+ file, a JAR (Java ARchive) file called
<code>batik-rasterizer.jar</code>.
To start the rasterizer, open a console, go to the directory where
you
- expanded the distribution (and where
<code>batik-rasterizer.jar</code> is located) and
+ expanded the distribution (and where
<code>batik-rasterizer.jar</code> is located) and
simply type the following at the command prompt :</p>
- <p><code>java -jar batik-rasterizer.jar
</code><em>[@files]</em></p>
+ <p><code>java -jar batik-rasterizer.jar </code><em>[@files]</em></p>
<p>For example, if you type:</p>
- <p><code>java -jar batik-rasterizer.jar
samples/batikFX.svg</code></p>
+ <p><code>java -jar batik-rasterizer.jar
samples/batikFX.svg</code></p>
<p>you will see the following printout:</p>
- <p><code>Converting file: samples/BatikFX.svg to
samples/BatikFX.png</code></p>
- <p>Once the conversion is complete, you will find a
<code>batikFX.png</code> file in the samples
+ <p><code>Converting file: samples/BatikFX.svg to
samples/BatikFX.png</code></p>
+ <p>Once the conversion is complete, you will find a
<code>batikFX.png</code> file in the samples
directory</p>
<p>You can pass options to the command line:</p>
- <p><code>java -jar batik-rasterizer.jar </code><em>[options]
[@files]</em></p>
+ <p><code>java -jar batik-rasterizer.jar </code><em>[options]
[@files]</em></p>
<p>Where the options are:</p>
<ul>
- <li><code>-d</code> <em><dir|file></em>. Output directory. If
there is a single input file, this can be a file.</li>
- <li><code>-m</code><em> <mimeType></em>. Output mime type,
one of image/png, image/jpeg, application/pdf, image/tiff.</li>
- <li><code>-w</code><em> <width></em>. Output width. This is a
floating point value.</li>
- <li><code>-h</code><em> <height></em>. Output height. This is
a floating point value.</li>
- <li><code>-a</code><em> <area></em>. Output area. The format
for <area> is x,y,w,h, where x, y, w and h
+ <li><code>-d</code> <em><dir|file></em>. Output directory. If
there is a single input file, this can be a file.</li>
+ <li><code>-m</code><em> <mimeType></em>. Output mime type,
one of image/png, image/jpeg, application/pdf, image/tiff.</li>
+ <li><code>-w</code><em> <width></em>. Output width. This is a
floating point value.</li>
+ <li><code>-h</code><em> <height></em>. Output height. This is
a floating point value.</li>
+ <li><code>-a</code><em> <area></em>. Output area. The format
for <area> is x,y,w,h, where x, y, w and h
are floating point values.</li>
- <li><code>-bg</code><em> <color></em>. Uuput color. The
format for <color> is a.r.g.b, where a, r, g and b
+ <li><code>-bg</code><em> <color></em>. Uuput color. The
format for <color> is a.r.g.b, where a, r, g and b
are integer values.</li>
- <li><code>-cssMedia</code><em> <media></em>.CSS media type
for which the source SVG files should be
+ <li><code>-cssMedia</code><em> <media></em>.CSS media type
for which the source SVG files should be
converted.</li>
- <li><code>-cssAlternate</code><em> <alternate></em>. CSS
alternate stylesheet to use when converting the source
+ <li><code>-cssAlternate</code><em> <alternate></em>. CSS
alternate stylesheet to use when converting the source
SVG files.</li>
- <li><code>-cssUser</code><em><userStylesheet></em>. CSS user
stylesheet URI to apply to converted SVG documents
+ <li><code>-cssUser</code><em><userStylesheet></em>. CSS user
stylesheet URI to apply to converted SVG documents
in addition to any other referened or embeded stylesheets.</li>
- <li><code>-lang</code><em> <userLanguage></em>. User language
to use when converting SVG documents.</li>
- <li><code>-q</code><em> <quality></em>. Quality for the
output image. This is only relevant for the
+ <li><code>-lang</code><em> <userLanguage></em>. User language
to use when converting SVG documents.</li>
+ <li><code>-q</code><em> <quality></em>. Quality for the
output image. This is only relevant for the
image/jpeg mime type.</li>
- <li><code>-dpi</code><em> <resolution></em>. Resolution for
the ouptut image.</li>
- <li><code>-validate</code> Controls whether the source SVG files
should be validated.</li>
+ <li><code>-dpi</code><em> <resolution></em>. Resolution for
the ouptut image.</li>
+ <li><code>-validate</code> Controls whether the source SVG files
should be validated.</li>
+ <li><code>-onload</code> Controls if the source SVG files must be
rasterize after dispatching the 'onload' event.</li>
+ <li><code>-scriptSecurityOff</code> Removes any security check on
the scripts running as a result of dispatching the onload event.</li>
+ <li><code>-scripts</code><em><listOfAllowedScripts></em> List
of script types (i.e., values for the type attribute in the
<code><script></code> tag) which should be loaded.</li>
</ul>
-
+
<p>For example:</p>
<ul>
- <li><code>java -jar batik-rasterizer.jar -d myDir -m image/jpeg
samples/*.svg</code> will generate JPEG images
+ <li><code>java -jar batik-rasterizer.jar -d myDir -m image/jpeg
samples/*.svg</code> will generate JPEG images
for all the SVG files found in the samples directory.</li>
</ul>
- <p><strong>NOTE:</strong>to run MIME type
<code>application/pdf</code> need to have (see <link
href="http://xml.apache.org/fop/index.html">FOP</link>) installed.</p>
+ <p><strong>NOTE:</strong>to run MIME type
<code>application/pdf</code> need to have (see <link
href="http://xml.apache.org/fop/index.html">FOP</link>) installed.</p>
</s2>
- <s2 title="Using the source distribution">
+ <s2 title="Using the source distribution">
- <p>If you downloaded the <link
href="install.html#distributions">source distribution</link>
- of Batik, you
- got a zip or tar file that expanded into a directory called
<code>xml-batik</code> directory.
- In that directory, you can find <code>build</code> scripts for the
platform you are running on.
- For example, there is a build.bat script for users of the Windows
platform and there is a
- <code>build.sh</code> script
+ <p>If you downloaded the <link
href="install.html#distributions">source distribution</link>
+ of Batik, you
+ got a zip or tar file that expanded into a directory called
<code>xml-batik</code> directory.
+ In that directory, you can find <code>build</code> scripts for the
platform you are running on.
+ For example, there is a build.bat script for users of the Windows
platform and there is a
+ <code>build.sh</code> script
for UNIX users.</p>
<p>To start the rasterizer you should:</p><ul>
- <li>Make sure the <code>xml-batik</code> directory is in your
PATH environment variable</li>
- <li>Make sure the <code>ANT_HOME</code> environment variable is
set to the xml-batik directory</li>
- <li>Make sure that your <code>JAVA_HOME</code> environment
variable is set to your JDK installation
+ <li>Make sure the <code>xml-batik</code> directory is in your
PATH environment variable</li>
+ <li>Make sure the <code>ANT_HOME</code> environment variable is
set to the xml-batik directory</li>
+ <li>Make sure that your <code>JAVA_HOME</code> environment
variable is set to your JDK installation
directory</li>
- <li>Open a command line window and go to the
<code>xml-batik</code> directory where the Batik
+ <li>Open a command line window and go to the
<code>xml-batik</code> directory where the Batik
distribution was expanded</li>
<li>At the command prompt, type: <br />
- <strong>Windows: </strong><code>build
svgrasterizer</code>.<br />
- <strong>UNIX: </strong><code>build.sh
svgrasterizer</code>.<br />
+ <strong>Windows: </strong><code>build
svgrasterizer</code>.<br />
+ <strong>UNIX: </strong><code>build.sh
svgrasterizer</code>.<br />
This will printout a
help message for the rasterizer</li>
</ul>
<p>You can pass options to the rasterizer as follows:</p>
- <p><strong>Windows: </strong><code>build svgrasterizer
</code><em>[options] [@files]</em></p>
- <p><strong>UNIX: </strong><code>build.sh svgrasterizer
</code><em>[options] [@files]</em></p>
+ <p><strong>Windows: </strong><code>build svgrasterizer
</code><em>[options] [@files]</em></p>
+ <p><strong>UNIX: </strong><code>build.sh svgrasterizer
</code><em>[options] [@files]</em></p>
<p>Refer to <link href="#usingBinary">"Using the binary
distribution" </link>for an explanation of these
options</p>
</s2>
@@ -151,16 +154,16 @@
purpose as the utility but has a different syntax and a
little different set of features.</p>
- <p>The task is able to produce four raster formats: PNG, JPEG, Tiff
- and PDF. You need to have
- <link href="http://xml.apache.org/fop/">FOP</link> installed (versions
after
+ <p>The task is able to produce four raster formats: PNG, JPEG, Tiff
+ and PDF. You need to have
+ <link href="http://xml.apache.org/fop/">FOP</link> installed (versions
after
0.20.2 should work) in your <em>CLASSPATH</em> if you want to
produce result images in PDF format.</p>
<anchor id="initTask" />
<s2 title="Taking rasterizer task in use">
<p>The first thing to do before you can use the task in your Ant
- projects is to set <code>batik-rasterizer.jar</code> and
+ projects is to set <code>batik-rasterizer.jar</code> and
classes of the rasterizer task to your
<em>CLASSPATH</em>.</p>
@@ -294,6 +297,11 @@
<code>fileset</code> element(s).</td>
</tr>
<tr>
+ <td></td>
+ <td></td>
+ </tr>
+
+ <tr>
<td>dest</td>
<td>Name of a one output file. Use this with
<code>src</code> parameter only. Output directory is
@@ -329,16 +337,16 @@
</tr>
</table>
<p>You can use <code>fileset</code> elements to select input
- files and directories. See the <link
href="http://jakarta.apache.org/ant/index.html">Ant</link>
- documentation to learn how to use
+ files and directories. See the <link
href="http://jakarta.apache.org/ant/index.html">Ant</link>
+ documentation to learn how to use
<link
href="http://jakarta.apache.org/ant/manual/CoreTypes/fileset.html">filesets</link>.</p>
</s2>
<anchor id="taskExamples" />
<s2 title="Examples of using the rasterizer task">
- <p>The following example is the complete Ant
- project which converts SVG image (called <em>input.svg</em>) to PNG
image
+ <p>The following example is the complete Ant
+ project which converts SVG image (called <em>input.svg</em>) to PNG
image
(called <em>output.png</em>):</p>
<source>
@@ -360,7 +368,7 @@
<p>The next example is just a one task in a project. It
converts all files with <code>.svg</code> suffix in
<em>images</em> directory and all files in <em>images2</em>
- directory to Tiff images. The resulting image files are placed
+ directory to Tiff images. The resulting image files are placed
in the <em>results</em> directory.</p>
<source>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]