django-adminfiles 1.0.1

Dependencies

django-adminfiles requires Django 1.4 or later, sorl-thumbnail 11.12 (not compatible with old 3.x series) and the Python Imaging Library.

djangoembed or django-oembed is required for OEmbed functionality. flickrapi is required for browsing Flickr photos, gdata for Youtube videos.

Rendering references

These references need to be rendered at some point into whatever markup you ultimately want. The markup produced by the rendering is controlled by the Django templates under adminfiles/render/.

The template used is selected according to the mime type of the file upload referenced. For instance, for rendering a file with mime type image/jpeg, the template used would be the first template of the following that exists: adminfiles/render/image/jpeg.html, adminfiles/render/image/default.html, adminfiles/render/default.html.

If a file should be rendered as if it had a different mime type (e.g. an image you want to link to rather than display), pass the as option with the mime type you want it rendered as (where either the sub-type or the entire mime-type can be replaced with default). For instance, with the default available templates if you wanted to link to an image file, you could use <<<my-image:as=default>>>.

Two rendering templates are included with django-adminfiles: adminfiles/render/image/default.html (used for any type of image) and adminfiles/render/default.html (used for any other type of file). These default templates produce an HTML img tag for images and a simple a link to other file types. They also respect three key-value options: class, which will be used as the the class attribute of the img or a tag; alt, which will be the image alt text (images only; if not provided upload.title is used for alt text); and title, which will override upload.title as the link text of the a tag (non-images only).

You can easily override these templates with your own, and provide additional templates for other file types. The template is rendered with the following context:

upload

The FileUpload model instance whose slug field matches the reference. Useful attributes of this instance include upload.upload (a Django File object), upload.title, upload.description, upload.mime_type (first and second parts separately accessible as upload.content_type and upload.sub_type) and upload.is_image (True if upload.content_type is “image”). Images also have upload.height and upload.width available.

options

A dictionary of the key=value options in the reference.

If a reference is encountered with an invalid slug (no FileUpload found in the database with that slug), the value of the ADMINFILES_STRING_IF_NOT_FOUND setting is rendered instead (defaults to the empty string).

render_uploads template filter

django-adminfiles provides two methods for making the actual rendering happen. The simple method is a template filter: render_uploads. To use it, just load the adminfiles_tags tag library, and apply the render_uploads filter to your content field:

{% load adminfiles_tags %}

{{ post.content|render_uploads }}

The render_uploads filter just replaces any file upload references in the content with the rendered template (described above).

The filter also accepts an optional argument: an alternate base path to the templates to use for rendering each uploaded file reference. This path will replace adminfiles/render as the base path in the mime-type-based search for specific templates. This allows different renderings to be used in different circumstances:

{{ post.content|render_uploads:"adminfiles/alt_render" }}

For a file of mime type text/plain this would use one of the following templates: adminfiles/alt_render/text/plain.html, adminfiles/alt_render/text/default.html, or adminfiles/alt_render/default.html.

render_upload template filter

If you have a FileUpload model instance in your template and wish to render just that instance using the normal rendering logic, you can use the render_upload filter. This filter accepts options in the same “key=val:key2=val2” format used for passing options to inline-embedded files; the special option template_path specifies an alternate base path for finding rendering templates:

{{ my_upload|render_upload:"template_path=adminfiles/alt_render:class=special" }}

pre-rendering at save time

In some cases, markup in content fields is pre-rendered when the model is saved, and stored in the database or cache. In this case, it may be preferable to also render the uploaded file references in that step, rather than re-rendering them every time the content is displayed in the template.

To use this approach, first you need to integrate the function adminfiles.utils.render_uploads into your existing content pre-rendering process, which should be automatically triggered by saving the content model.

The adminfiles.utils.render_uploads function takes a content string as its argument and returns the same string with all uploaded file references replaced, same as the template tag. It also accepts a template_path argument, which is the same as the argument accepted by the render_uploads template filter.

