|
|
@@ -1,28 +1,28 @@
|
|
|
Thumbnail Creation of images
|
|
|
============================
|
|
|
|
|
|
-This plugin creates thumbnails for all of the images found under a specific directory, in various thumbnail sizes
|
|
|
-It requires `PIL` to function properly since `PIL` is used to resize the images, and will only rebuild a thumbnail if it
|
|
|
-doesn't already exists (to save processing time)
|
|
|
+This plugin creates thumbnails for all of the images found under a specific directory, in various thumbnail sizes.
|
|
|
+It requires `PIL` to function properly since `PIL` is used to resize the images, and the thumbnail will only be re-built
|
|
|
+if it doesn't already exist (to save processing time).
|
|
|
|
|
|
Installation
|
|
|
-------------
|
|
|
|
|
|
-Set up like a normal plugin by setting `PLUGIN_PATH`, and adding `thumbnailer` to the `PLUGINS` list.
|
|
|
+Set up like any other plugin, making sure to set `PLUGIN_PATH` and add `thumbnailer` to the `PLUGINS` list.
|
|
|
|
|
|
[PIL](http://www.pythonware.com/products/pil/) or [Pillow](http://pillow.readthedocs.org/en/latest/installation.html#)
|
|
|
-is required. If you go with Pillow, you need to install some additional
|
|
|
+is required. If you choose Pillow, you need to install some additional
|
|
|
[external libraries](http://www.pythonware.com/products/pil/) to add support for image types like `jpg`.
|
|
|
|
|
|
Configuration
|
|
|
-------------
|
|
|
|
|
|
-* `IMAGE_PATH` is the path to the image directory. It should reside under content, and defaults to "pictures"
|
|
|
-* `THUMBNAIL_DIR` is the path to the output sub directory where the thumbnails are generated
|
|
|
-* `THUMBNAIL_SIZES` is a dictionary mapping name of size to size specifications.
|
|
|
+* `IMAGE_PATH` is the path to the image directory. It should reside inside your content directory, and defaults to "pictures".
|
|
|
+* `THUMBNAIL_DIR` is the path to the output sub-directory where the thumbnails are generated.
|
|
|
+* `THUMBNAIL_SIZES` is a dictionary mapping size name to size specifications.
|
|
|
The generated filename will be `originalname_thumbnailname.ext` unless `THUMBNAIL_KEEP_NAME` is set.
|
|
|
-* `THUMBNAIL_KEEP_NAME` is a boolean which if set puts the file with the original name in a thumbnailname folder, named like the key in `THUMBNAIL_SIZES`.
|
|
|
-* `THUMBNAIL_KEEP_TREE` is a boolean flag to save image directory tree.
|
|
|
+* `THUMBNAIL_KEEP_NAME` is a Boolean that, if set, puts the file with the original name in a thumbnailname folder, named like the key in `THUMBNAIL_SIZES`.
|
|
|
+* `THUMBNAIL_KEEP_TREE` is a Boolean that, if set, saves the image directory tree.
|
|
|
|
|
|
Sizes can be specified using any of the following formats:
|
|
|
|
Justin Mayer