eggification

[Photo.git] / Products / Photo / readme.txt

diff --git a/Products/Photo/readme.txt b/Products/Photo/readme.txt
new file mode 100755 (executable)
index 0000000..80b2183
--- /dev/null
+++ b/Products/Photo/readme.txt
@@ -0,0 +1,22 @@
+Photo product extends the default Zope Image product and add image resizing support.
+
+Thumbnail Support
+
+ You can get a thumbnail copy of a Photo instance by
+adding '/getThumbnail' in the request url.
+This thumbnail returned is a persistent standard 
+Zope Image instance. You can set thumbnail's creation
+parameters (height, width, filter and auto refreshing)
+into the Photo's property sheet.
+
+Volatile resizing support
+
+ You can also get a volatile copy of the Photo instance
+by adding '/getResizedImage' in the request url. The 
+default size is (800, 600) px. There is two ways to customize this size :
+
+- pass an optional parameter size = (width, height) to 'getResizedImage'
+
+- set the session variable named 'preferedImageSize' with a tuple (width, height)
+
+note : the request var name must be 'SESSION' (default value of Session Data Manager).
\ No newline at end of file