readme.txt

JPluck是一个基于Java的工具集

=======================================================================
                           JPLUCK 0.9 BETA 6
=======================================================================

15 March 2003
Laurens M. Fridael <[e-mail]>
http://jpluck.sourceforge.net/
(C)2002-2003 L.M. Fridael

JPluck lets you convert web sites to Plucker documents. It creates 
Plucker documents ready to be installed and read with the Plucker Viewer 
for the Palm OS platform or the Opie-Reader for the Sharp Zaurus.

You can find more information on the site.


=======================================================================
                                Contents
=======================================================================

- JPluck X GUI application to manage and convert sites.

- JPluck C command-line utility to run conversions automatically.

- Binder command-line utility to collect, bundle and index, web pages as 
a Plucker document.

- HotSync Conduit (Windows only) Conduit that runs JPluck automatically 
at HotSync.

- Plucker Viewer 1.2 (English) The viewer for Palm OS bundled as a 
convenience for new users. This is the standard resolution viewer. A 
hires version is under development. See http://hires.plkr.org/ to 
download the latest snapshots. You can find localized versions of the 
viewer at http://www.plkr.org/.

- Showcase JXL containing 250+ PDA-friendly sites Load the file 
"showcase.jxl" into JPluck X using File -> Open. You can copy the sites 
that you want to your own JXLs. Do not modify the showcase JXL itself. A 
new installation/update will overwrite the existing copy.

- Sample XSLT stylesheets Stylesheets to transform the sites Common 
Dreams and The Register to PDA-friendly format. Also includes a 
stylesheet for transforming RSS feeds.


=======================================================================
                              Requirements
=======================================================================

JPluck requires Java 1.4.1 or higher to run. (JPluck also runs with Java 
1.4.0 but it is strongly recommended that you use 1.4.1.) For the JPluck 
Developer package you need Ant to build the binaries from the source.

NOTE: If you downloaded the Windows distribution with the Java Runtime 
Environment included you don't need to install Java separately.

You can download the latest Java from http://java.sun.com/getjava/. Java 
1.4.1 is currently available for Windows, Linux and Solaris. Java 1.4.1 
for Mac OS X will be released in the near future but users have reported 
that the JPluck also works with the JDK 1.4.1 Developer Preview 
available from http://developer.apple.com/java/.

JPluck is pure Java and does not require anything but a working Java 
Runtime Environment. (For development you need a full JDK.) JPluck does 
not contain any dependencies on the existing Plucker tools. 


=======================================================================
                       Running JPluck on Windows
=======================================================================

The Windows installer sets up Start Menu entries automatically. Look in 
the program group "JPluck". There you will find the item "JPluck X".

JPluck C (jpluckc.exe) and Binder (binder.exe) should be started from 
the command-line. Type "jpluckc -help" or "binder -help" for a list of 
command-line options.

-----------------------------------------------------------------------
Using a specific Java Runtime Environment
-----------------------------------------------------------------------

JPluck can use a specific Java Runtime Environment (JRE), other than the 
system default. This way you don't need to have Java 1.4 set as the 
default runtime.

jpluckx.exe -jre \path\to\jre <options> jpluckc.exe -jre \path\to\jre 
<options>

Do not place a trailing slash after the directory name.


-----------------------------------------------------------------------
Uninstalling
-----------------------------------------------------------------------

Run the uninstaller from Control Panel -> Add/Remove Programs. The 
uninstallation procedure also unregisters the HotSync conduit.

WARNING: The uninstaller will delete all files in the "xsl" 
subdirectory. If you have placed your own stylesheets there you should 
copy them elsewhere first.


=======================================================================
                  Running JPluck on Linux and Mac OS X
=======================================================================

Open a terminal, change to the directory where you installed JPluck and 
type the following:

JPluck X: "java -Xmx128m -jar jpluckx.jar".

JPluck C: "java -Djava.awt.headless=true -Xmx128m -jar jpluckc.jar".

Binder: "java -jar binder.jar"

The -Xmx parameter instructs Java to use a maximum heap size of 128Mb. 
The default is 64Mb which may be too little for very large plucks (1000+ 
pages). The -Djava.awt.headless parameter ensures that images can be 
processed if you don't have an X server running. By default, the Sun VM 
requires an X server for graphical operations.

Append the "-help" option to see command-line options.

(For Linux there are convenience shell scripts in the "bin" 
subdirectory.)

To uninstall JPluck, simply remove the directory. The cache and the 
settings are maintained in <user home>/.jpluck.


=======================================================================
                              Known Issues
=======================================================================

- Splash screen not shown on Mac OS X

The splash screen is still not displayed right with the Apple JDK 1.4.1 
final release. The "Show splash screen on startup" setting in the 
Options dialog has no effect.

- Syncing to memory cards

Syncing to memory cards does not work on the Handera 330.


=======================================================================
                           Plucker Viewer
=======================================================================

For your convenience, a copy of the Plucker Viewer 1.2 for Palm OS is 
included in the distribution. You can find the viewer binaries in the 
subdirectory "viewer". The Windows installer contains the option to 
install Plucker automatically. This queues the program files for the 
next HotSync.

See http://www.plkr.org/ for more information on Plucker. There you will 
also find links to the latest builds. Plucker 1.2 is the most recent 
official release as of this writing.

Plucker is free software, licensed under the GNU General Public License.


=======================================================================
          Building from the source (JPluck developer package)
=======================================================================

The source code is only available in the JPluck Developer package.

------------------------------------------------------------------------
                                  Java
------------------------------------------------------------------------

The JPluck Developer package comes with an Ant build file. Download Ant 
from http://jakarta.apache.org/ant/.

You can build the binaries using the following command:

	ant jar

To view project help with a description of all available targets use the 
following command:

	ant -projecthelp

------------------------------------------------------------------------
                                 Delphi
------------------------------------------------------------------------

The Delphi source code for the EXE launchers, the HotSync conduit, and 
two JNI DLLs can be found in the directory "delphi". The binaries were 
compiled using Delphi 5.


=======================================================================
                    Notes about modifying the source
=======================================================================

The source code is a bit of a mess. I recommend you do not make changes 
because the library and the API are in a state of flux at the moment. 
The goal is to get JPluck 1.0 final out the door, clean up the source 
for the 1.1 release, and then open a CVS repository where users can make 
check out the latest source and make active contributions. I believe it 
is better to start a community effort from a clear and maintainable 
source base.

That said, JPluck is licensed under the GPL so you are still allowed to 
modify and redistribute it according to the GPL terms.


=======================================================================
                                License
=======================================================================

JPluck is open source software released under the GNU General Public 
License. See the file "LICENSE" for details.

For the licenses of the third-party libraries, see the subdirectory 
"licenses".


=======================================================================
                                Credits
=======================================================================

JPluck is written and maintained by Laurens M. Fridael. 
<[e-mail]>

The JPluck X splash screen was created by DDrake. (not a typo)

The Showcase JXL was contributed by Shehu Dikko.

Many thanks to the following people who helped out in various ways: Andy 
Clark, Shehu Dikko, Paul Gilbert, Tony McNamara, Florent Pitoun, Edward 
Rayl, Alan J Robertson, Pablo Rodriguez, Daniel Wanja, Tim Wentford, and 
the Plucker development team (Michael Nordstr鰉 et al) for providing 
technical information.

Special thanks to Karsten Lentzsch of JGoodies for providing a Looks 
license free of charge. http://www.jgoodies.com/

Thanks to everyone who gave feedback, either by e-mail, through the 
SourceForge message boards, or through the Plucker mailing lists.