djangocms-picture 4.1.1

Creator: codyrutscher

Last updated:

Add to Cart

Description:

djangocmspicture 4.1.1

django CMS Picture is a plugin for django CMS
that allows you to add images on your site.

Note
This project is endorsed by the django CMS Association.
That means that it is officially accepted by the dCA as being in line with our roadmap vision and development/plugin policy.
Join us on Slack.



Contribute to this project and win rewards
Because this is a an open-source project, we welcome everyone to
get involved in the project and
receive a reward for their contribution.
Become part of a fantastic community and help us make django CMS the best CMS in the world.
We’ll be delighted to receive your
feedback in the form of issues and pull requests. Before submitting your
pull request, please review our contribution guidelines.
We’re grateful to all contributors who have helped create and maintain this package.
Contributors are listed at the contributors
section.

Documentation
See REQUIREMENTS in the setup.py
file for additional dependencies:


Django Filer 1.7 or higher

Make sure django-filer
is installed and configured appropriately.

Installation
For a manual install:

run pip install djangocms-picture
add djangocms_picture to your INSTALLED_APPS
run python manage.py migrate djangocms_picture



Configuration
Note that the provided templates are very minimal by design. You are encouraged
to adapt and override them to your project’s requirements.
This addon provides a default template for all instances. You can provide
additional template choices by adding a DJANGOCMS_PICTURE_TEMPLATES
setting:
DJANGOCMS_PICTURE_TEMPLATES = [
('background', _('Background image')),
]
You’ll need to create the background folder inside templates/djangocms_picture/
otherwise you will get a template does not exist error. You can do this by
copying the default folder inside that directory and renaming it to
background.
Another setting is DJANGOCMS_PICTURE_NESTING, which allows you to render an image
as the background image of a container that also contains other content (text, icons
and so on).
DJANGOCMS_PICTURE_NESTING = True
will enable this (the default is False). When set to True, you’ll be able to place additional
plugins inside the picture plugin.
You can override alignment styles with DJANGOCMS_PICTURE_ALIGN, for example:
DJANGOCMS_PICTURE_ALIGN = [
('top', _('Top Aligned')),
]
This will generate a class prefixed with align-. The example above
would produce a class="align-top". Adding a class key to the image
attributes automatically merges the alignment with the attribute class.
You can enable responsive images technique by setting``DJANGOCMS_PICTURE_RESPONSIVE_IMAGES`` to True.
In this case uploaded images will create thumbnails of different sizes according
to DJANGOCMS_PICTURE_RESPONSIVE_IMAGES_VIEWPORT_BREAKPOINTS (which defaults to [576, 768, 992]) and browser
will be responsible for choosing the best image to display (based upon the screen viewport).
You can use DJANGOCMS_PICTURE_RATIO to set the width/height ratio of images
if these values are not set explicitly on the image:
DJANGOCMS_PICTURE_RATIO = 1.618
We use the golden ratio,
approximately 1.618, as a default value for this.
When working out sizes for the image, the system will use the following values,
of preference:

the width or height set in the Thumbnail options
Autoscale
the Width and Height

We recommend setting width or height values around a placeholder so
when the plugin uses Autoscale it can discover them:
{% with 720 as width and 480 as height %}
{% placeholder content %}
{% endwith %}
Further configuration can be achieved through the
django Filer settings.


Running Tests
You can run tests by executing:
virtualenv env
source env/bin/activate
pip install -r test_requirements/base.txt
python setup.py test


Updating from cmsplugin-filer
Historically, cmsplugin-filer was used to create file, folder, image, link, teaser & video plugins on your django CMS projects. Now cmsplugin-filer has been archived, you can still migrate your old instances without having to copy them manually to the new djangocms-<file|picture|link|…> plugins.
There’s a third-party management command that supports your migration:
migrate_cmsplugin_filer.py
This management command is only a starting point. It has worked out of the box for some people, but we encourage you to read the code, understand what it does, and test it on a development environment before running it on your production server.
The management command is only configured to transfer your cmsplugin_link, cmsplugin_file, cmsplugin_folder and cmsplugin_image plugins to modern djangocms_* plugins. If you need to transfer other cmsplugin_* plugins, you’ll have to write your own code.
Alternatively you can use the deprecate_cmsplugin_filer app, which only adds a small migration that transfer the old cmsplugin-filer plugins instances to the new djangocms-<file|picture|link|…> plugins.

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Customer Reviews

There are no reviews.