Integrating this function in the markup-rendering step is outside the scope of django-adminfiles. For instance, if using django-markitup with Markdown to process content markup, the MARKITUP_FILTER setting might look like this:

MARKITUP_FILTER = ("utils.markup_filter", {})

Which points to a function in utils.py like this:

from markdown import markdown
from adminfiles.utils import render_uploads

def markup_filter(markup):
    return markdown(render_uploads(markup))

Once this is done, set the ADMINFILES_USE_SIGNALS setting to True. Now django-adminfiles will automatically track all references to uploaded files in your content models. Anytime an uploaded file is changed, all content models which reference it will automatically be re-saved (and thus updated with the new uploaded file).

ADMINFILES_REF_START

Marker indicating the beginning of an uploaded-file reference in text content. Defaults to ‘<<<’.

If you set this to something insufficiently distinctive (a string that’s likely to show up otherwise in your content), all bets are off.

Special regex characters are escaped, thus you can safely set it to something like ‘[[[’, but you can’t do advanced regex magic with it.

ADMINFILES_REF_END

Marker indicating the end of an uploaded-file reference in text content. Defaults to ‘>>>’.

If you set this to something insufficiently distinctive (a string that’s likely to show up otherwise in your content), all bets are off.

Special regex characters are escaped, thus you can safely set it to something like ‘]]]’, but you can’t do advanced regex magic with it.

ADMINFILES_USE_SIGNALS

A boolean setting: should django-adminfiles track which content models reference which uploaded files, and re-save those content models whenever a referenced uploaded file changes?

Set this to True if you already pre-render markup in content fields at save time and want to render upload references at that same save-time pre-rendering step.

Defaults to False. If this setting doesn’t make sense to you, you can safely just leave it False and use the render_uploads template filter.

ADMINFILES_STRING_IF_NOT_FOUND

The string used to replace invalid uploaded file references (given slug not found). Defaults to u''.

ADMINFILES_STDICON_SET

Django-adminfiles ships with a few icons for common file types, used for displaying non-image files in the file-picker. To enable a broader range of mime-type icons, set this setting to the name of an icon set included at stdicon.com, and icons from that set will be linked.

ADMINFILES_INSERT_LINKS

By default, the admin file picker popup menu for images allows inserting a reference with no options, a reference with “class=left”, or a reference with “class=right”. For non-images, the default popup menu only allows inserting a reference without options. To change the insertion options for various file types, set ADMINFILES_INSERT_LINKS to a dictionary mapping mime-types (or partial mime-types) to a list of insertion menu options. For instance, the default setting looks like this:

ADMINFILES_INSERT_LINKS = {
    '': [('Insert Link', {})],
    'image': [('Insert', {}),
              ('Insert (left)', {'class': 'left'}),
              ('Insert (right)', {'class': 'right'})]
}

Each key in the dictionary can be the first segment of a mime type (e.g. “image”), or a full mime type (e.g. “audio/mpeg”), or an empty string (the default used if no mime type matches). For any given file the most specific matching entry is used. The dictionary should always contain a default entry (empty string key), or some files may have no insertion options.

Each value in the dictionary is a list of menu items. Each menu item is a two-tuple, where the first entry is the user-visible name for the insertion option, and the second entry is a dictionary of options to be added to the inserted file reference.

ADMINFILES_UPLOAD_TO

The upload_to argument that will be passed to the FileField on django-admin-upload’s FileUpload model; determines where django-adminfiles keeps its uploaded files, relative to MEDIA_URL. Can include strftime formatting codes as described in the Django documentation. By default, set to 'adminfiles'.

ADMINFILES_THUMB_ORDER

The ordering that will be applied to thumbnails displayed in the picker. Expects a tuple of field names, prefixed with - to indicate reverse ordering, same as “ordering” model Meta attribute. The default value is ('-upload_date'); thumbnails ordered by date uploaded, most recent first.

ADMINFILES_BROWSER_VIEWS

