-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.html
346 lines (320 loc) · 11.6 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
<html>
<head>
<title>Mimprint README</title>
</head>
<body bgcolor=white>
<center>
<h1>README</h1>
<h3>Mimprint<br>
v0.2.3 July 14, 2008</h3>
</center>
<p>
<h2>Contents</h2>
<ul>
<li><a href="#introduction">Introduction</a>
<li><a href="#homepage">Home Page</a>
<li><a href="#features">Features</a>
<li><a href="#documentation">Documentation</a>
<li><a href="#systemreqs">System Requirements</a>
<li><a href="#knownproblems">Known Problems</a>
<li><a href="#installjava">Installing Java</a>
<li><a href="#installmimprint">Installing Mimprint</a>
<li><a href="#source">Unpacking the Mimprint Source</a>
<li><a href="#running">Running Mimprint</a>
<li><a href="#feedback">Bug Reports and Feedback</a>
<li><a href="#author">Author</a>
</ul>
<p>
<a name="introduction"><h2>Introduction</h2></a>
<p>
Mimprint is an image printing and viewing program
written in Scala (100% Java-compatible) and distributed under the GPL.
In addition to providing a way to view and step through GIF and JPEG images,
it allows laying out multiple images at different sizes on one page
for printing.
<p>
<a name="homepage"><h2>Home Page</h2></a>
<p>
Go to the
<a href="http://www.alumni.caltech.edu/~jimmc/mimprint">
Mimprint home page</a>
to download the latest version of Mimprint.
<p>
<a name="features"><h2>Features</h2></a>
<ul>
<li>Licensed under GPL, freely redistributable with source.
<li>Written in Scala, runs on any standard Java Virtual Machine,
runs on Windows, Mac and Unix.
<li>Three viewing modes:
<ul>
<li>Printable mode allows collecting images onto a page for printing.
<li>SlideShow viewing mode allows easily stepping through a folder of
image files.
<li>Full screen mode scales images to fit in a full-window frame.
</ul>
<li>Images can be displayed on an alternate screen, such as for viewing
on an external display.
<li>Images can be displayed in a second window, which can be moved and
resized to fit an alternate screen when mimprint is
used in an environment in which the alternate screen is not detected
(such as can happen when using X remotely).
<li>View and edit image playlists.
<li>Browser with optional image icons
allows easy navigation of image directories.
<li>Browser allows easy navigation through collections of layout templates.
<li>Images can be dragged and dropped to any area in the printable page
from the browser, any other printable page area, or external programs.
<li>Images and directories can be annotated using text files.
<li>Prints a single image on a page, or multiple copies of a single image,
or multiple images, all at the same size or at different sizes
by using layout templates.
<li>Layout templates included for common layouts.
<li>Easy creation of custom layouts.
<li>Load/save custom layout templates.
</ul>
<p>
<a name="documentation"><h2>Documentation</h2></a>
<p>
Sorry, but there is no Users Guide yet.
<p>
Try this:
<ul>
<li>From the View menu, select Printable Screen Mode.
<li>In the Main List browser, from the Main List menu, enable
the option to show image icons in the list.
<li>In the browser on the left side of the screen, browse to the
templates/mixedsize folder.
You should see small images of the templates in the browser.
<li>Click on a template.
That layout should appear in the main window.
<li>Drag some images from the browser or your system's regular file
browser and drop them in the boxes.
<li>Explore the menus.
</ul>
<p>
For programmers, the scaladoc-generated
<a href="doc/api/index.html">API Reference</a>
provides detailed documentation on the packages and classes used in
Mimprint (available after you have <a href="#source">unpacked the source</a>).
<p>
<a name="systemreqs"><h2>System Requirements</h2></a>
<p>
<table border=1 width="100%">
</tr>
<tr><th>Item</th>
<th>Required</th>
<th>Why</th>
</tr>
<tr><td valign=top>Processor</td>
<td valign=top>700 MHz</td>
<td valign=top>Image rendering will be somewhat slow with older processors.
Faster processors will of course give better results.
</td>
</tr>
<tr><td valign=top>Memory</td>
<td valign=top>256 MB</td>
<td valign=top>Graphical Java programs tend to use a lot of memory.
Images take up a lot of memory.
</td>
</tr>
<tr><td valign=top>Disk</td>
<td valign=top>1 MB,<br>
plus up to 250 MB<br>to install Java</td>
<td valign=top>If you already have Java installed, installing Mimprint will
take less than 1 MB.
Installing Java takes 100 MB or more, depending on which version you
install, and whether or not you install the documentation.
</td>
</tr>
<tr>
<a name="javarequirements"></a>
<td valign=top>Java</td>
<td valign=top>JRE 1.5</td>
<td valign=top>Mimprint uses Drag and Drop.
<ul>
<li>On Linux, Java 1.5.0 or better is required; bugs in 1.4 cause
drag and drop not to work.
Printing in general is troublesome in Java on Linux.
<li>On Mac, Java 1.4.2 or better is required.
<li>On Windows, Java 1.4.2 or better is required.
Unfortunately, dragging from the browsing list is not working
on Windows; however, you can drag from Windows Explorer and
drop into the Printable page.
</ul>
</td>
</tr>
<tr><td valign=top>Operating<br>System</td>
<td valign=top>Windows, MacOS, Linux,<br>
or any other OS that<br>supports the required version of Java.
</td>
<td valign=top>For a list of platforms on which Java is available,
visit Sun's <a href="http://java.sun.com/cgi-bin/java-ports.cgi">
Java Platform Ports</a> page.
</td>
</tr>
</table>
<p>
<a name="knownproblems"><h2>Known Problems</h2></a>
<p>
<ul>
<li>On Windows, drag-and-drop from the file list into the printable image
window does not work.
Dragging from Windows Explorer into the image window works.
<li>On some versions of Linux, printing fails saying the printer is not
accepting jobs.
This is a problem with the way the Java VM interfaces to the system
print queues.
In general, Java Printing is problematic, and may not work on some
versions of Java on some platforms.
Sorry - try another version of Java.
</ul>
<p>
If you happen to know a solution to the above two problems,
please let me know.
Meanwhile, I am hoping that a future version of Java will fix
these problems.
<p>
<a name="installjava"><h2>Installing Java</h2></a>
<p>
To install Java on your system,
<a href="http://java.sun.com/j2se/1.5.0/download.jsp">download JRE1.5</a> -
or, if usable on your platform
(see the <a href="#javarequirements">Requirements</a> section above),
<a href="http://java.sun.com/j2se/1.4/download.html">download JRE1.4</a> -
from
<a href="http://java.sun.com/">Sun's Java web site</a>
and follow those installation directions.
When you are at that download page, look for the section that says
<a href="http://javashoplm.sun.com/ECom/docs/Welcome.jsp?StoreId=22&PartDetailId=jre-1.5.0_06-oth-JPR&SiteId=JSC&TransactionId=noreg">
Download JRE 5.0</a> (for Java 1.5) -
or, for Java 1.4.2,
<b>Download J2SE JRE</b> -
find your platform, and download the jre installer file.
<p>
<a name="installmimprint"><h2>Installing Mimprint</h2></a>
<p>
Mimprint is delivered in a self-extracting JAR file.
You must have Java running on your system in order to extract it.
<p>
To install Mimprint from the installation JAR file (.jar extension),
double-click on the JAR file, or run the command
<blockquote>
<code>
java -jar mimprint-<i>N_N_N</i>.jar
</code>
</blockquote>
where <i>N_N_N</i> is replaced by the Mimprint version number.
This will open a dialog allowing you to specify a destination directory,
and it will create a directory called mimprint-<i>N_N_N</i>
in the specified directory,
<p>
If you have problems running the installer, you can try running it with
the debugging flag turned on, which will cause it to print more information:
<blockquote>
<code>
java -Dmimprint.install.debug -jar mimprint-<i>N_N_N</i>.jar
</code>
</blockquote>
<p>
If you double-click on the installer in Windows and nothing happens,
open a DOS command window,
cd to the folder into which you downloaded the installer,
and enter the java command shown above.
Any error messages should now show up in the DOS window.
<p>
After running the installer, there is currently a manual step:
you must download the Scala development environment, then copy
the two files scala-compiler.jar and scala-library.jar into the
unpacked mimprint directory next to mimprint.jar.
<p>
<a name="source"><h2>Unpacking the Mimprint Source</h2></a>
<p>
If you want to build Mimprint yourself, or just look at the source code,
you will have to unpack the source files from the <code>src.zip</code>
archive file with the commands
<blockquote>
<code>cd mimprint-<i>N_N_N</i><br>
unzip src.zip</code>
</blockquote>
This will create a <code>src</code> directory with all of the Scala files,
as well as adding a few other files (such as a build.xml file)
to your mimprint directory.
You must have the
<a href="http://ant.apache.org/">ant</a> program installed on your
system in order to build Mimprint from source files.
<p>
You will also need a Scala development environment.
You can download this from the
<a href="http://www.scala-lang.org/">Scala web page</a>.
<p>
If you want to look at the scaladoc-generated API documentation
for the Java classes, you must first unpack those html files from
the <code>apidoc.zip</code> archive file with the commands
<blockquote>
<code>cd mimprint-<i>N_N_N</i><br>
unzip apidoc.zip</code>
</blockquote>
This will create the directory doc/api with all of the API documentation in it.
Alternatively, you can unpack <code>src.zip</code> and then run the command
<blockquote>
<code>ant doc</code>
</blockquote>
to run scaladoc and create the API documents from the source files
(you must have the
<a href="http://ant.apache.org/">ant</a> program
and the Scala development environment
installed on your
system in order to create the documentation using this command).
<p>
The Mimprint kit does not include the source to the JShortcut package.
You can download the JShortcut source from the
<a href="http://www.alumni.caltech.edu/~jimmc/jshortcut/">
JShortcut web site</a>,
or from the same location from which you downloaded Mimprint.
You do not need the JShortcut source to compile Mimprint;
the JShortcut.jar file included in the Mimprint kit is sufficient.
<p>
<a name="running"><h2>Running Mimprint</h2></a>
<p>
If you have not already done so, you must
<a href="#installjava">install Java</a>.
<h4>On Windows</h4>
<p>
On Windows,
open a terminal window and enter the command
<blockquote>
<code>mim</code>
</blockquote>
You can manually set up a shortcut to mim.bat,
after which you can just double-click on that shortcut to launch mimprint.
<h4>On Unix and Mac OS X</h4>
On Unix or Mac OS X, run
<blockquote>
<code>mim</code>
</blockquote>
optionally providing a starting directory.
You may need to modify the script on Unix platforms,
depending on how Java is installed.
<h4>Starting at a specified location</h4>
<p>
On any platform you can include a directory name,
playlist file or image file
when starting mimprint to tell it what to display.
Just include that name as the first argument after the above command,
like this:
<blockquote>
<code>mim /home/jimmc/photos/folder1</code>
</blockquote>
<p>
<a name="feedback"><h2>Bug Reports and Feedback</h2></a>
<p>
If you have a comment about Mimprint, or would like to report a bug,
please send email to domain j.jimmc.org, user mimprint.
<p>
<a name="author"><h2>Author and Contributors</h2></a>
<p>
Mimprint was written by Jim McBeath.<br>
<a href="http://www.alumni.caltech.edu/~jimmc">
http://www.alumni.caltech.edu/~jimmc</a>
</body>
</html>