djangocms-unitegallery

A gallery plugin for django CMS that uses the excellent Unite Gallery jQuery plugin.

Installation

This plugin requires django CMS 3.0 or higher, sorl-thumbnail 12.0 or higher or easy-thumbnails 2.3 or higher to work.

• Run pip install djangocms-unitegallery
• Add 'sorl.thumbnail' if your project depends on sorl
• Or 'easy_thumbnail' if your project depends on easy-thumbnails
• Add 'djangocms_unitegallery' to your INSTALLED_APPS
• Run python manage.py migrate

Note

It's up to you to install sorl or easy-thumbnail!!!

Note

It's up to you to include jQuery js file in your templates, just make sure you include it before the sekizai {% render_block js %}.

Configuration

By default djangocms-unitegallery generates thumbnails for better perfomance. The default behavior is to generate thumbnails by resizing and cropping images in a square of 250x250 px.

You can disable completely the thumbnail generation and leave Unite Gallery handles images and preview, or you can change the default size of generated thumbnails and/or wether the image ratio should be preserved or not:

DJANGOCMS_UNITEGALLERY_CONFIG = {
    'THUMBNAIL_ENABLED': true,
    'THUMBNAIL_MAX_WIDTH': 250,
    'THUMBNAIL_MAX_HEIGHT': 250,
    'THUMBNAIL_PRESERVE_RATIO': False,
    'USE_EASYTHUMBNAILS': False
}

If you set THUMBNAIL_PRESERVE_RATIO to False, thumbnails will be cropped to match the configured width and height. If you set THUMBNAIL_PRESERVE_RATIO to True, thumbnails will just be resized to match the configured max width (if image is landscape) or height (if image is portrait).

Note

Due to Unite Gallery behavior, and depending on configured options, you are not guaranteed to have the thumbnail size you configured in settings.

Templates

The template behavior has changed since 0.1.0. If you are using sorl as thumbnail library - nothing has changed for you and if you are using easy-thumbnails the template "easythumb-gallery.html" did the trick.

Why do we do that?

You can't use both thumbnail libraries side by side. Like murphies law: You are using the false thumbnail library ;)