Commits

George Notaras  committed f75352e

Minor fixes in the documentation

  • Participants
  • Parent commits 3ff0efb

Comments (0)

Files changed (5)

File docs/configuration.rst

 The following settings can be specified in the Django project's ``settings``
 module to customize the functionality of *django-thumbnail-works*.
 
-``SETTING_A``
-    Setting A ...
+DTW_THUMBNAILS_FORMAT
+    If an image format is not specified in the thumbnail definition, this
+    format is used to save the thumbnails or the original imageare (if it is
+    processed). Valid values are any image formats supported by PIL. For
+    instance, JPEG, PNG etc.
 
+DTW_THUMBNAILS_QUALITY
+    This setting accepts an integer that represents the quality parameter
+    when saving JPEG images. It is not used for other image formats.
 
-Synchronize the project database
-================================
+DTW_THUMBNAILS_DIRNAME
+    This is the name of the directory where thumbnails are stored. By default,
+    this is set to ``thubs``, which means that the thumbnails are saved in the
+    ``<media_root>/<upload_to>/tumbs/`` directory.
 
-Finally, synchronize the project's database using the following command::
-
-    python manage.py syncdb
-
+DTW_THUMBNAILS_DELAYED_GENERATION
+    If this setting is set to True (the default), thumbnails are generated
+    the first time they are accessed. If this is set to False, then all
+    thumbnails are generated as soon as the original image is uploaded.
+    

File docs/faq.rst

     works that derive from this software.
 
 **What name should I use for works that derive from your software?**
-    You can use any name you like as long as it does not contain the name
-    of the original project. This is clearly stated in the ``NOTICE`` file.
+    You can use any name you like as long as it *does not contain the name
+    of the original project*. This is clearly stated in the ``NOTICE`` file.
     Please note that this restriction also applies to public forks of the
     original project's source code repository. A different name must be used
     to name your fork.
 **This looks like an interesting project, how can I contribute?**
     The best way to contribute to the project is to test the software for
     possible bugs and also suggest new features or provide feedback
-    regarding the current feature set. Patches are also much appreciated.
+    regarding the current feature set at the project's `issue tracker`_.
+    Patches are also much appreciated.
     
 **How do I submit patches?**
     Please open a ticket at the project's `issue tracker`_ and attach

File docs/index.rst

 django-thumbnail-works adds thumbnail support to the default ImageField.
 
 | **Author**: `George Notaras <http://www.g-loaded.eu/>`_
-| **Development Web Site**: `django-thumbnail-works project <https://www.codetrax.org/projects/django-thumbnail-works>`_
+| **Development Web Site**: `django-thumbnail-works project <http://www.codetrax.org/projects/django-thumbnail-works>`_
 | **Source Code Repository**: `django-thumbnail-works source code <https://source.codetrax.org/hgroot/django-thumbnail-works>`_
-
+| **Documentation**: `django-thumbnail-works documentation <http://packages.python.org/django-thumbnail-works>`_
+| **Releases**: `django-thumbnail-works releases <http://pypi.python.org/pypi/django-thumbnail-works>`_
 
 About this guide
 ================

File docs/installation.rst

 Requirements
 ============
 
-This application requires Python_ 2.4 or later, and a functional installation
+This application requires Python_ 2.4 or later and a functional installation
 of Django_.
 
 .. _Python: http://python.org
 
 This information exists in the ``requirements.txt`` file inside the
 django-thumbnail-works distribution package. If ``pip`` is used to install this software,
-then all these dependencies will also be installed.
+then all these dependencies will also be installed, if they are not already
+installed in your system.
 
 
 Download
 ========
 
-You can download the latest django-thumbnail-works releases from the `project page`_ at
+You can download the latest django-thumbnail-works releases from the `releases page`_ at
 the *Python Package Index* (PyPI).
 
-.. _`project page`: http://pypi.python.org/pypi/django-thumbnail-works
+.. _`releases page`: http://pypi.python.org/pypi/django-thumbnail-works
 
 Alternatively, you can clone the project's public source code repository
 and then check-out any stable release, all of which are tagged::
 used from a zipped egg install.
 
 Alternatively, you can simply place the ``thumbnail_works`` directory,
-which exists under the ``src`` directory, somewhere on your Python path,
+which exists under the ``src`` directory, somewhere on your Python path
 or symlink to it from somewhere on your Python path.
 
 Finally, it is also possible to install this application directly from

File docs/introduction.rst

 This section contains an introduction to *django-thumbnail-works*, including general
 information about how to submit bug reports and make feature requests.
 
-django-thumbnail-works adds thumbnail support to the default ImageField.
+*django-thumbnail-works* provides an enhanced ImageField that generates and
+manages thumbnails of the source image.
 
-Licensed under the **Apache License version 2.0**. More licensing information
+This application aims to be a simple but feature rich thumbnailing
+application for Django based projects.
+
+Licensed under the *Apache License version 2.0*. More licensing information
 exists in the license_ section.
 
+**Warning**: This software is not production-ready!
 
 Features
-========
+--------
+- Provides the ``EnhancedImageField`` model field, which is based on the
+  default Django ``ImageField``, that has the ability to generate and manage
+  thumbnails of the source image.
+- Supports *named* thumbnails which can be accessed as attributes of the
+  ``EnhancedImageField`` instance.
+- Uses the Django storages API to manage thumbnails.
+- Allows processing the original image before saving in the same manner that
+  thumbnails are processed.
+- Individual processing options for each thumbnail.
+- Supports automatic image resizing and cropping to the user specified size.
+  Upscaling the smaller images is also possible.
+- Sharpen and detail filters.
+- Selection of the output format of each image, including the source image.
+- Supports delayed thumbnail generation, which means that thumbnails are
+  generated on first access.
 
-- Feature A
-- Feature B
+Thumbnail generation through template tags is not supported and there are
+no plans to support it in the near future. However, it is extremely easy
+to access the thumbnail atributes in your templates and display them in
+any way you see fit.
 
 
 Documentation