vhardy 01/11/12 08:34:33
Modified: xdocs faq.xml index.xml installing.xml
Log:
Documentation update in prevision of 1.1 release.
Revision Changes Path
1.26 +37 -40 xml-batik/xdocs/faq.xml
Index: faq.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/faq.xml,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- faq.xml 2001/10/18 15:31:56 1.25
+++ faq.xml 2001/11/12 16:34:33 1.26
@@ -10,7 +10,7 @@
<!-- ========================================================================= -->
<!-- author [EMAIL PROTECTED] -->
<!-- author [EMAIL PROTECTED] -->
-<!-- version $Id: faq.xml,v 1.25 2001/10/18 15:31:56 cjolif Exp $ -->
+<!-- version $Id: faq.xml,v 1.26 2001/11/12 16:34:33 vhardy Exp $ -->
<!-- ========================================================================= -->
<!DOCTYPE faqs SYSTEM "./dtd/faq-v10.dtd">
@@ -48,7 +48,7 @@
a client or on a server, and Batik can convert SVG content into
other formats such as JPEG or PNG. Batik's goal is to make it easy
for application developers to handle SVG content for various
- purposes, client-side or server-side, as illustrated in the above
+ purposes, client-side or server-side, as illustrated in the
diagram.
</p>
</answer>
@@ -60,25 +60,25 @@
<answer>
<p>
SVG (Scalable Vector Graphics) is an open-standard language for describing
- two-dimensional (2D) graphics in XML. It is a Candidate Recommendation from
the
+ two-dimensional (2D) graphics in XML. It is a Recommendation from the
<link href="http://www.w3.org";>W3C</link>. SVG lets you describe rich images
with features such as gradients, transparency, filter effects and animation.
</p>
<p>
- SVG allows for three types of graphic objects: shapes (e.g., paths
consisting
+ SVG has three types of graphic objects: shapes (e.g., paths consisting
of straight lines and curves), images and text. Graphical objects can be
grouped,
styled, transformed and composited (e.g., drawn with transparency). SVG has
a
- large set of static features that includes nested transformations, clipping
+ large set of static features which includes nested transformations,
clipping
paths, masking and filter effects.
</p>
<p>
In addition, SVG images can be dynamic and interactive. A rich set of event
- handlers such as onmouseover and onclick can be assigned to any SVG
+ handlers such as 'onmouseover' and 'onclick' can be assigned to any SVG
graphical object. These handlers can invoke scripts, which, in response to
an
event, can dynamically modify the SVG graphic through the SVG Document
Object Model
(DOM) API, allowing, for example scripts to change the color or location of
graphical
elements in reaction to events. </p>
- <p>SVG graphical elements can also be animated through scripting.
Alternatively,
+ <p>SVG graphical elements can be animated through scripting. Alternatively,
animation sequences can be expressed directly in XML because SVG leverages
the
<link href="http://www.w3.org/AudioVideo/";>SMIL</link> specification for
multimedia,
another <link href="http://www.w3.org";>W3C</link> specification.
@@ -90,7 +90,7 @@
<question>What can I do with Batik?</question>
<answer>
<p>
- Batik contains several core modules that can be used independently or
jointly to
+ Batik contains several core modules which can be used independently or
jointly to
<strong>generate SVG content</strong> (see the <link href="svggen.html">SVG
Generator</link>, an
<link href="domapi.html">SVG DOM</link> implementation documentation)
<strong>view SVG content</strong> (see the <link
href="jsvgcanvas.html">JSVGCanvas</link>)
@@ -110,19 +110,19 @@
Finally, Batik comes with packaged applications to help developers get
familiar with the code and be quickly able to use the various modules: an
<link href="svgviewer.html">SVG browser</link> (in the
- org.apache.batik.apps.svgbrowser package) an
+ <code>org.apache.batik.apps.svgbrowser</code> package) an
<link href="svgrasterizer.html">SVG rasterizer</link> (in the
- org.apache.batik.apps.rasterizer package), a
+ <code>org.apache.batik.apps.rasterizer</code> package), a
<link href="ttf2svg.html">Font converter</link> (in the
- org.apache.batik.apps.ttf2svg package) and an
+ <code>org.apache.batik.apps.ttf2svg package</code>) and an
<link href="svgpp.html">SVG pretty printer</link> (in the
- org.apache.batik.apps.svgpp package).</p>
+ <code>org.apache.batik.apps.svgpp package</code>).</p>
<p>
The <strong>SVG browser</strong> can display SVG documents and lets the
user zoom, pan
and rotate any SVG document, view the SVG source, link between SVG
documents, view a tree representation of the SVG DOM and more. One
important component of the SVG viewer is the
<code>org.apache.batik.swing.JSVGCanvas</code>
- component that can be plugged in any Java application to provide SVG
viewing capability.
+ component which can be plugged in any Java application to provide SVG
viewing capability.
</p>
<p>
The <strong>SVG rasterizer</strong> lets the user convert SVG files to
raster formats such
@@ -151,7 +151,7 @@
version.</p>
<!-- <p>The SVG Generator
- (in the org.apache.batik.util.awt.svg package) that allows
+ (in the <code>org.apache.batik.util.awt.svg</code> package) that allows
all Java applications to export their graphics to the SVG format.
The SVG generator lets all Java application export their graphics
@@ -182,7 +182,9 @@
<question>How can I see a demo?</question>
<answer>
<p>
- You can either <link href="dist">download</link>
+ You can see an online demonstration of the Batik SVG browser
+ on the <link href="batikDemo.html">demo page</link>. Alternatively,
+ you can <link href="dist">download</link>
Batik or see
<link href="svgviewer.html">screenshots</link>
of the Batik SVG viewer, images created from the
@@ -211,10 +213,9 @@
<answer>
<p>
Batik is used in <link
href="http://xml.apache.org/cocoon/index.html";>Cocoon</link>
- for server side rasterization of SVG images. In addition, the Batik and the
- <link href="http://xml.apache.org/fop/index.html";>FOP</link> teams have
started to work
- together to define how the projects can leverage each other's work for SVG
to PDF
- conversion.
+ for server side rasterization of SVG images. In addition, the Batik is used
in the
+ <link href="http://xml.apache.org/fop/index.html";>FOP</link> project to
convert
+ SVG images to PDF format.
</p>
</answer>
@@ -227,7 +228,7 @@
Batik started out because several teams doing SVG related projects decided
to join
efforts with the idea that the whole will be greater than the sum of the
parts. The
following companies or institutions are part of the team that contributed
and/or
- created the initial Batik project:
+ created the initial Batik project, during the fall of 2000:
</p>
<ul>
<li><link href="http://www.csiro.au/";>CSIRO</link></li>
@@ -253,10 +254,10 @@
<question>How can I contribute?</question>
<answer>
<p>
- The Batik Project is an open volunteer project based on the
+ The Batik Project is an open volunteer project in the
spirit of the <link href="http://www.apache.org";>Apache
Software Foundation</link> (ASF). This means that there are
- lots of ways to contribute to the project, either with direct
+ many ways to contribute to the project, either with direct
participation (coding, documenting, answering questions,
proposing ideas, reporting bugs, suggesting bug-fixes, etc..)
or by resource donation (publicity, hardware, software,
@@ -277,7 +278,7 @@
list</link> (follow the link for information on how to
subscribe and to access the mail list archives), and to
checkout the <link
- href="http://xml.apache.org/websrc/index.cgi/xml-batik/";>latest
+ href="http://cvs.apache.org/viewcvs.cgi/xml-batik/";>latest
code</link>.
</p>
</answer>
@@ -287,11 +288,11 @@
<faq>
<question>Where is Batik going? What is next?</question>
<answer>
- <p>
- The SVG implementation is not complete, and there is more work to do to
- achieve a fully functional viewer, especially in dynamic behavior (the
- scripting support is not fully implemented yet and there is no SMIL
- animation support yet).
+ <p>The SVG implementation is not complete, and there is more work to do to
+ achieve a fully functional viewer.</p>
+ <p>Batik 1.1 supports all the static SVG features, linking and a limited
+ support for scripting. Design work has
+ started on dynamic features (scripting and SMIL animation) support.
</p>
<p>
The type of applications (e.g., transcoding applications) that can or will
@@ -309,7 +310,7 @@
xemacs, but there are many graphic authoring packages that can export SVG
documents
and that will let you author SVG content visually.</p>
<p>
- You can get a list of tools that can export SVG from the
+ You can get a list of tools exporting SVG from the
<link
href="http://www.w3.org/Graphics/SVG/SVG-Implementations#edit";>implementation</link>
section of the SVG Home page on the W3C web site. You can also
imagine building a tool on top of Batik: feel free to contribute!
@@ -423,10 +424,7 @@
<answer>
<p>
Batik is written in the Java language and requires a version 1.3
- implementation at this time. Note that the Batik team is working on
- removing the few dependancies that Batik has on 1.3-specific APIs
- so that users may choose to run Batik on JDK 1.2.2. Note, however,
- that performances on version 1.3 are much better.
+ implementation at this time.
</p>
</answer>
@@ -469,7 +467,7 @@
update is not supported).
</p>
<p>
- Batik can recognized the following scripting languages:
+ Batik can recognize the following scripting languages:
</p>
<ul>
<li>ECMAScript thanks to the <link
href="http://www.mozilla.org/rhino";>Mozilla Rhino</link> JavaScript engine included in
the distribution.
@@ -503,7 +501,7 @@
<answer><p>
When running from the source distribution you automatically get
the service provider entries for the Batik extension tags
- (regularPolygon, and star for example). We choose not to include
+ (regularPolygon, and star for example). We chose not to include
these by default in the binary distribution for the Batik
applications.
</p>
@@ -520,13 +518,12 @@
<answer><p>
You are using the binary distribution. This distribution does not
include support for our example extensions (they are just
- examples so other people can do much more interesting things).
+ examples and other people can do more sophisticated things).
</p>
<p>
- If you really want to view these examples (they aren't that
- interesting) you should arrange for lib/batik-extensions.jar to be
- on your class path.
+ If you want to view these examples you need to add lib/batik-extensions.jar to
+ your class path.
</p></answer>
</faq>
@@ -537,7 +534,7 @@
</question>
<answer>
- <p>Both FOP and Batik use the org.w3c.xxx packages. Depending on the
+ <p>Both FOP and Batik use the <code>org.w3c.xxx packages</code>. Depending
on the
version of FOP and Batik, Batik has been using a version of these
packages which is more recent than the one in the w3c.jar file FOP
uses. However, if the w3c.jar file which comes with the FOP distribution
1.32 +6 -9 xml-batik/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/index.xml,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -r1.31 -r1.32
--- index.xml 2001/11/05 14:57:24 1.31
+++ index.xml 2001/11/12 16:34:33 1.32
@@ -11,7 +11,7 @@
<!-- ========================================================================= -->
<!-- author [EMAIL PROTECTED] -->
-<!-- version $Id: index.xml,v 1.31 2001/11/05 14:57:24 vhardy Exp $ -->
+<!-- version $Id: index.xml,v 1.32 2001/11/12 16:34:33 vhardy Exp $ -->
<!-- ========================================================================= -->
<document>
<header>
@@ -38,8 +38,8 @@
<p>
The project's ambition is to give developers a set of core
modules which can be used together or individually to support
- specific SVG solutions. Example modules are, SVG parsers, SVG
- generators and SVG DOM implementations. Another ambition for
+ specific SVG solutions. Examples of modules are the SVG parsers, the SVG
+ generator and the SVG DOM implementation. Another ambition for
the Batik project is to make it highly extensible (for
example, Batik allows the developer to handle custom SVG
tags). Even though the goal of the project is to provide a
@@ -83,11 +83,8 @@
</p>
<p>
The SVG specification can be found on the
- <link href="http://www.w3.org/TR/SVG/";>W3C site</link>. Batik 1.0 is
conformant
- with the November 2nd, 2000 Candidate Recommendation Specification and its
- modifications which led to the Proposed Recommendation. <strong>The current
1.1rcN releases
- are (and the upcoming 1.1 release
- will be) conformant with the final recommendation of September 4th, 2001.
</strong></p>
+ <link href="http://www.w3.org/TR/SVG/";>W3C site</link>. Batik 1.1 is
conformant
+ with the final recommendation of September 4th, 2001.</p>
</s1>
<s1 title="Batik's Implementation Status">
@@ -107,7 +104,7 @@
<s1 title="Download Batik">
<p>
- You can get Batik on the
+ You can get the Batik distribution (source and binary) on the
<link href="dist">download page</link>.
</p>
<note>
1.8 +5 -5 xml-batik/xdocs/installing.xml
Index: installing.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/installing.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- installing.xml 2001/05/18 22:44:48 1.7
+++ installing.xml 2001/11/12 16:34:33 1.8
@@ -10,7 +10,7 @@
<!-- ========================================================================= -->
<!-- ========================================================================= -->
-<!-- version $Id: installing.xml,v 1.7 2001/05/18 22:44:48 vhardy Exp $ -->
+<!-- version $Id: installing.xml,v 1.8 2001/11/12 16:34:33 vhardy Exp $ -->
<!-- ========================================================================= -->
<document>
<header>
@@ -53,7 +53,7 @@
and download one or more ZIP file containing the distribution of your
choice. Here are
the various components you will find in the download area and their
intended use:</p>
<ul>
- <li><strong>batik-</strong><em>version</em><strong>.zip</strong>
(e.g., <em>batik-1.0beta.zip.</em>)
+ <li><strong>batik-</strong><em>version</em><strong>.zip</strong>
(e.g., <em>batik-1.1.zip.</em>)
contains a binary distribution
of Batik with executable JAR files that let you get started with
Batik easily. This
is the recommended distribution if you want to look at Batik's
features, or you want to
@@ -61,7 +61,7 @@
comes with a set of sample SVG files.</li>
<li><strong>batik-src-</strong><em>version</em><strong>.zip</strong>
- (e.g., <em>batik-src-1.0beta2.zip.</em>)contains a complete
+ (e.g., <em>batik-src-1.1.zip.</em>)contains a complete
snapshot of the Batik source code, documentation, regression tools
and utilities as
well as the script for building Batik. That distribution is a
snapshot of
the CVS repository. This is the recommended distribution for
developers who want
@@ -83,10 +83,10 @@
<li>Open a console and go to the directory where the distribution
was downloaded.</li>
<li>Unpack the distribution with Java's JAR utility:<br />
<code>jar xvf <distribution></code><br />
- For example, if you have downloaded batik-1.0beta2.zip into
/home/IamHere, type the
+ For example, if you have downloaded batik-1.1.zip into
/home/IamHere, type the
following at the command prompt:<br />
<code>cd /home/IamHere</code><br />
- <code>jar xvf batik-1.0beta2.zip</code><br />
+ <code>jar xvf batik-1.1.zip</code><br />
<strong>IMPORTANT:</strong> UNIX users, do not use the
<code>unzip</code> utility to
unpack the various Batik zip files, as this would not set the
directories access rights
properly.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
