collective.behavior.banner


Namecollective.behavior.banner JSON
Version 2.0 PyPI version JSON
download
home_pagehttps://pypi.python.org/pypi/collective.behavior.banner
SummaryAn add-on for Plone
upload_time2023-11-10 13:18:31
maintainer
docs_urlNone
authorPhilip Bauer
requires_python
licenseGPL version 2
keywords python plone
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            collective.behavior.banner
==========================

A behavior to create banners and sliders from banners.

Features
========

Banner
------

A banner is usually some text and an image that is displayed above of the content.

The behavior ``collective.behavior.banner.banner.IBanner`` has various fields (image, title, subtitle, richtext, link, linkcaption etc) that are combined to build a banner. You can enable the behavior on any Dexterity type (tested with plone.app.contenttypes) or for the whole Plone site.


Slider
------

The behavior ``collective.behavior.banner.slider.ISlider`` adds the option to add relations to several banners (i.e. items that have the Banner behavior enabled). These banners are then displayed like a banner but fade.

The slider viewlet uses the javascript library http://responsiveslides.com and fades from one banner to another. You can easily use a different javascript libray by overriding the viewlet templates (see below).

Before you use a slider/carousel on your website, please take time to read http://shouldiuseacarousel.com.


Inheriting
----------

Banners are inherited by child objects. In a controlpanel you can configure which types should display inherited banners. You can also prevent inheriting banners for an item and its child objects by enabling the option *Do not inherit banner from parents* on the banner tab. If you want a banner for the entire site, you can assign one to the default content of the Navigation Root (or Plone site root).


Customization
=============

To change the appearance (e.g. if you use a bootstrap theme or want to use a different effect in the slider) you can easily override the respective viewlets with `z3c.jbot <http://pypi.python.org/pypi/z3c.jbot>`_ or `plone.app.themingplugins <https://pypi.python.org/pypi/plone.app.themingplugins>`_ (if you use plone.app.theming). The names of the files to create would be ``collective.behavior.banner.browser.banner.pt`` and ``collective.behavior.banner.browser.slider.pt``.


Demo
====

collective.behavior.banner is used on the following sites:

* http://www.plone.de
* http://python-verband.org
* http://www.bildungswerk-bayern.de


Compatibility
=============

collective.behavior.banner works in Plone 4, 5 and 6.

* Plone 6: 2.x
* Plone 5: 1.x
* Plone 4: 0.x


Installation
============

To install `collective.behavior.banner` you simply add ``collective.behavior.banner`` to the list of eggs in your buildout, run buildout and restart Plone. Then, install `collective.behavior.banner` using the Add-ons control panel.

Enable the behavior by hand or in the FTI  ``<your_package>/profiles/default/types/Folder.xml``:

.. code:: xml

    <?xml version="1.0"?>
    <object name="Folder" meta_type="Dexterity FTI">
     <property name="behaviors" purge="False">
      <element value="collective.behavior.banner.banner.IBanner"/>
     </property>
    </object>


Contribute
----------

* Source Code: https://github.com/collective/collective.behavior.banner
* Issue Tracker: https://github.com/collective/collective.behavior.banner/issues


Support
-------

If you are having issues, please let us know at https://github.com/collective/collective.behavior.banner/issues.



- Philip Bauer, bauer@starzel.de
- Steffen Lindner, lindner@starzel.de
- Stefan Antonelli, stefan.antonelli@operun.de
- Fulvio Casali, fulviocasali@gmail.com
- Valentin Piret, valentin@affinitic.be
- Peter Mathis, peter.mathis@kombinat.at


:orphan:

Changelog
=========

2.0 (2023-11-10)
----------------

- Add support for Plone 6.
  [petschki]


1.3 (2021-01-22)
----------------

- Set RelatedItemsFieldWidget to search to find all banners for a slider.
  [pbauer]

- Fix use of default_page
  [pbauer]

- Use named behaviors.
  [pbauer]


1.2 (2019-03-14)
----------------

- Add support for Python 3.
  [pbauer]


1.1 (2018-09-18)
----------------

- Use the banner from the root default content if there is one
  [Vaal24]


1.0 (2018-08-16)
----------------

- Add alt tag for banner image.
  [tlotze]


1.0b2 (2017-06-20)
------------------

- Pass full banner-obj to templates to allow accessing object-attibutes.
  [pbauer]

- Test against Plone 5.0.7 and fix all pep8-issues.
  [pbauer]

- Show YouTube and Vimeo videos in a banner.
  [fulv]


