changeset 183:250f3b8762e4

updated Scaler docu
author robcast
date Tue, 25 Nov 2003 16:18:40 +0100
parents 31367c3c8202
children 754c90861f95
files servlet/doc/Scaler.html
diffstat 1 files changed, 26 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/servlet/doc/Scaler.html	Fri Nov 21 00:30:04 2003 +0100
+++ b/servlet/doc/Scaler.html	Tue Nov 25 16:18:40 2003 +0100
@@ -1,8 +1,9 @@
-<HTML>
-<HEAD>
+<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
+<html>
+<head>
 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
 <TITLE>Scaler servlet</TITLE>
-</HEAD>
+</head>
 <BODY>
 <H1>Scaler</H1>
 
@@ -14,7 +15,7 @@
 <code>Scaler/request_path/?param1=value1&param2=value2&...</code>
 Unknown parameters will be silently ignored.</p>
 
-<p>Recognised parameters:
+<p>Recognised parameters:</p>
 <ul>
   <li><b>request_path</b> path to file or directory.</li>
 
@@ -126,9 +127,26 @@
   <code>osize</code> mode.</li>
   
 </ul>
-The image will be scaled equally in horizontal and vertical direction such that
-the resulting image does not exceed the rectangle <code>[ww,wh]</code>.
-</p>
+
+  <p>The image to be loaded can be specified by the
+  <code>request_path</code> (deprecated) or the <code>fn</code> 
+   (preferred) parameter and the optional index <code>pn</code></p>
+  <ul>
+      <li> if <code>fn</code> points to a directory then the file with
+      the index <code>pn</code> (in alphabetical order according to
+      ASCII) will be loaded</li>
+
+      <li>if <code>fn</code> points to a file (with or without
+      extension) then this file will be loaded</li>
+  </ul>
+
+  <p>The image will be scaled equally in horizontal and vertical
+  direction such that the resulting image does not exceed the rectangle
+  <code>[dw,dh]</code>. If only either height or width is given the
+  image is scaled to match only the given parameter. The size of the
+  resulting image in the other parameter is determined by the aspect
+  ratio of the image.
+  </p>
 
 </BODY>
-</HTML>
+</html>