Permalink
Browse files

docs update for 3.4.0

  • Loading branch information...
sehmaschine committed Oct 11, 2011
1 parent aeef686 commit ab5db8d2952100a3ae42d9d0e0a09f5956b471c6
Showing with 16 additions and 61 deletions.
  1. +2 −1 AUTHORS
  2. +2 −2 README.rst
  3. +1 −1 docs/actions.rst
  4. +2 −2 docs/changelog.rst
  5. +2 −2 docs/conf.py
  6. +1 −1 docs/file_storages.rst
  7. +1 −1 docs/index.rst
  8. +1 −1 docs/quickstart.rst
  9. +2 −2 docs/settings.rst
  10. +2 −48 docs/sites.rst
View
@@ -1,3 +1,4 @@
Patrick Kranzlmueller <patrick@vonautomatisch.at>
Axel Swoboda <axel@vonautomatisch.at>
-Klemens Mantzos <klemens@fetzig.at>
+Klemens Mantzos <klemens@fetzig.at>
+Vaclav Mikolasek <vaclav.mikolasek@gmail.com>
View
@@ -12,10 +12,10 @@ The FileBrowser is an extension to the `Django <http://www.djangoproject.com>`_
Requirements
------------
-FileBrowser 3.4 requires
+FileBrowser 3.4.0 requires
* Django 1.3 (http://www.djangoproject.com)
-* Grappelli 2.3 (https://github.com/sehmaschine/django-grappelli)
+* Grappelli 2.3.5 (https://github.com/sehmaschine/django-grappelli)
* PIL (http://www.pythonware.com/products/pil/)
Documentation
View
@@ -9,7 +9,7 @@
Custom Actions
==============
-.. versionadded:: 3.4
+.. versionadded:: 3.4.0
In analogy to Django's admin actions, you can define your |fb| actions and thus automate the typical tasks of your users. Registered custom actions are listed in the detail view of a file and a user can select a single action at a time. The selected action will then be applied to the file.
View
@@ -8,7 +8,7 @@
Changelog
=========
-3.4.0 (2011-10-10)
+3.4.0 (11/10/2011)
^^^^^^^^^^^^^^^^^^
-see :ref:`releasenotes`
+* Final release of 3.4, see :ref:`releasenotes`
View
@@ -48,9 +48,9 @@
# built documents.
#
# The short X.Y version.
-version = '3.4'
+version = '3.4.0'
# The full version, including alpha/beta/rc tags.
-release = '3.4'
+release = '3.4.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
View
@@ -9,7 +9,7 @@
File Storages
=============
-.. versionadded:: 3.4
+.. versionadded:: 3.4.0
Starting with |fb| 3.4, you have the option to specify which file storage engine a |fb| should use to browse/upload/modify your media files. This enables you to use a |fb| even if your media files are located at some remote system.
View
@@ -10,7 +10,7 @@ Django FileBrowser Documentation
**Media-Management with Grappelli**.
-This documentation covers version 3.4 of the |filebrowser|.
+This documentation covers version 3.4.0 of the |filebrowser|.
**Installation and Setup**
View
@@ -27,7 +27,7 @@ Go to https://github.com/sehmaschine/django-filebrowser if you need to download
Installation
------------
-.. versionchanged:: 3.4
+.. versionchanged:: 3.4.0
Open ``settings.py`` and add ``filebrowser`` to your ``INSTALLED_APPS`` (before ``django.contrib.admin``)::
View
@@ -94,7 +94,7 @@ Versions
VERSIONS_BASEDIR (relative to ``MEDIA_ROOT``)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. versionchanged:: 3.4
+.. versionchanged:: 3.4.0
Directory to save image versions (and thumbnails). If no directory is given, versions are stored at the same location as the original image::
@@ -140,7 +140,7 @@ Extra Settings
SAVE_FULL_URL
^^^^^^^^^^^^^
-.. deprecated:: 3.4
+.. 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.
STRICT_PIL
View
@@ -8,7 +8,7 @@
FileBrowser Sites
=================
-.. versionadded:: 3.4
+.. versionadded:: 3.4.0
As of version 3.4, the FileBrowser application is respresented by an object of ``filebrowser.sites.FileBrowserSite`` (in analogy to Django's admin site). FileBrowser sites allow you to:
@@ -22,50 +22,4 @@ The module variable ``site`` from filebrowser.sites is the default FileBrowser a
Backward Incompatibilites
-------------------------
-The only thing that you need to pay attention to when migrating to FileBrowser 3.4, is the specification of your URL-patterns. URL-patterns are now associated with a FileBrowser site, that is, each FileBrowser site can have different URL-patterns. See :ref:`quickstart` for how to setup your URL-patterns.
-
-.. Mutliple FileBrowser Sites
-.. --------------------------
-
-.. .. important::
-
-.. In majority of cases, there's no need for seting up multiple instances of FileBrowser sites. It is a supported, but not very standard way of using FileBrowser. However, there might be a few good reasons to use multiple |sites|. For example, you want to allow users to upload/delete/modify files at a location outside MEDIA_ROOT or you have implemented some custom actions that should be accessible only to certain users. In these cases, having multiple |sites| can do the job.
-
-.. Before you start including additional FileBrowser sites to your project, note that there will be always a **single** FileBrowser site associated with FileBrowseFields. This site, called the **main site**, is invoked, when a user clicks on the search button of a FieldBrowseField. If you use multiple |sites|, then the main site is the one with the instance namespace "filebrowser" (or the last deployed instance, if there is no instance named "filebrowser").
-
-.. When creating a site, you can specify its instance namespace like this::
-
-.. fb_site = FileBrowserSite(name="fb-site")
-
-.. The default |site| ``filebrowser.sites.site`` has the instance name "filebrowser" and will be therefore the main site if you use it.
-
-.. The Main Site
-.. ^^^^^^^^^^^^^
-
-.. Although it is possible to define MEDIA_ROOT and MEDIA_URL on per-site basis, the main site *must* have these variables equal to the global, default values given in ``settings.py``. See :ref:`settings` for the details about MEDIA_ROOT and MEDIA_URL.
-
-.. Additional Sites
-.. ^^^^^^^^^^^^^^^^
-
-.. Any site, that is not the main site can have its MEDIA_ROOT and MEDIA_URL set to a whatever value you wish. In order to deploy an additional |site|, create the instance and give it a unique name::
-
-.. fb_site = FileBrowserSite(name="fb-site")
-
-.. set its MEDIA_ROOT and MEDIA_URL::
-
-.. fb_site.media_root = '/usr/var/www/some-project/ohter-media/'
-.. fb_site.media_url = 'other-media/'
-
-.. and register the site's URLs in your ``url.py``::
-
-.. from some_project import fb_site
-
-.. urlpatterns = patterns('',
-.. (r'^admin/filebrowser-other-media/', include(fb_site.urls)),
-.. )
-
-
-
-
-
-
+The only thing that you need to pay attention to when migrating to FileBrowser 3.4, is the specification of your URL-patterns. URL-patterns are now associated with a FileBrowser site, that is, each FileBrowser site can have different URL-patterns. See :ref:`quickstart` for how to setup your URL-patterns.

0 comments on commit ab5db8d

Please sign in to comment.