1.0b1 (2015-11-30)
------------------

- Use p5-style resources.
  [pbauer]

- No longer explicitly set the relateditemswidget (it's default in p5).
  [pbauer]

- Fix RelationList widget for slider_relation field. Fixes #1.
  [fulv]

- Remove last traces of grok.
  [fulv]

- Add compatability to Plone 5 with new buildout and test-setup.
  [pbauer]


0.2 (2015-11-30)
----------------

- Add Documentation.
  [pbauer]

- Remove grok.
  [pbauer]

- Simplify traversing.
  [pbauer]

- Unify css and templates.
  [gomez]

- Basic styling for banner/slider.
  [santonelli]


0.1 (26.3.2014)
----------------

- Initial release.
  [pbauer, gomez]


            

Raw data

            {
    "_id": null,
    "home_page": "https://pypi.python.org/pypi/collective.behavior.banner",
    "name": "collective.behavior.banner",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "Python Plone",
    "author": "Philip Bauer",
    "author_email": "bauer@starzel.de",
    "download_url": "https://files.pythonhosted.org/packages/6d/3d/71f035d77ed2bbcc2383c5e26c925fe263cbf6776435090b90fa71e6c725/collective.behavior.banner-2.0.tar.gz",
    "platform": null,
    "description": "collective.behavior.banner\n==========================\n\nA behavior to create banners and sliders from banners.\n\nFeatures\n========\n\nBanner\n------\n\nA banner is usually some text and an image that is displayed above of the content.\n\nThe behavior ``collective.behavior.banner.banner.IBanner`` has various fields (image, title, subtitle, richtext, link, linkcaption etc) that are combined to build a banner. You can enable the behavior on any Dexterity type (tested with plone.app.contenttypes) or for the whole Plone site.\n\n\nSlider\n------\n\nThe behavior ``collective.behavior.banner.slider.ISlider`` adds the option to add relations to several banners (i.e. items that have the Banner behavior enabled). These banners are then displayed like a banner but fade.\n\nThe slider viewlet uses the javascript library http://responsiveslides.com and fades from one banner to another. You can easily use a different javascript libray by overriding the viewlet templates (see below).\n\nBefore you use a slider/carousel on your website, please take time to read http://shouldiuseacarousel.com.\n\n\nInheriting\n----------\n\nBanners are inherited by child objects. In a controlpanel you can configure which types should display inherited banners. You can also prevent inheriting banners for an item and its child objects by enabling the option *Do not inherit banner from parents* on the banner tab. If you want a banner for the entire site, you can assign one to the default content of the Navigation Root (or Plone site root).\n\n\nCustomization\n=============\n\nTo change the appearance (e.g. if you use a bootstrap theme or want to use a different effect in the slider) you can easily override the respective viewlets with `z3c.jbot <http://pypi.python.org/pypi/z3c.jbot>`_ or `plone.app.themingplugins <https://pypi.python.org/pypi/plone.app.themingplugins>`_ (if you use plone.app.theming). The names of the files to create would be ``collective.behavior.banner.browser.banner.pt`` and ``collective.behavior.banner.browser.slider.pt``.\n\n\nDemo\n====\n\ncollective.behavior.banner is used on the following sites:\n\n* http://www.plone.de\n* http://python-verband.org\n* http://www.bildungswerk-bayern.de\n\n\nCompatibility\n=============\n\ncollective.behavior.banner works in Plone 4, 5 and 6.\n\n* Plone 6: 2.x\n* Plone 5: 1.x\n* Plone 4: 0.x\n\n\nInstallation\n============\n\nTo install `collective.behavior.banner` you simply add ``collective.behavior.banner`` to the list of eggs in your buildout, run buildout and restart Plone. Then, install `collective.behavior.banner` using the Add-ons control panel.\n\nEnable the behavior by hand or in the FTI  ``<your_package>/profiles/default/types/Folder.xml``:\n\n.. code:: xml\n\n    <?xml version=\"1.0\"?>\n    <object name=\"Folder\" meta_type=\"Dexterity FTI\">\n     <property name=\"behaviors\" purge=\"False\">\n      <element value=\"collective.behavior.banner.banner.IBanner\"/>\n     </property>\n    </object>\n\n\nContribute\n----------\n\n* Source Code: https://github.com/collective/collective.behavior.banner\n* Issue Tracker: https://github.com/collective/collective.behavior.banner/issues\n\n\nSupport\n-------\n\nIf you are having issues, please let us know at https://github.com/collective/collective.behavior.banner/issues.\n\n\n\n- Philip Bauer, bauer@starzel.de\n- Steffen Lindner, lindner@starzel.de\n- Stefan Antonelli, stefan.antonelli@operun.de\n- Fulvio Casali, fulviocasali@gmail.com\n- Valentin Piret, valentin@affinitic.be\n- Peter Mathis, peter.mathis@kombinat.at\n\n\n:orphan:\n\nChangelog\n=========\n\n2.0 (2023-11-10)\n----------------\n\n- Add support for Plone 6.\n  [petschki]\n\n\n1.3 (2021-01-22)\n----------------\n\n- Set RelatedItemsFieldWidget to search to find all banners for a slider.\n  [pbauer]\n\n- Fix use of default_page\n  [pbauer]\n\n- Use named behaviors.\n  [pbauer]\n\n\n1.2 (2019-03-14)\n----------------\n\n- Add support for Python 3.\n  [pbauer]\n\n\n1.1 (2018-09-18)\n----------------\n\n- Use the banner from the root default content if there is one\n  [Vaal24]\n\n\n1.0 (2018-08-16)\n----------------\n\n- Add alt tag for banner image.\n  [tlotze]\n\n\n1.0b2 (2017-06-20)\n------------------\n\n- Pass full banner-obj to templates to allow accessing object-attibutes.\n  [pbauer]\n\n- Test against Plone 5.0.7 and fix all pep8-issues.\n  [pbauer]\n\n- Show YouTube and Vimeo videos in a banner.\n  [fulv]\n\n\n1.0b1 (2015-11-30)\n------------------\n\n- Use p5-style resources.\n  [pbauer]\n\n- No longer explicitly set the relateditemswidget (it's default in p5).\n  [pbauer]\n\n- Fix RelationList widget for slider_relation field. Fixes #1.\n  [fulv]\n\n- Remove last traces of grok.\n  [fulv]\n\n- Add compatability to Plone 5 with new buildout and test-setup.\n  [pbauer]\n\n\n0.2 (2015-11-30)\n----------------\n\n- Add Documentation.\n  [pbauer]\n\n- Remove grok.\n  [pbauer]\n\n- Simplify traversing.\n  [pbauer]\n\n- Unify css and templates.\n  [gomez]\n\n- Basic styling for banner/slider.\n  [santonelli]\n\n\n0.1 (26.3.2014)\n----------------\n\n- Initial release.\n  [pbauer, gomez]\n\n",
    "bugtrack_url": null,
    "license": "GPL version 2",
    "summary": "An add-on for Plone",
    "version": "2.0",
    "project_urls": {
        "Homepage": "https://pypi.python.org/pypi/collective.behavior.banner"
    },
    "split_keywords": [
        "python",
        "plone"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2110261770a11024fb8ce933a9fd367b80339cf0deab374eb8fa81277455e41c",
                "md5": "3592f6f4d07aae2c047bdecb2b5cbd68",
                "sha256": "0358d48ad5d5f043e8cbcfbe0d638bd745b474a5147b8260cc0a356b30053878"
            },
            "downloads": -1,
            "filename": "collective.behavior.banner-2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3592f6f4d07aae2c047bdecb2b5cbd68",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 25419,
            "upload_time": "2023-11-10T13:18:29",
            "upload_time_iso_8601": "2023-11-10T13:18:29.461287Z",
            "url": "https://files.pythonhosted.org/packages/21/10/261770a11024fb8ce933a9fd367b80339cf0deab374eb8fa81277455e41c/collective.behavior.banner-2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6d3d71f035d77ed2bbcc2383c5e26c925fe263cbf6776435090b90fa71e6c725",
                "md5": "3fbbccd66468e2f004e332604d8505b2",
                "sha256": "b088c87ebba8acdcc0bd2e87e54ec46598784f476cb0468828cb76c070a95afc"
            },
            "downloads": -1,
            "filename": "collective.behavior.banner-2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3fbbccd66468e2f004e332604d8505b2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 23702,
            "upload_time": "2023-11-10T13:18:31",
            "upload_time_iso_8601": "2023-11-10T13:18:31.193506Z",
            "url": "https://files.pythonhosted.org/packages/6d/3d/71f035d77ed2bbcc2383c5e26c925fe263cbf6776435090b90fa71e6c725/collective.behavior.banner-2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-10 13:18:31",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "collective.behavior.banner"
}
        
Elapsed time: 0.15213s