Metadata-Version: 2.1
Name: cmsplugin-blocks
Version: 0.6.0
Summary: A set of DjangoCMS plugins for content structures
Home-page: https://github.com/emencia/cmsplugin-blocks
Author: David Thenon
Author-email: dthenon@emencia.com
License: MIT
Description: .. _DjangoCMS: https://www.django-cms.org/
        .. _sorl-thumbnail: https://github.com/mariocesar/sorl-thumbnail
        .. _djangocms-text-ckeditor: https://github.com/divio/djangocms-text-ckeditor
        
        Emencia DjangoCMS blocks
        ========================
        
        A set of DjangoCMS plugins for content structures.
        
        Goal is to make content with less involved HTML than directly using CKeditor
        for everything.
        
        This just supply some plugins with a default basic template. There is no CSS,
        Javascript or anything else like frontend integration.
        
        Requires
        ********
        
        * Python >= 3.4;
        * Django>=2.0;
        * Pillow;
        * `sorl-thumbnail`_;
        * `DjangoCMS`_ >= 3.6;
        * `djangocms-text-ckeditor`_;
        
        Support
        *******
        
        Application is tested against the following versions:
        
        * Python 3.4 to 3.6;
        * Django 2.0 to 3.0;
        * DjangoCMS 3.6 to 3.7;
        
        Install
        *******
        
        Package
        -------
        
        ::
        
            pip install cmsplugin-blocks
        
        Configuration
        -------------
        
        Add it to your installed Django apps in settings like this : ::
        
            INSTALLED_APPS = (
                ...
                'cms',
                'djangocms_text_ckeditor',
                'sorl.thumbnail',
                'cmsplugin_blocks',
            )
        
        Then load its settings from your settings file: ::
        
            from cmsplugin_blocks import *
        
        And finally apply database migrations.
        
        Available components
        ********************
        
        Album
        -----
        
        Available fields:
        
        * title;
        * template;
        
        Album have related items *AlbumItem* which are added/edited through inline form.
        
        Available *AlbumItem* items fields:
        
        * image;
        * content;
        
        Card
        ----
        
        Available fields:
        
        * alignment;
        * template;
        * image;
        * content;
        
        Hero
        ----
        
        Available fields:
        
        * template;
        * image;
        * content;
        
        Slider
        ------
        
        Available fields:
        
        * title;
        * template;
        
        Available *SlideItem* items fields:
        
        * image;
        * content;
        * order;
        * link_name;
        * link_url;
        * link_open_blank;
        
        Slider have related items *SlideItem* which are added/edited through
        inline form.
        
        Mass upload
        ***********
        
        There is a field "mass upload" on Album that attemp a valid ZIP archive file
        to create new album items. Each image file from ZIP archive will be added as
        a new album item using image filename as item title. Scanning ZIP archive for
        image files is recursive and so the full image filename is used, even its
        relative path inside archive.
        
        Settings
        ********
        
        These are default settings you may override in your own project settings.
        
        BLOCKS_ALBUM_TEMPLATES
            Available templates to render an Album object and its items. Default
            setting value contains only one default template.
        BLOCKS_CARD_TEMPLATES
            Available templates to render an Card object. Default
            setting value contains only one default template.
        BLOCKS_HERO_TEMPLATES
            Available templates to render an Hero object. Default
            setting value contains only one default template.
        BLOCKS_SLIDER_TEMPLATES
            Available templates to render an Slider object and its items. Default
            setting value contains only one default template.
        BLOCKS_TEMP_DIR
            Path to directory where to store temporary ZIP archive for mass upload.
            Default to `temp/`.
        BLOCKS_MASSUPLOAD_IMAGE_TYPES
            Allowed images file extensions in ZIP archive for mass upload. Default
            value allow `jpg`, `jpeg`, `svg`, `gif` and `png`.
        BLOCKS_MASSUPLOAD_FILESIZE_LIMIT
            Maximum file size (in bytes) allowed for ZIP archive for mass upload.
            Default to `429916160` (50MiO).
        
        A note about djangocms-text-ckeditor
        ************************************
        
        djangocms-text-ckeditor get configurations from
        ``CKEDITOR_SETTINGS["toolbar_HTMLField"]`` when used from plugin, you may have
        to duplicate it from ``CKEDITOR_SETTINGS["toolbar_CMS"]`` if you want to share
        the same configuration for CKeditor from CMS pages and CKeditor from blocks
        plugins.
        
        Development
        ***********
        
        Install
        -------
        
        Download repository then install everything with: ::
        
            make install
        
        Once finished you will need to create a superuser to be able to create a first page: ::
        
            make superuser
        
        Finally you can load the demonstration server: ::
        
            make run
        
Keywords: Django,Django-CMS,Structure,Content
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/x-rst
Provides-Extra: dev
