Skip to content
Browse files

3.3 docs-updates

  • Loading branch information...
1 parent f1c9aea commit 01f407a004a436eefc3e217dc293f83c62a64ac2 @sehmaschine committed May 30, 2011
Showing with 36 additions and 25 deletions.
  1. +13 −14 docs/api.rst
  2. +1 −1 docs/changelog.rst
  3. +2 −2 docs/conf.py
  4. +13 −2 docs/faq.rst
  5. +1 −1 docs/index.rst
  6. +1 −0 docs/releasenotes.rst
  7. +5 −5 docs/versions.rst
View
27 docs/api.rst
@@ -237,14 +237,6 @@ Datetime object::
>>> print fileobject.datetime
datetime.datetime(2011, 3, 10, 13, 32, 27)
-``folder``
-^^^^^^^^^^
-
-XXX::
-
- >>> print fileobject.folder
- u'testfolder'
-
Path and URL attributes
-----------------------
@@ -335,13 +327,12 @@ Image orientation, either "landscape" or "portrait"::
Folder attributes
-----------------
-``directory``
-^^^^^^^^^^^^^
-XXX::
+``folder``
+^^^^^^^^^^
- >>> print fileobject.directory
- u'testfolder/testimage.jpg'
+ >>> print fileobject.folder
+ u'testfolder'
``is_folder``
^^^^^^^^^^^^^
@@ -361,10 +352,18 @@ XXX::
Version attributes
------------------
+``is_version``
+^^^^^^^^^^^^^^
+
+``true`` if the File is a ``version`` of another File::
+
+ >>> print fileobject.is_version
+ False
+
``version_basedir``
^^^^^^^^^^^^^^^^^^^
-Either ``VERSIONS_BASEDIR`` or ``self.head``::
+The absolute path to the versions-folder::
>>> print fileobject.version_basedir
'/var/www/testsite/media/uploads/testfolder'
View
2 docs/changelog.rst
@@ -8,7 +8,7 @@
Changelog
=========
-3.3.0 (08/03/2011)
+3.3.0 (30/05/2011)
^^^^^^^^^^^^^^^^^^
* Initial Release of the 3.3-series.
View
4 docs/conf.py
@@ -48,9 +48,9 @@
# built documents.
#
# The short X.Y version.
-version = '3.3'
+version = '3.3.0'
# The full version, including alpha/beta/rc tags.
-release = '3.3'
+release = '3.3.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
View
15 docs/faq.rst
@@ -40,10 +40,21 @@ Why is there no mercurial– or git–repository?
We have discussed this issue on the `Grappelli Google-Group <http://groups.google.com/group/django-grappelli>`_. Since the outcome has been ambiguous, we stay with svn for now. Of course, the same is true for the |filebrowser|.
-Why should I need imageversions?
+Why should I need image-versions?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-You need image–versions if your website is based on a *grid*.
+You need image-versions if your website is based on a *grid*.
+
+Upload does NOT work?
+^^^^^^^^^^^^^^^^^^^^^
+
+* Upload doesn't work if your server is setup using http-authentication.
+* Uploading from one server to another requires a crossdomain-policy, see http://www.uploadify.com/faqs/how-do-i-upload-files-from-one-server-to-another/.
+
+Is the |filebrowser| stable?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+We've developed the |filebrowser| for a couple of years and use it with almost all of our clients. That said, |grappelli| is the more stable and mature application.
How can I contribute?
^^^^^^^^^^^^^^^^^^^^^
View
2 docs/index.rst
@@ -10,7 +10,7 @@ Django FileBrowser Documentation
**Media-Management with the Django admin-interface**.
-This documentation covers version 3.3 of the |filebrowser|. With the |filebrowser|, you're able to browse your media-directory
+This documentation covers version 3.3.0 of the |filebrowser|. With the |filebrowser|, you're able to browse your media-directory
and upload/rename/delete files and folders.
**Installation and Setup**
View
1 docs/releasenotes.rst
@@ -42,6 +42,7 @@ Design changes
* Instead, there is now an edit-button.
* The edit-view allows for renaming/deleting a File/Folder (similar to editing a database-object with the admin-interface).
* Selecting a File/Folder is done with one button on the changelist with a drop-down for ``VERSIONS``.
+* Versions are now shown with the change-link/edit-view.
Deprecated in 3.3
^^^^^^^^^^^^^^^^^
View
10 docs/versions.rst
@@ -61,26 +61,26 @@ Templatetag ``version``
**Generate a version and retrieve the URL**::
- {% version model.field_name version_prefix %}
+ {% version model.field_name.path version_prefix %}
With the above Model, in order to generate a version you type::
- {% version blogentry.image 'medium' %}
+ {% version blogentry.image.path 'medium' %}
Since you retrieve the URL, you can display the image with::
- <img src="{% version blogentry.image 'medium' %}" />
+ <img src="{% version blogentry.image.path 'medium' %}" />
Templatetag ``version_object``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Generate a version and retrieve the FileObject**::
- {% version_object model.field_name version_prefix as variable %}
+ {% version_object model.field_name.path version_prefix as variable %}
With the above Model, in order to generate a version you type::
- {% version_object blogentry.image 'medium' as version_medium %}
+ {% version_object blogentry.image.path 'medium' as version_medium %}
Since you retrieve a ``FileObject``, you can use all attributes::

0 comments on commit 01f407a

Please sign in to comment.
Something went wrong with that request. Please try again.