docs update

sehmaschine · Feb 22, 2013 · 71cd35e · 71cd35e
1 parent 8e63b28
commit 71cd35e
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 31 deletions.
diff --git a/README.rst b/README.rst
@@ -31,9 +31,8 @@ https://www.transifex.net/projects/p/django-filebrowser/
 Releases
 --------
 
-* FileBrowser 3.5.2 (Development Version, not yet released, see Branch Stable/3.5.x): Compatible with Django 1.4/1.5
-* FileBrowser 3.5.1 (November 09 2012): Compatible with Django 1.4/1.5
-* FileBrowser 3.5.0 (July 20 2012): Compatible with Django 1.4
+* FileBrowser 3.5.3 (Development Version, not yet released, see Branch Stable/3.5.x)
+* FileBrowser 3.5.2 (February 22 2013): Compatible with Django 1.4/1.5
 * FileBrowser 3.4.3 (April 2012): Compatible with Django 1.3
 
 Older versions are availabe at GitHub, but are not supported anymore.
diff --git a/docs/actions.rst b/docs/actions.rst
@@ -65,7 +65,4 @@ Some actions may require user confirmation (e.g., in order to prevent accidental
 
     def crop_image(request, fileobjects):
         files = '&f='.join([f.path_relative for f in fileobjects])
-        return HttpResponseRedirect('/confirm/?action=crop_image&f=%s' % files)
-
-
-
+        return HttpResponseRedirect('/confirm/?action=crop_image&f=%s' % files)
diff --git a/docs/admin.rst b/docs/admin.rst
@@ -261,4 +261,4 @@ Here's a small example for using the above Signals::
         print "Filesize:", kwargs['file'].filesize
         print "Orientation:", kwargs['file'].orientation
         print "Extension:", kwargs['file'].extension
-    signals.filebrowser_post_upload.connect(post_upload_callback)
+    signals.filebrowser_post_upload.connect(post_upload_callback)
diff --git a/docs/api.rst b/docs/api.rst
@@ -443,4 +443,4 @@ Delete all ``VERSIONS``.
 ``delete_admin_versions()``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Delete all ``ADMIN_VERSIONS``.
+Delete all ``ADMIN_VERSIONS``.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -8,16 +8,28 @@
 Changelog
 =========
 
-3.5.2 (not yet released)
+3.5.3 (not yet released)
 ------------------------
 
+3.5.2 (February 22, 2013)
+------------------------
+
+* Fixed: Use placeholder with version_generate (not only templatetags).
+* Fixed: translate extension group name in upload form.
+* Fixed: updated filter dropdown HTML.
+* Fixed: Make setup.py work with Python 3.
+* Fixed: File submit with search traversal.
+* Fixed: Fixed fileobject path with Windows.
+* Improved: Throwing an exception when in DEBUG and version is not generated (with using the templatetag).
+* Compatibility with Django 1.5.
+
 3.5.1 (November 09, 2012)
 -------------------------
 
 * Fixed: Documentation with Signals.
 * Fixed: File Upload using basic submission.
 * Fixed: Added site instance to Signals.
-* Improved: Don´t hide errors during generate-command.
+* Improved: Don't hide errors during generate-command.
 * Improved: Follow symlinks with generate-command.
 * Improved: Added some translations (e.g. for "Upload File").
 * New: Setting OVERWRITE_EXISTING.

diff --git a/docs/fieldswidgets.rst b/docs/fieldswidgets.rst
@@ -39,7 +39,7 @@ Attributes
 FileBrowseField in Templates
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-When using a ``FileBrowseField``, you´ll get a :ref:`fileobject` back.
+When using a ``FileBrowseField``, you'll get a :ref:`fileobject` back.
 
 With the above Model, you can use::
 
@@ -75,7 +75,7 @@ If you want to show a Thumbnail in the Changelist, you can define a Model-/Admin
 Using the FileBrowseField with TinyMCE
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-You can also replace the TinyMCE Image/File Manager with the FileBrowser. What you have to do is a FileBrowser Callback. There´s an example in /media/js/ called TinyMCEAdmin.js (a TinyMCE Configuration File). You can copy the FileBrowserCallback to your own file, take a look at http://wiki.moxiecode.com/index.php/TinyMCE:Custom_filebrowser or just use tinymce_setup.js (which comes with django-grappelli).
+You can also replace the TinyMCE Image/File Manager with the FileBrowser. What you have to do is a FileBrowser Callback. There's an example in /media/js/ called TinyMCEAdmin.js (a TinyMCE Configuration File). You can copy the FileBrowserCallback to your own file, take a look at http://wiki.moxiecode.com/index.php/TinyMCE:Custom_filebrowser or just use tinymce_setup.js (which comes with django-grappelli).
 
 Just add these lines to your AdminModel::
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -98,9 +98,8 @@ Use the `FileBrowser Google Group <http://groups.google.com/group/django-filebro
 Versions and Compatibility
 --------------------------
 
-* |filebrowser| 3.5.x: Requires |grappelli| 2.4 and Django 1.4 (3.5.1 is also compatible with Django 1.5)
-* |filebrowser| 3.4.x: Requires |grappelli| 2.3 and Django 1.3
-
-Older versions are availabe at GitHub, but are not supported anymore.
-
+* FileBrowser 3.5.3 (Development Version, not yet released, see Branch Stable/3.5.x)
+* FileBrowser 3.5.2 (February 22 2013): Compatible with Django 1.4/1.5
+* FileBrowser 3.4.3 (April 2012): Compatible with Django 1.3
 
+Older versions are availabe at GitHub, but are not supported anymore.
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -11,7 +11,7 @@ For using the |filebrowser|, `Django <http://www.djangoproject.com>`_ needs to b
 Requirements
 ------------
 
-* Django 1.4, http://www.djangoproject.com
+* Django 1.4/1.5, http://www.djangoproject.com
 * Grappelli 2.4, https://github.com/sehmaschine/django-grappelli
 * PIL, http://www.pythonware.com/products/pil/
 
@@ -70,4 +70,4 @@ Start the devserver and login to your admin site::
 
     python manage.py runserver <IP-address>:8000
 
-Goto ``/admin/filebrowser/browse/`` and check if everything looks/works as expected. If you're having problems, see :ref:`troubleshooting`.
+Goto ``/admin/filebrowser/browse/`` and check if everything looks/works as expected. If you're having problems, see :ref:`troubleshooting`.
diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst
@@ -8,11 +8,11 @@
 FileBrowser 3.5 Release Notes
 =============================
 
-FileBrowser 3.5 is compatible with Django 1.4 and Grappelli 2.4.
+FileBrowser 3.5 is compatible with Django 1.4/1.5 and Grappelli 2.4.
 
 Update from FileBrowser 3.4.x
 -----------------------------
 
-* Update Django to 1.4 and check https://docs.djangoproject.com/en/dev/releases/1.4/
+* Update Django to 1.4 or 1.5 and check https://docs.djangoproject.com/en/dev/releases/1.4/ or https://docs.djangoproject.com/en/dev/releases/1.5/
 * Update Grappelli to 2.4.x
 * Update FileBrowser to 3.5.x
diff --git a/docs/settings.rst b/docs/settings.rst
@@ -165,7 +165,7 @@ SAVE_FULL_URL
 ^^^^^^^^^^^^^
 
 .. deprecated:: 3.4.0
-    With custom storage engines, saving the full URL (including MEDIA_ROOT) doesn´t make sense anymore. Moreover, removing this settings allows for easily replacing a FileBrowseField with Djangos File- or ImageField.
+    With custom storage engines, saving the full URL (including MEDIA_ROOT) doesn't make sense anymore. Moreover, removing this settings allows for easily replacing a FileBrowseField with Djangos File- or ImageField.
 
 STRICT_PIL
 ^^^^^^^^^^
@@ -263,4 +263,4 @@ OVERWRITE_EXISTING
 
 ``True`` in order to overwrite existing files, ``False`` to use the behaviour of the storage engine::
 
-    OVERWRITE_EXISTING = getattr(settings, "FILEBROWSER_OVERWRITE_EXISTING", True)
+    OVERWRITE_EXISTING = getattr(settings, "FILEBROWSER_OVERWRITE_EXISTING", True)
diff --git a/docs/translation.rst b/docs/translation.rst
@@ -13,4 +13,4 @@ Translation is done via `Transifex <https://www.transifex.net/projects/p/django-
 Supported Languages
 ===================
 
-see https://www.transifex.net/projects/p/django-filebrowser/resource/djangopo/
+see https://www.transifex.net/projects/p/django-filebrowser/resource/djangopo/
diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
@@ -42,7 +42,7 @@ If you think you've found a bug, please `add a ticket <https://github.com/sehmas
 * Tell us what you did in order to solve the problem.
 * Tell us what version of the |filebrowser| you are using.
 * Tell us what version of Django you are using.
-* Please do NOT add tickets if you´re having problems with serving static/media-files (because this is not related to the |filebrowser|).
+* Please do NOT add tickets if you're having problems with serving static/media-files (because this is not related to the |filebrowser|).
 * Please do NOT add tickets referring to Djangos trunk version.
 * At best: add a patch.
 

diff --git a/docs/versions.rst b/docs/versions.rst
@@ -13,7 +13,7 @@ With the FileBrowser, you are able to define different versions/sizes for Images
 Versions and the grid
 ---------------------
 
-First you need to know which versions/sizes of an image you´d like to use on your website. Let´s say you´re using a 12 column grid with 60px for each column and 20px margin (which is a total of 940px). With this grid, you could (for example) generate these image versions::
+First you need to know which versions/sizes of an image you'd like to use on your website. Let's say you're using a 12 column grid with 60px for each column and 20px margin (which is a total of 940px). With this grid, you could (for example) generate these image versions::
 
       VERSIONS = getattr(settings, "FILEBROWSER_VERSIONS", {
         'admin_thumbnail': {'verbose_name': 'Admin Thumbnail', 'width': 60, 'height': 60, 'opts': 'crop'},
@@ -53,7 +53,7 @@ Don't forget to select one version for your admin-thumbnail::
 Versions on your website
 ------------------------
 
-In order to generate versions, you have two different tags to choose from: ``version`` and ``version_object``. With either using the version-tag or the version_object-tag, the Image-version will be generated "on the fly" if the version doesn´t already exist or if the original Image is newer than the version. This means that if you need to update an Image, you just overwrite the original Image - the versions will be re-generated automatically (as you request them within your template).
+In order to generate versions, you have two different tags to choose from: ``version`` and ``version_object``. With either using the version-tag or the version_object-tag, the Image-version will be generated "on the fly" if the version doesn't already exist or if the original Image is newer than the version. This means that if you need to update an Image, you just overwrite the original Image - the versions will be re-generated automatically (as you request them within your template).
 
 A Model example::
 
@@ -142,6 +142,4 @@ If you need to generate certain (or all) versions, type::
     python manage.py fb_version_remove
 
 .. warning::
-    Please be very careful with this command.
-
-
+    Please be very careful with this command.