Skip to content

Commit

Permalink
Added the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
David Yell committed Feb 17, 2015
1 parent c843d01 commit 325a1e4
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Expand Up @@ -19,6 +19,7 @@ Contents:
Generating thumbnails <thumbnails>
Validating uploads <validation>
File import behavior <file-import-behavior>
Thumbnail generation shell <thumbnail-shell>


Indices and tables
Expand Down
24 changes: 24 additions & 0 deletions docs/thumbnail-shell.rst
@@ -0,0 +1,24 @@
Thumbnail shell
---------------

What it does
~~~~~~~~~~~~
The shell will look through your database for images and regenerate the thumbnails based on
your models Upload behaviour configuration. This allows you to change your thumbnail configuration and run the
shell to update your images without having to re-upload the image.

How it works
~~~~~~~~~~~~
The shell takes the model you provide and checks that the Upload plugin is present and configured. Then it will loop
though all the images checking that the configured upload field is populated in the database and also ensuring that the
file exists on the file system. Then it will regenerate the thumbnails using the current model configuration.

Running the shell
~~~~~~~~~~~~~~~~~
You can run the shell from the command line as you would any cake shell.

.. code:: bash
Console/cake upload.thumbnail generate
You will then be asked which model you want to process, and the shell will then process your images.

0 comments on commit 325a1e4

Please sign in to comment.