You are viewing a plain text version of this content. The canonical link for it is here.
Posted to batik-dev@xmlgraphics.apache.org by vh...@apache.org on 2001/05/18 17:36:33 UTC
cvs commit: xml-batik/xdocs/images svgviewerBrowsing.gif svgviewerPreferences.gif 1_0beta2splash.png svgviewerAOI.gif svgviewerDefaultRegular.jpg svgviewerFileOpen.gif svgviewerLocationBar.gif svgviewerMultipleFiles.gif svgviewerOpenPage.gif svgviewerPan.gif svgviewerThumbnail.gif svgviewerViewSource.gif svgviewerViewTree.gif svgviewerZoomin.gif
vhardy 01/05/18 08:36:32
Modified: xdocs extendingBatik.xml site-book.xml svgpp.xml
svgrasterizer.xml svgviewer.xml ttf2svg.xml
xdocs/images 1_0beta2splash.png svgviewerAOI.gif
svgviewerDefaultRegular.jpg svgviewerFileOpen.gif
svgviewerLocationBar.gif svgviewerMultipleFiles.gif
svgviewerOpenPage.gif svgviewerPan.gif
svgviewerThumbnail.gif svgviewerViewSource.gif
svgviewerViewTree.gif svgviewerZoomin.gif
Added: xdocs/images svgviewerBrowsing.gif svgviewerPreferences.gif
Log:
Updated SVG Browser documentation.
Revision Changes Path
1.7 +53 -54 xml-batik/xdocs/extendingBatik.xml
Index: extendingBatik.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/extendingBatik.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- extendingBatik.xml 2001/05/17 23:06:39 1.6
+++ extendingBatik.xml 2001/05/18 15:35:58 1.7
@@ -11,7 +11,7 @@
<!-- ====================================================================== -->
<!-- author Thomas.DeWeese@kodak.com -->
-<!-- version $Id: extendingBatik.xml,v 1.6 2001/05/17 23:06:39 deweese Exp $ -->
+<!-- version $Id: extendingBatik.xml,v 1.7 2001/05/18 15:35:58 vhardy Exp $ -->
<!-- ====================================================================== -->
<document>
@@ -147,13 +147,13 @@
<p>
The key class for building the DOM tree is the
- SVGOMDocument class. When an instance of this class
+ <code>SVGOMDocument</code> class. When an instance of this class
is constructed it searches for instances of the
<code>org.apache.batik.dom.svg.DomExtension</code>
Service Provider interface. It then calls the
'registerTags' method with it's self for each one.
This method typically calls
- registerCustomElementFactory for each tag that it
+ <code>registerCustomElementFactory</code> for each tag that it
wishes to handle.
</p>
@@ -163,19 +163,19 @@
To this end Batik provides a class you can extend:
<code>org.apache.batik.extension.PrefixableStylableExtensionElement</code>.
If you derive off this class you are only required to
- implement three methods: getLocalName,
- getNamespaceURI, and newNode (plus constructors). If
- all you are want is proper style support then you are
+ implement three methods: <code>getLocalName</code>,
+ <code>getNamespaceURI</code>, and <code>newNode</code> (plus constructors). If
+ all you want is proper style support then you are
done implementing your elements at this point.
</p>
<p>
- The distribution comes with two good examples
+ The distribution comes with two examples
<code>org.apache.batik.extension.svg.BatikStarElement</code>,
and
<code>org.apache.batik.extension.svg.BatikRegularPolygonElement</code>.
- These also include the required DomExtension instance to
- register the elements with the SVGOMDocument.
+ These examples also include the required <code>DomExtension</code> instance to
+ register the elements with the <code>SVGOMDocument</code>.
</p>
</s2>
@@ -195,7 +195,7 @@
<p>
The key class for managing this link is the
- BridgeContext class. This class maintains an
+ <code>BridgeContext</code> class. This class maintains an
association between a tag name with namespace and a
particular bridge instance that will handle it. The
work of constructing the proper entities in the GVT
@@ -205,13 +205,13 @@
<p>
New associations can be added by subclasses of the
- BridgeExtension Service Provider Interface. This
+ <code>BridgeExtension</code> Service Provider Interface. This
interface has a number of methods that provide
information about the particular extension being
registered (including contact information, and the
list of implemented extensions). It also has a
'registerTags' method which is responsible for
- registering the bridge instances with a BridgeContext.
+ registering the bridge instances with a <code>BridgeContext</code>.
The built in bridges are bundled with a
BridgeExtension as well as the two example extension
tags (in <code>org.apache.batik.extension.svg</code>),
@@ -219,7 +219,7 @@
</p>
<p>
- The Bridge interface it's self is very simple. It only
+ The <code>Bridge</code> interface itself is very simple. It only
includes methods to get the namespace and local name
of the tag the bridge is responsible for. This
interface is then extended for each of the major
@@ -300,9 +300,9 @@
<p>
Extension writers are free to work with any of the
above bridges, however the three most common are
- likely to be the GraphicsNodeBridge, the
- FilterPrimitiveBridge, and the PaintBridge. Each of
- these interfaces has several extremely useful
+ likely to be the <code>GraphicsNodeBridge</code>, the
+ <code>FilterPrimitiveBridge</code>, and the <code>PaintBridge</code>.
+ Each of these interfaces has several extremely useful
subclasses that handle much of the common behavior
among elements.
</p>
@@ -320,9 +320,9 @@
<s3 title="GraphicsNodeBridge">
<p>
The graphics node bridge is oriented around
- constructing a new GraphicsNode in the GVT tree.
- The GraphicsNode is the basic element that makes
- up the GVT tree. Each GraphicsNode has a 'paint'
+ constructing a new <code>GraphicsNode</code> in the GVT tree.
+ The <code>GraphicsNode</code> is the basic element that makes
+ up the GVT tree. Each <code>GraphicsNode</code> has a <code>paint</code>
method that is responsible for painting the object
(including considering clipping, masking,
filtering, and opacity for the node).
@@ -347,7 +347,7 @@
filled or stroked shape the easiest way is to
subclass either of the following classes. In this
case you are essentially only responsible for
- constructing a standard java Shape object to
+ constructing a standard java <code>Shape</code> object to
describe the desired area to operate on:
</p>
<dl>
@@ -394,35 +394,35 @@
<p>
The majority of classes for part of Batik are present
- in the batik.ext.awt.image.* package hierarchy which
+ in the <code>batik.ext.awt.image.*</code> package hierarchy which
contains a set of generally useful extensions to the
core JDK classes and methods.
</p>
<p>
- Note that the FilterPrimitiveBridge is invoked once
- for each reference to the filter tag that the filter
+ Note that the <code>FilterPrimitiveBridge</code> is invoked once
+ for each reference to the <code><filter></code> tag that the filter
primitive is part of. So if a filter effect is used a
- half dozen times the createFilter method will be
+ half dozen times the <code>createFilter</code> method will be
called a half dozen times, even though the tag may
only appear once in the file. This means that it is
safe for the Filters returned to be 'fixed' for a
- particular GraphicsNode being filtered.
+ particular <code>GraphicsNode</code> being filtered.
</p>
<p>
You will notice that Batik uses extended versions of
- the standard Renderable and Rendered image classes to
- provide additional information about surround
+ the standard <code>Renderable</code> and <code>Rendered</code>
+ image classes to provide additional information about surround
requirements for operations as well as a few
convenience methods. These interfaces are called:
<code>java.ext.awt.image.renderable.Filter</code> and
<code>java.ext.awt.image.rendered.CacheableRed</code>.
Batik contains simple wrapper classes that can take
- the default JDK Renderable and Rendered Image
+ the default JDK <code>Renderable</code> and <code>Rendered</code> Image
interfaces. Within the code base the convention 'Red'
- for classes implementing RenderedImage, and 'Rable'
- for classes implementing RenderableImage is commonly
+ for classes implementing <code>RenderedImage</code>, and 'Rable'
+ for classes implementing <code>RenderableImage</code> is commonly
used ('Red' is to be pronounced like the color, and
'Rable' is to be pronounced like 'horrible' with a
silent 'h').
@@ -430,8 +430,8 @@
<p>
The <code>FilterPrimitiveBridge</code> really has only
- one method right now: createFilter that must construct
- an instance of Filter to perform the required
+ one method right now: <code>createFilter</code> that must construct
+ an instance of <code>Filter</code> to perform the required
operation. This is still a fairly complex task given
the general need to support accessing the various
standard sources of image data. To this end there is
@@ -450,10 +450,9 @@
<code>ext.awt.image.renderable.AbstractRable</code>,
<code>ext.awt.image.rendered.AbstractRed</code>, and
<code>ext.awt.image.rendered.AbstractTiledRed</code>.
- The TiledRed ties into the Batik tile cache (only use
- this as your base class if you know what you are
- doing, as you are generally more likely to cause the
- tile cache to thrash than improve performance).
+ <code>TiledRed</code> ties into the Batik tile cache
+ (use this with caution as it is a complex area of
+ the Batik code and that code may be inadvertently broken).
</p>
<p>
@@ -467,14 +466,14 @@
<anchor id="paintBridge"/>
<s3 title="PaintBridge">
<p>
- The PaintBridge constructs an instance of the
+ The <code>PaintBridge</code> constructs an instance of the
<code>java.awt.Paint</code> to be used to fill or stroke
shapes/text (part of the paint server architecture of
SVG).
</p>
<p>
- Like the filter primitive bridge the paint bridge is
+ Like the filter primitive bridge the <code>PaintBridge</code> is
invoked for each reference to the paint. This makes
it possible to customize the Paint returned for the
particular element to be painted.
@@ -496,7 +495,7 @@
</p>
<p>
- The existing gradient Paint implementations are in
+ The existing gradient paint implementations are in
<code>ext.awt</code>, the pattern implementation is in
<code>gvt</code> since it requires access to gvt
internals.
@@ -512,26 +511,26 @@
When Batik encounters an 'image' element and it determines
the element does not reference an SVG file. It defers the
loading of the referenced image to
- org.apache.batik.ext.awt.image.spi.ImageTagRegistry. This
- class maintains a list of RegistryEntries, generally one
+ <code>org.apache.batik.ext.awt.image.spi.ImageTagRegistry</code>. This
+ class maintains a list of <code>RegistryEntries</code>, generally one
for each format.
</p>
<p>
Since the formats supported natively by Batik are also
- implemented through this mechanism. The JPEGRegistryEntry
- and PNGRegistryEntry should be used as good references for
+ implemented through this mechanism. The <code>JPEGRegistryEntry</code>
+ and <code>PNGRegistryEntry</code> should be used as good references for
extensions.
</p>
<s2 title="RegistryEntry">
<p>
- There are currently two flavors of RegistryEntry:
+ There are currently two flavors of <code>RegistryEntry</code>:
</p>
<dl>
<dt>URLRegistryEntry</dt>
<dd>
- These take a ParsedURL and try to decide if the URL
+ These take a <code>ParsedURL</code> and try to decide if the URL
is intended for them. This group is mostly
intended to handle alternate network protocols. It
can also be useful for interfacing with libraries
@@ -540,7 +539,7 @@
<dt>StreamRegistryEntry</dt>
<dd>
- These work with a markable InputStream. This is the
+ These work with a markable <code>InputStream</code>. This is the
preferred form of registry entry as it generally
avoids opening a potentially expensive connection
multiple times, instead it opens the stream once
@@ -553,7 +552,7 @@
<s2 title="Helper classes">
<p>
There exists quite a number of classes to assist in
- implementing a RegistryEntry. It is strongly
+ implementing a <code>RegistryEntry</code>. It is strongly
recommended that you review these classes and make use
of them where appropriate. They will likely save you
time and improve the integration with Batik.
@@ -562,7 +561,7 @@
<dt>MagicNumberRegistryEntry</dt>
<dd>
An abstract class that can handle the
- isCompatibleStream method for formats that make use
+ <code>isCompatibleStream</code> method for formats that make use
of "magic numbers". Magic numbers are a well known
sequence of bytes at a well known offset in the
file.
@@ -570,10 +569,10 @@
<dt>RedRable</dt>
<dd>
- This takes any java.awt.image.RenderedImage and
- wraps it into a 'Filter' (Batik's subclass of
+ This takes any <code>java.awt.image.RenderedImage</code> and
+ wraps it into a <code>Filter</code> (Batik's subclass of
RenderableImage). This is extremely useful for
- 'single resolution' file formats.
+ <em>single resolution</em> file formats.
</dd>
<dt>DeferRable</dt>
@@ -613,7 +612,7 @@
</p>
<p>
- ParsedURL offers a few advantages over the JDK's URL class.
+ <code>ParsedURL</code> offers a few advantages over the JDK's URL class.
First, it is designed to make minimal use of exceptions, so it
is possible to use it to parse a malformed URL and get "the
good parts". Second, it is extensible, so support for new
@@ -626,7 +625,7 @@
<p>
The service class is
- org.apache.batik.util.ParsedURLProtocolHandler. This
+ <code>org.apache.batik.util.ParsedURLProtocolHandler</code>. This
interface consists of three methods, one returns the protocol
to be handled, one is for parsing an absolute URL string and
one is for parsing relative URL strings. Both the parsing
@@ -635,7 +634,7 @@
</p>
<p>
- The ParsedURLData class holds all the data and implements the
+ The <code>ParsedURLData</code> class holds all the data and implements the
all the stream handling commands for the ParsedURL class.
This allows ProtocolHandlers to return custom subclasses for
particular protocols.
1.22 +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.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- site-book.xml 2001/05/11 14:52:39 1.21
+++ site-book.xml 2001/05/18 15:35:59 1.22
@@ -12,7 +12,7 @@
<!-- author stephane@hillion.org -->
<!-- author tkormann@apache.org -->
<!-- author vincent.hardy@eng.sun.com -->
-<!-- version $Id: site-book.xml,v 1.21 2001/05/11 14:52:39 vhardy Exp $ -->
+<!-- version $Id: site-book.xml,v 1.22 2001/05/18 15:35:59 vhardy Exp $ -->
<!-- ========================================================================= -->
<book title="Apache Batik documentation" copyright="2000-2001 The Apache Software Foundation">
@@ -42,8 +42,8 @@
<!-- Sample Applications Documentation -->
<!-- ================================= -->
<page id="toolsAndApps" label="Tools and Apps" source="demo.xml" />
- <page id="svgrasterizer" label="Rasterizer" source="svgrasterizer.xml" />
<page id="svgviewer" label="Browser" source="svgviewer.xml"/>
+ <page id="svgrasterizer" label="Rasterizer" source="svgrasterizer.xml" />
<page id="ttf2svg" label="Font Converter" source="ttf2svg.xml"/>
<page id="svgpp" label="Pretty-printer" source="svgpp.xml" />
1.4 +3 -1 xml-batik/xdocs/svgpp.xml
Index: svgpp.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/svgpp.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- svgpp.xml 2001/05/16 08:49:14 1.3
+++ svgpp.xml 2001/05/18 15:36:01 1.4
@@ -11,7 +11,7 @@
<!-- ========================================================================= -->
<!-- author stephane@hillion.org -->
-<!-- version $Id: svgpp.xml,v 1.3 2001/05/16 08:49:14 hillion Exp $ -->
+<!-- version $Id: svgpp.xml,v 1.4 2001/05/18 15:36:01 vhardy Exp $ -->
<!-- ========================================================================= -->
<document>
@@ -25,6 +25,8 @@
<body>
<s1 title="Introduction">
+
+ <!-- <figure src="images/svgppBanner.jpg" alt="Batik SVG Rasterizer" /> -->
<p>
This page describes the features of the SVG Pretty-printer utility that
1.6 +2 -2 xml-batik/xdocs/svgrasterizer.xml
Index: svgrasterizer.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/svgrasterizer.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- svgrasterizer.xml 2001/05/17 01:30:29 1.5
+++ svgrasterizer.xml 2001/05/18 15:36:02 1.6
@@ -11,7 +11,7 @@
<!-- ========================================================================= -->
<!-- author vincent.hardy@eng.sun.com -->
-<!-- version $Id: svgrasterizer.xml,v 1.5 2001/05/17 01:30:29 vhardy Exp $ -->
+<!-- version $Id: svgrasterizer.xml,v 1.6 2001/05/18 15:36:02 vhardy Exp $ -->
<!-- ========================================================================= -->
<document>
@@ -26,7 +26,7 @@
<body>
<s1 title="Introduction">
- <figure src="images/rasterizer.jpg" alt="Batik SVG Rasterizer" />
+ <!-- <figure src="images/rasterizerBanner.jpg" alt="Batik SVG Rasterizer" /> -->
<p>
This page describes the features of the SVG Rasterizer utility that
1.12 +162 -88 xml-batik/xdocs/svgviewer.xml
Index: svgviewer.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/svgviewer.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- svgviewer.xml 2001/05/17 01:30:28 1.11
+++ svgviewer.xml 2001/05/18 15:36:04 1.12
@@ -11,7 +11,7 @@
<!-- ========================================================================= -->
<!-- author vincent.hardy@eng.sun.com -->
-<!-- version $Id: svgviewer.xml,v 1.11 2001/05/17 01:30:28 vhardy Exp $ -->
+<!-- version $Id: svgviewer.xml,v 1.12 2001/05/18 15:36:04 vhardy Exp $ -->
<!-- ========================================================================= -->
<document>
@@ -25,18 +25,18 @@
<body>
<s1 title="Introduction">
- <figure src="images/viewer.jpg" alt="Batik Browser"/>
+ <!-- <figure src="images/viewerBanner.jpg" alt="Batik Browser"/> -->
<p>
This page describes the main features of the SVG Browser that comes with Batik.
It discusses the following:</p>
<ul>
- <li><link href="#downloading">Downloading the browser</link></li>
+ <li><link href="#downloading">Downloading and installing the browser</link></li>
<li><link href="#starting">Starting the browser</link></li>
- <li><link href="#viewing">Viewing an SVG file</link></li>
- <li><link href="#viewingMultiple">Viewing multiple SVG files</link></li>
- <li><link href="#viewingSource">Viewing the source</link></li>
- <li><link href="#viewingTree">Viewing the document tree</link></li>
- <li><link href="#zooming">Zooming, panning and rotating documents. Thumbnail</link></li>
+ <li><link href="#viewing">Viewing SVG documents</link></li>
+ <li><link href="#exportAndPrint">Printing and Converting SVG files</link></li>
+ <li><link href="#inspectingSVGSourceContent">Inspecting the SVG source</link></li>
+ <li><link href="#configuring">Configuring the SVG Browser</link></li>
+ <li><link href="#zooming">Navigating SVG documents (zooming, panning, rotating, transform, thumbnail)</link></li>
</ul>
</s1>
@@ -47,6 +47,8 @@
<p>Refer to the <link href="dist">download area</link> to find out how to
download Batik. Remember that you can get either the developer distribution
or the binary distribution.</p>
+ <p>Refer to the <link href="install.html">installation page</link> for instructions
+ on how to install the Batik download on your system.</p>
</s1>
<anchor id="starting" />
@@ -68,7 +70,7 @@
<p>Where:</p>
<ul>
<li><em>-font-size <fontSize></em> will make the browser use small fonts in the GUI.</li>
- <li><em>[svgURL]</em> the URL for the SVG file the browser should open when it starts</li>
+ <li><em>[svgURL]*</em> the URLs for the SVG files the browser should open when it starts</li>
</ul>
<p>For example:</p>
<ul>
@@ -102,152 +104,213 @@
This will start the browser</li>
</ul>
<p>You can pass options to the browser as follows:</p>
- <p><strong>Windows: </strong><em>build svgbrowser [-font-size <fontSize>] [svgURL]</em></p>
- <p><strong>UNIX: </strong><em>build.sh svgbrowser [-font-size <fontSize>] [svgURL]</em></p>
+ <p><strong>Windows: </strong><em>build svgbrowser [-font-size <fontSize>] [svgURL]*</em></p>
+ <p><strong>UNIX: </strong><em>build.sh svgbrowser [-font-size <fontSize>] [svgURL]*</em></p>
<p>Refer to "Starting the browser for the binary distribution" for an explanation of these
options</p>
</s2>
<s2 title="SVG browser screen shot">
-
+ <p>The following image shows the result of starging the browser, in the binary or
+ developer distribution, with the <code>-font-size 10 samples/batikFX.svg</code> options.</p>
<figure src="images/svgviewerDefaultRegular.jpg" alt="Batik Browser"/>
</s2>
</s1>
<anchor id="viewing"/>
- <s1 title="Viewing an SVG file">
- <p>There are several ways to view an SVG file. The following sections explain each method</p>
+ <s1 title="Viewing SVG Files">
+ <p>There browser has several features to view and browse SVG files:</p>
+ <ul>
+ <li><link href="#localFile">Opening a local SVG file</link></li>
+ <li><link href="#urlFile">Opening an SVG file from the web</link></li>
+ <li><link href="#locationBar">Using the location text field to view an SVG file</link></li>
+ <li><link href="#browsing">Browsing SVG files</link></li>
+ <li><link href="#viewingMultiple">Viewing multiple SVG files</link></li>
+ </ul>
+ <anchor id="localFile" />
<s2 title="Opening a local SVG file">
- <figure src="images/svgviewerFileOpen.gif" alt="File Open in SVG Browser"/>
<p>In situations where you have an SVG file locally on the machine where you are running the
Batik SVG browser, you can use the "File->File Open" menu item to open that file, or use
the "Ctrl-F" key accelerator. Doing so brings up a file choser that lets you select the file
you want to view.</p>
+ <figure src="images/svgviewerFileOpen.gif" alt="File Open in SVG Browser"/>
+
</s2>
+ <anchor id="urlFile" />
<s2 title="Opening an SVG file from the Web">
- <figure src="images/svgviewerOpenPage.gif" alt="Open Page in SVG Browser"/>
<p>There are many situations where the SVG content you want to view is not local to the machine
where the browser is running. In that case, you can use the "File->Open Page" menu item, or use
the "Ctrl-O" key accelerator to open that page. Doing so brings up a dialog box where you
can type in the URL for the file you want to view.</p>
+ <figure src="images/svgviewerOpenPage.gif" alt="Open Page in SVG Browser"/>
+
</s2>
+ <anchor id="locationBar" />
<s2 title="Using the location text field to view an SVG file">
- <figure src="images/svgviewerLocationBar.gif" alt="Location Bar in SVG Browser"/>
<p>When you know the URL of the document you want to view, you can enter it directly in
the location bar text field at the top of the SVG browser, the same way you can enter a
URL in an HTML browser</p>
+ <figure src="images/svgviewerLocationBar.gif" alt="Location Bar in SVG Browser"/>
</s2>
- <s2 title="Setting up a proxy server for the Batik SVG browser">
+ <anchor id="browsing" />
+ <s2 title="Browsing SVG Files">
- <p>When you are accessing the Web through a firewall and the SVG content you want to
- access is on the Web, you will need to use a proxy server to access that content,
- the same way you need to set up a proxy server for your HTML browser. </p>
- <p>For users of the binary distribution, you need to type, at the command prompt:</p>
- <p><em>java -Dhttp.proxyHost=<proxyHost> -Dhttp.proxyPort=<proxyPort> -jar batik-svgbrowser.jar</em></p>
- <p>For example, if your proxy is firewall.eng.mycompany.com on port 8080:</p>
- <p><em>java -Dhttp.proxyHost=firewall.eng.mycompany.com -Dhttp.proxyPort=8080 -jar batik-svgbrowser.jar</em></p>
- <p />
- <p>For users of the developer distribution, you need to edit the <em>build.xml</em> file
- in the root directory to set the equivalent properties:</p>
- <source>
- <java fork="yes"
- classname="${class-prefix}.apps.svgbrowser.Main"
- jvmargs="-DproxyHost=firewall.eng.mycompany.com -DproxyPort=8080">
- <classpath>
- <pathelement location="${dest}" />
- <path refid="libs-classpath"/>
- <pathelement location="resources" />
- </classpath>
- <arg value="${args}"/>
- </java>
- </source>
+ <p>As with HTML content, it is common to navigate back and forth between SVG files (remember that
+ SVG files contain hyperlinks, just like HTML does) and, as described later in this document,
+ it is possible to zoom into SVG documents, pan and rotate.</p>
+ <figure src="images/svgviewerBrowsing.gif" alt="Browsing SVG files" />
+ <p>The Batik browser offers multiple features to help you browse SVG files:</p>
+ <ul>
+ <li><strong>Navigating between files</strong>. The "Go->Back" menu item (or the Ctrl-left arrow
+ keyboard acceleration) and the "Go->Forward" (or the Ctrl-right arrow keyboard acceleration)
+ let you move to the previous and next visited SVG documents</li>
+ <li><strong>History</strong>. The "Go" menu also contains a list of the visited SVG documents,
+ which gives you a way to randomly access any document you have already visited.</li>
+ <li><strong>Navigation between views</strong>. The "View->Previous Transform" menu item (Ctrl-L)
+ and the "View->Next Transform" menu item (Ctrl-N) let you go to the previous or next view
+ you have had of a document. This is useful when, for example, you pan or rotate and document
+ and want to go back to any previous view you had of the document (i.e., before you panned or
+ rotated it).</li>
+ </ul>
</s2>
- </s1>
-
<anchor id="viewingMultiple" />
- <s1 title="Viewing multiple SVG files">
+ <s2 title="Viewing multiple SVG files">
<figure src="images/svgviewerMultipleFiles.gif" alt="Viewing multiple files" />
<p>The Batik SVG Browser can display multiple files simultaneously in different windows. To view a
new file in a separate window, simply select the "File-> New Window..." menu item or use
the Ctrl-N keyboard accelerator.</p>
+ </s2>
+
+ <s2 title="Reloading an SVG document">
+
+ <p>When working on an SVG document, you may want the browser to reprocess a document that you
+ have modified. The "File-> Reload" menu item or the Ctrl-R keyboard accelerator will cause the
+ document to be reprocessed by the browser.</p>
+ </s2>
+ </s1>
+
+ <anchor id="exportAndPrint" />
+ <s1 title="Exporting and Printing SVG documents">
+ <p>The "File->Print" menu will print the currently displayed SVG document when selected.</p>
+ <p>The "File->Export As" menu offers the option to export the currently displayed SVG document
+ to various raster formats. Currently, the browser supports the PNG, JPEG and TIF formats.</p>
</s1>
+ <anchor id="inspectingSVGSourceContent" />
+ <s1 title="Inspecting the SVG Source">
+
+ <p>The browser offers two ways to inspect the source of an
+ SVG document: viewing the plain source or viewing the
+ document tree. Both are explained hereafter.</p>
<anchor id="viewingSource" />
- <s1 title="Viewing the source">
+ <s2 title="Viewing the source">
<figure src="images/svgviewerViewSource.gif" alt="Viewing the source code" />
<p>When the browser displays an SVG file, you can select
the "View-> View Source..." menu item or use the Ctrl-U keyboard accelerator to view the
source code.</p>
- </s1>
+ </s2>
<anchor id="viewingTree" />
- <s1 title="Viewing the document tree">
+ <s2 title="Viewing the document tree">
<figure src="images/svgviewerViewTree.gif" alt="Viewing the document tree" />
<p>When the browser displays an SVG file, you can select the "View-> View Document Tree..."
menu item or use the Ctrl-T keyboard accelerator to open a dialog that shows the SVG
document in the form of a tree. The dialog lets you navigate the tree, select individual
elements, such as a filter element, and view the attributes and CSS values that apply to
these elements.</p>
+ </s2>
</s1>
- <anchor id="zooming" />
- <s1 title="Zooming, panning and rotating documents">
-
- <s2 title="Zooming in">
- <figure src="images/svgviewerZoomin.gif" alt="Zooming in an SVG document" />
- <figure src="images/svgviewerAOI.gif" alt="Zooming in an SVG document" />
- <p>There are several methods to zoom in an SVG Document:</p>
+ <anchor id="configuring"/>
+ <s1 title="Configuring the SVG Browser">
+
+ <p>The "Edit->Preferences" menu brings up the dialog box shown in the following
+ figure.</p>
+ <figure src="images/svgviewerPreferences.gif" alt="Configuring the SVG Browser" />
+
+ <p>This dialog contains several types of options, which can be selected with
+ the left-hand side list. For each type of option, a panel lets you configure various
+ browser parameters:</p>
+ <ul>
+ <li><strong>Network Options Panel</strong>. This panel lets you configure the
+ proxy server to use if you are working from behind a firewall.</li>
+ <li><strong>Languages Panel</strong>. This is the panel shown in the above
+ figure. That panel lets you select your languages. The user language can
+ be used in SVG documents to chose between alternate contents. For example,
+ open the samples/moonPhases.svg example. Then, change the user language to
+ french and reload the document (Ctrl-R). You will see that the text is now
+ displayed in french. You can do the same with Japanese and the text will be
+ shown in Japanes.</li>
+ <li><strong>Browser Options Panel</strong>. This panel lets you choose some
+ optional behaviors:
<ul>
- <li>You can select the "View -> Zoom In" menu item</li>
- <li>You can click on the "Zoom In" tool bar button (the one that shows a magnifying glass
- with a "+" sign)</li>
- <li>You can use the "Ctrl+Shift+P" keyboard acceleration</li>
- <li>If the mouse is over the document in the display area, you can press the Ctrl key
- then click the left mouse button and drag to select the area of interest in the document</li>
- </ul>
- </s2>
+ <li>Show Rendering. When on, the browser will update the canvas
+ while processing an SVG document. This turns on progressive rendering.</li>
+ <li>Auto Adjust Window. When on, the browser window is resized to fit
+ any newly loaded document</li>
+ <li>Enable Double Buffering. When on, the browser uses additional
+ memory resources which improves the quality of effects such as zooming
+ and panning.</li>
+ <li>Show debug traces. When on, so debug messages will be printed to
+ the standard output. This is only for developers.</li>
+ </ul>
+ </li>
+ <li><strong>Stylesheet Panel</strong>. This panel lets you specify a user
+ stylesheet which can override some of the default settings in viewed SVG
+ documents. This might be useful if you want, for example, to override the
+ font face used in text elements.</li>
+ </ul>
+ </s1>
+ <anchor id="zooming" />
+ <s1 title="Navigating SVG documents: Zooming, panning, rotating, transform and thumbnail">
- <s2 title="Zooming out">
- <figure src="images/svgviewerZoomout.gif" alt="Zooming out an SVG document" />
- <p>There are several methods to zoom out in an SVG Document:</p>
+ <p>The Batik browser offers multiple way to navigate SVG documents:</p>
+ <ul>
+ <li><link href="#zoomInOut">Zooming in and out</link></li>
+ <li><link href="#panning">Panning</link></li>
+ <li><link href="#rotating">Rotating</link></li>
+ <li><link href="#transform">Arbitrary Transforms</link></li>
+ <li><link href="#thumbnail">Thumbnail</link></li>
+ </ul>
+
+ <anchor id="zoomInOut" />
+ <s2 title="Zooming in and out">
+ <p>There are several methods to zoom in or out an SVG Document:</p>
<ul>
- <li>You can select the "View -> Zoom Out" menu item</li>
- <li>You can click on the "Zoom Out" tool bar buttom (the one that shows a magnifying glass
- with a "-" sign)</li>
- <li>You can use the "Ctrl+Shift+O" keyboard acceleration</li>
+ <li>You can select the "View -> Zoom In/Out" menu item</li>
+ <li>You can click on the "Zoom In/Out" tool bar button (the ones that show a magnifying glass
+ with a "+/-" signs)</li>
+ <li>You can use the "Ctrl+I" and "Ctrl+O" keyboard acceleration</li>
+ <li>If the mouse is over the document in the display area, you can press the Ctrl key
+ then click the left mouse button and drag to select the area of interest in the document.
+ This can only be used to zoom into a document.</li>
+ <li>If the mouse is over the document in the display area, you can press the Shift key
+ then click the right mouse button and drag it. This is called the 'real time' zoom
+ and can be used both for zooming in and out.</li>
</ul>
- </s2>
- <s2 title="Restoring the original size of a document">
- <figure src="images/svgviewerZoomRestore.gif" alt="Restoring the initial zoom in an SVG document" />
- <p>Sometimes, after zooming, panning and rotating a document, it is useful to be able
- to restore its original size, i.e., view it as it was first loaded:</p>
- <ul>
- <li>You can select the "View -> Initial Zoom" menu item</li>
- <li>You can click on the "Initial Zoom" tool bar buttom (the one that shows a square with four
- arrows pointing in the North, East, South and West directions)</li>
- <li>You can use the "Ctrl+1" keyboard acceleration</li>
- </ul>
+ <figure src="images/svgviewerZoomin.gif" alt="Zooming in an SVG document" />
+ <figure src="images/svgviewerAOI.gif" alt="Zooming in an SVG document" />
</s2>
-
+
+ <anchor id="panning" />
<s2 title="Panning a document">
- <figure src="images/svgviewerPan.gif" alt="Panning in an SVG document" />
<p>Some documents are too big to fit into the browser, especially when you zoom in with a
large zoom factor. In these circumstances, it is usefull to be able to 'move around' the
document and pan to view different parts of the documents. Again, there are multiple ways
@@ -256,31 +319,42 @@
<li>With the mouse cursor over the SVG document, press the Shift key and then
click and drag the left mouse button to a new location. When you release the
mouse, the document will be translated to the new mouse location.</li>
- <li>If you have the thumbnail open, you can select the market showing the current
+ <li>If you have the thumbnail open, you can select the marker showing the current
area of interest and move it to the desired location</li>
</ul>
+ <figure src="images/svgviewerPan.gif" alt="Panning in an SVG document" />
</s2>
+ <anchor id="rotating" />
<s2 title="Rotating a document">
- <figure src="images/svgviewerRotate.gif" alt="Rotating an SVG document" />
<p>It is sometimes useful to be able to rotate a document (maps for example). You can
do this in the Batik browser by first pressing the Ctrl key and then clicking and dragging
- the right mouse button to a new location. A marker will show the rotation angle corresponding
- to the new mouse cursor location. When you are satisfied with that angle, you can release
- the mouse button and the document will be displayed with the rotation you have specified.
+ the right mouse button to a new location. The browser will dynamically rotate the image
+ as you move your cursor. When you are satisfied with that angle, you can release
+ the mouse button and the document will be displayed with that new angle.
</p>
</s2>
+ <anchor id="transform" />
+ <s2 title="Using the Transform Dialog">
+
+ <p>While the mouse and keyboard interactions give interactive way to navigate an
+ SVG document, it is sometimes desirable to be able to define precisely the
+ amount of zoom, pan or rotation desired. The Transform dialog, available through
+ the "View->Transform" (Ctrl-S) menu offers that feature.</p>
+ </s2>
+
+ <anchor id="thumbnail" />
<s2 title="Thumbnail">
- <figure src="images/svgviewerThumbnail.gif" alt="SVG Browser Thumbnail" />
<p>Panning in the document window can be difficult after you have zoomed into a document
because you cannot see the whole document. Panning on large documents (or with a large
zoom factor) is made easy by the thumbnail that you can bring up through the
- "View -> View Document Thumbnail" menu item or Ctrl-O keyboard acceleration. The
+ "View -> Thumbnail" menu item or Ctrl-Y keyboard acceleration. The
thumbnail shows a rectangular marker that represents the "Area of Interest", i.e., the
region currently displayed in the window (the visible portion of the document). You
can grag that little marker with the left mouse button and drag it to another area
of interest to view a different portion of the document in the main window.</p>
+ <figure src="images/svgviewerThumbnail.gif" alt="SVG Browser Thumbnail" />
</s2>
</s1>
1.3 +4 -1 xml-batik/xdocs/ttf2svg.xml
Index: ttf2svg.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/ttf2svg.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ttf2svg.xml 2001/05/11 14:52:40 1.2
+++ ttf2svg.xml 2001/05/18 15:36:06 1.3
@@ -11,7 +11,7 @@
<!-- ========================================================================= -->
<!-- author vincent.hardy@eng.sun.com -->
-<!-- version $Id: ttf2svg.xml,v 1.2 2001/05/11 14:52:40 vhardy Exp $ -->
+<!-- version $Id: ttf2svg.xml,v 1.3 2001/05/18 15:36:06 vhardy Exp $ -->
<!-- ========================================================================= -->
<document>
@@ -25,6 +25,9 @@
<body>
<s1 title="Introduction">
+
+ <!-- <figure src="images/ttf2svgBanner.jpg" alt="Batik SVG Rasterizer" /> -->
+
<p>The True Type Font to SVG (<code>ttf2svg</code>) application lets you convert
some character ranges from the True Type Font format to the SVG Font format.</p>
<p>This page describes:</p>
1.3 +456 -500 xml-batik/xdocs/images/1_0beta2splash.png
<<Binary file>>
1.2 +224 -116 xml-batik/xdocs/images/svgviewerAOI.gif
<<Binary file>>
1.2 +200 -187 xml-batik/xdocs/images/svgviewerDefaultRegular.jpg
<<Binary file>>
1.2 +160 -71 xml-batik/xdocs/images/svgviewerFileOpen.gif
<<Binary file>>
1.2 +183 -379 xml-batik/xdocs/images/svgviewerLocationBar.gif
<<Binary file>>
1.2 +178 -204 xml-batik/xdocs/images/svgviewerMultipleFiles.gif
<<Binary file>>
1.2 +128 -64 xml-batik/xdocs/images/svgviewerOpenPage.gif
<<Binary file>>
1.2 +180 -117 xml-batik/xdocs/images/svgviewerPan.gif
<<Binary file>>
1.2 +91 -141 xml-batik/xdocs/images/svgviewerThumbnail.gif
<<Binary file>>
1.2 +329 -303 xml-batik/xdocs/images/svgviewerViewSource.gif
<<Binary file>>
1.2 +210 -197 xml-batik/xdocs/images/svgviewerViewTree.gif
<<Binary file>>
1.2 +81 -73 xml-batik/xdocs/images/svgviewerZoomin.gif
<<Binary file>>
1.1 xml-batik/xdocs/images/svgviewerBrowsing.gif
<<Binary file>>
1.1 xml-batik/xdocs/images/svgviewerPreferences.gif
<<Binary file>>
---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xml.apache.org
For additional commands, e-mail: batik-dev-help@xml.apache.org