List of dotted paths to file-browsing views to make available in the filepicker. The default setting includes all the views bundled with django-adminfiles:

['adminfiles.views.AllView',
'adminfiles.views.ImagesView',
'adminfiles.views.AudioView',
'adminfiles.views.FilesView',
'adminfiles.views.FlickrView',
'adminfiles.views.YouTubeView',
'adminfiles.views.VimeoView']

The last three may be disabled despite their inclusion in this setting if their dependencies are not satisfied or their required settings are not set.

ADMINFILES_YOUTUBE_USER

Required for use of the Youtube video browser.

ADMINFILES_VIMEO_USER

Required for use of the Vimeo video browser.

ADMINFILES_VIMEO_PAGES

The Vimeo API returns 20 videos per page; this setting determines the maximum number of pages to fetch (defaults to 1, Vimeo-imposed maximum of 3).

ADMINFILES_FLICKR_USER

Required for use of the Flickr photo browser.

ADMINFILES_FLICKR_API_KEY

Required for use of the Flickr photo browser.

JQUERY_URL

django-adminfiles requires the jQuery Javascript library. By default, django-adminfiles uses the latest version of jQuery 1.4 hosted by Google, via the URL http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js.

If you wish to use a different version of jQuery, or host it yourself, set the JQUERY_URL setting. JQUERY_URL can be absolute or relative; if relative it is relative to STATIC_URL. For example:

JQUERY_URL = 'jquery.min.js'

This will use the jQuery available at STATIC_URL/jquery.min.js. CHANGES =======

1.0.1 (2013.06.15)

• Fix for non-local file storages. Thanks vitaly4uk.

• Fix MANIFEST.in so static assets are included with release tarball. Thanks StillNewb for the report.

1.0 (2013.06.06)

• BACKWARDS-INCOMPATIBLE: Django versions prior to 1.4 are no longer tested or supported.

• BACKWARDS-INCOMPATIBLE: Removed the ADMINFILES_MEDIA_URL setting, use STATIC_URL everywhere for static assets. Thanks Rudolph Froger for the nudge.

• Updated to most recent sorl-thumbnail. Thanks Svyatoslav Bulbakha.

• Added Russian translation. Thanks Svyatoslav Bulbakha.

• Added Spanish translation. Thanks Andrés Reyes Monge.

• Updated to use Django 1.3’s class-based views. Fixes #10. Thanks Andrés Reyes Monge and Ales Zabala Alava.

0.5.1 (2011.03.22)

• Added support for djangoembed as well as django-oembed.

• Added support for multiple pages of Vimeo results via ADMINFILES_VIMEO_PAGES setting (defaults to 1).

• Added German translation. Thanks Jannis Leidel.

0.5.0 (2010.03.09)

• Added as template override keyword option

• Added render_upload filter

• Added YouTube, Flickr, Vimeo browsers

• Added OEmbed support

• Added translation hooks and Polish translation: thanks Ludwik Trammer!

• Added support for linking full set of mime-type icons from stdicon.com.

• Made the JS reference-insertion options configurable.

• BACKWARDS-INCOMPATIBLE: default rendering template is now adminfiles/render/default.html instead of adminfiles/render.html. Image-specific rendering should override adminfiles/render/image/default.html instead of testing upload.is_image in default template.

• Added per-mime-type template rendering

• Upgraded to jQuery 1.4

• Fixed bug where YouTube and Flickr links showed up even when disabled.

• Added sync_upload_refs command

0.3.4 (2009.12.03)

• Fixed over-eager escaping in render_uploads template tag.

0.3.3 (2009.12.02)

• Fixed insertion of slugs for non-image files.

0.3.2 (2009.12.02)

• Fixed setup.py package_data so media and templates are installed from sdist.

0.3.1 (2009.11.25)

• Fixed setup.py so tests package is not installed.

0.3.0 (2009.11.23)

• Initial release as django-adminfiles

• Added docs and test suite

• Added reference parsing & rendering, template filter, signal handling