collective.tiles.collection


Namecollective.tiles.collection JSON
Version 2.1.1 PyPI version JSON
download
home_pagehttps://pypi.org/project/collective.tiles.collection/
SummaryA tile that shows a set of collection results with a customizable layout
upload_time2024-03-06 10:10:30
maintainer
docs_urlNone
authorRedTurtle Technology
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.tiles.collection
==============================================================================

A tile that shows collection results with customizable layouts

Features
--------

- Emulates the old portlet collection behaviors
- Mosaic-ready
- Additional css class field, to append a custom css class to the tile container
- Customizable layouts list


Installation
------------

Install collective.tiles.collection by adding it to your buildout::

    [buildout]
    ...
    eggs =
        collective.tiles.collection


and then running ``bin/buildout``


Usage
-----

You can't use this tile without a tile manager (or maybe, you can if you create
new tiles manually in some specific context) like `Mosaic <https://pypi.python.org/pypi/plone.app.mosaic>`_ or `redturtle.tiles.management <https://github.com/RedTurtle/redturtle.tiles.management>`_

When you try to create a new collection tile, you have a form like the portlet's one.

Customizable layouts
--------------------

When you create/edit a collection tile, there is a field that allows you to select the final layout from a list.
This list is generated with a specific set of view that satisfy following rules:

- The Class must implement **ICollectiveTilesCollectionLayer** interface
- In the Class there should be an attribute **display_name** with a human-readable title
- The template need to define a macro called **collection-tile-macro**

This is an example:

`configure.zcml`::

    <browser:page
        name="additional_renderer"
        permission="zope2.View"
        for="*"
        class=".additional_render.View"
        layer=".interfaces.ISomeBrowserLayer"
        template="additional_render.pt"
    />


`additional_render.py`::

    from Products.Five.browser import BrowserView
    from collective.tiles.collection.interfaces import ICollectionTileRenderer
    from zope.interface import implements
    from collective.tiles.collection import _


    class AdditionalView(BrowserView):
        implements(ICollectionTileRenderer)

        display_name = _("Another tile layout")


`additional_render.pt`::

    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
          xmlns:tal="http://xml.zope.org/namespaces/tal"
          xmlns:metal="http://xml.zope.org/namespaces/metal"
          xmlns:i18n="http://xml.zope.org/namespaces/i18n"
          lang="en"
          metal:use-macro="here/main_template/macros/master"
          i18n:domain="collective.tiles.collection">
      <body>
        <metal:macro define-macro="collection-tile-macro">
          ...
        </metal:macro>
      </body>
    </html>


Translations
------------

This product has been translated into

- Italian


Contribute
----------

- Issue Tracker: https://github.com/collective/collective.tiles.collection/issues
- Source Code: https://github.com/collective/collective.tiles.collection

Credits
-------

Developed with the support of:

* `Regione Emilia-Romagna`__

Regione Emilia-Romagna supports the `PloneGov initiative`__.

__ http://www.regione.emilia-romagna.it/
__ http://www.plonegov.it/

Authors
-------

This product was developed by RedTurtle Technology team.

.. image:: http://www.redturtle.it/redturtle_banner.png
   :alt: RedTurtle Technology Site
   :target: http://www.redturtle.it/

License
-------

The project is licensed under the GPLv2.


Contributors
============

- RedTurtle Technology, sviluppoplone@redturtle.it


Changelog
=========

2.1.1 (2024-03-06)
------------------

- Avoid error when getting collection by UID.
  [daniele]


2.1.0 (2023-11-28)
------------------

- Add 'Show Description' option, default disabled to match rendering in previous versions of the tile.
  [fredvd]

- Plone 6 support: Refactor Mosaic addon support to use zcml condition instead of using the quickinstaller tool.
  [fredvd]

- Plone 6 support: Remove unused dependency on plone.formwidget.contenttree
  [fredvd]
  


2.0.0 (2022-09-14)
------------------

- Drop includeDependencies="." in order to work with pip
  [mamico]


1.3.1 (2021-09-27)
------------------

- Simplified and improved checks for registered renderers.
  [cekk]


1.3.0 (2021-09-10)
------------------

- Python3 compatibility.
  [cekk]
- Do not use templates registered from unavailable layers.
  [cekk]


1.2.1 (2021-05-07)
------------------

- Fix translations.
  [cekk]


1.2.0 (2019-01-09)
------------------

- Fixed permission to see empty tile collection message.
- Fixed vocabulary source for schema choice in tile collecton to support pam.
  [eikichi18]
- List of renderers is now sorted by title.
  [cekk]

1.1.3 (2018-08-21)
------------------

- Fix document outline [nzambello]
- Improved navigation experience when choosing the collection to use [daniele]  


1.1.2 (2018-08-02)
------------------
- Enable other content types to be chosen as the More link [daniele]
- Fixed a bug that hid a tile collection with no elements to display. If a user
  can edit the tiles, now he can see the empty tile.
  [arsenico13]
- Update some italian translations.
  [arsenico13]
- Fix templates for container styles in base view and in empty tile handling
  [nzambello]


1.1.1 (2018-03-06)
------------------
- Added Custom "more..." collection field
  [fdelia]

1.1 (11/10/2017)
----------------

- Production release
  [lucabel]

1.0a2 (2017-09-13)
------------------

- Removed unused css class
  [cekk]

1.0a1 (2017-03-31)
------------------

- Initial release.
  [cekk]

- Fix indentation on README.rst

            

Raw data

            {
    "_id": null,
    "home_page": "https://pypi.org/project/collective.tiles.collection/",
    "name": "collective.tiles.collection",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "Python Plone",
    "author": "RedTurtle Technology",
    "author_email": "sviluppoplone@redturtle.it",
    "download_url": "https://files.pythonhosted.org/packages/b3/4f/083dd82168546a36ff77010b0031c12fa70f1a5f5f77718bc116d5620494/collective.tiles.collection-2.1.1.tar.gz",
    "platform": null,
    "description": "==============================================================================\ncollective.tiles.collection\n==============================================================================\n\nA tile that shows collection results with customizable layouts\n\nFeatures\n--------\n\n- Emulates the old portlet collection behaviors\n- Mosaic-ready\n- Additional css class field, to append a custom css class to the tile container\n- Customizable layouts list\n\n\nInstallation\n------------\n\nInstall collective.tiles.collection by adding it to your buildout::\n\n    [buildout]\n    ...\n    eggs =\n        collective.tiles.collection\n\n\nand then running ``bin/buildout``\n\n\nUsage\n-----\n\nYou can't use this tile without a tile manager (or maybe, you can if you create\nnew tiles manually in some specific context) like `Mosaic <https://pypi.python.org/pypi/plone.app.mosaic>`_ or `redturtle.tiles.management <https://github.com/RedTurtle/redturtle.tiles.management>`_\n\nWhen you try to create a new collection tile, you have a form like the portlet's one.\n\nCustomizable layouts\n--------------------\n\nWhen you create/edit a collection tile, there is a field that allows you to select the final layout from a list.\nThis list is generated with a specific set of view that satisfy following rules:\n\n- The Class must implement **ICollectiveTilesCollectionLayer** interface\n- In the Class there should be an attribute **display_name** with a human-readable title\n- The template need to define a macro called **collection-tile-macro**\n\nThis is an example:\n\n`configure.zcml`::\n\n    <browser:page\n        name=\"additional_renderer\"\n        permission=\"zope2.View\"\n        for=\"*\"\n        class=\".additional_render.View\"\n        layer=\".interfaces.ISomeBrowserLayer\"\n        template=\"additional_render.pt\"\n    />\n\n\n`additional_render.py`::\n\n    from Products.Five.browser import BrowserView\n    from collective.tiles.collection.interfaces import ICollectionTileRenderer\n    from zope.interface import implements\n    from collective.tiles.collection import _\n\n\n    class AdditionalView(BrowserView):\n        implements(ICollectionTileRenderer)\n\n        display_name = _(\"Another tile layout\")\n\n\n`additional_render.pt`::\n\n    <html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\"\n          xmlns:tal=\"http://xml.zope.org/namespaces/tal\"\n          xmlns:metal=\"http://xml.zope.org/namespaces/metal\"\n          xmlns:i18n=\"http://xml.zope.org/namespaces/i18n\"\n          lang=\"en\"\n          metal:use-macro=\"here/main_template/macros/master\"\n          i18n:domain=\"collective.tiles.collection\">\n      <body>\n        <metal:macro define-macro=\"collection-tile-macro\">\n          ...\n        </metal:macro>\n      </body>\n    </html>\n\n\nTranslations\n------------\n\nThis product has been translated into\n\n- Italian\n\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/collective/collective.tiles.collection/issues\n- Source Code: https://github.com/collective/collective.tiles.collection\n\nCredits\n-------\n\nDeveloped with the support of:\n\n* `Regione Emilia-Romagna`__\n\nRegione Emilia-Romagna supports the `PloneGov initiative`__.\n\n__ http://www.regione.emilia-romagna.it/\n__ http://www.plonegov.it/\n\nAuthors\n-------\n\nThis product was developed by RedTurtle Technology team.\n\n.. image:: http://www.redturtle.it/redturtle_banner.png\n   :alt: RedTurtle Technology Site\n   :target: http://www.redturtle.it/\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\n\nContributors\n============\n\n- RedTurtle Technology, sviluppoplone@redturtle.it\n\n\nChangelog\n=========\n\n2.1.1 (2024-03-06)\n------------------\n\n- Avoid error when getting collection by UID.\n  [daniele]\n\n\n2.1.0 (2023-11-28)\n------------------\n\n- Add 'Show Description' option, default disabled to match rendering in previous versions of the tile.\n  [fredvd]\n\n- Plone 6 support: Refactor Mosaic addon support to use zcml condition instead of using the quickinstaller tool.\n  [fredvd]\n\n- Plone 6 support: Remove unused dependency on plone.formwidget.contenttree\n  [fredvd]\n  \n\n\n2.0.0 (2022-09-14)\n------------------\n\n- Drop includeDependencies=\".\" in order to work with pip\n  [mamico]\n\n\n1.3.1 (2021-09-27)\n------------------\n\n- Simplified and improved checks for registered renderers.\n  [cekk]\n\n\n1.3.0 (2021-09-10)\n------------------\n\n- Python3 compatibility.\n  [cekk]\n- Do not use templates registered from unavailable layers.\n  [cekk]\n\n\n1.2.1 (2021-05-07)\n------------------\n\n- Fix translations.\n  [cekk]\n\n\n1.2.0 (2019-01-09)\n------------------\n\n- Fixed permission to see empty tile collection message.\n- Fixed vocabulary source for schema choice in tile collecton to support pam.\n  [eikichi18]\n- List of renderers is now sorted by title.\n  [cekk]\n\n1.1.3 (2018-08-21)\n------------------\n\n- Fix document outline [nzambello]\n- Improved navigation experience when choosing the collection to use [daniele]  \n\n\n1.1.2 (2018-08-02)\n------------------\n- Enable other content types to be chosen as the More link [daniele]\n- Fixed a bug that hid a tile collection with no elements to display. If a user\n  can edit the tiles, now he can see the empty tile.\n  [arsenico13]\n- Update some italian translations.\n  [arsenico13]\n- Fix templates for container styles in base view and in empty tile handling\n  [nzambello]\n\n\n1.1.1 (2018-03-06)\n------------------\n- Added Custom \"more...\" collection field\n  [fdelia]\n\n1.1 (11/10/2017)\n----------------\n\n- Production release\n  [lucabel]\n\n1.0a2 (2017-09-13)\n------------------\n\n- Removed unused css class\n  [cekk]\n\n1.0a1 (2017-03-31)\n------------------\n\n- Initial release.\n  [cekk]\n\n- Fix indentation on README.rst\n",
    "bugtrack_url": null,
    "license": "GPL version 2",
    "summary": "A tile that shows a set of collection results with a customizable layout",
    "version": "2.1.1",
    "project_urls": {
        "Homepage": "https://pypi.org/project/collective.tiles.collection/"
    },
    "split_keywords": [
        "python",
        "plone"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b34f083dd82168546a36ff77010b0031c12fa70f1a5f5f77718bc116d5620494",
                "md5": "b592da9cdc6f793bcb6c3afe24bfe2fe",
                "sha256": "d87eb4f98f3495720fe33c83412b5ee7f64733978a99235569c70a72cd3231ae"
            },
            "downloads": -1,
            "filename": "collective.tiles.collection-2.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b592da9cdc6f793bcb6c3afe24bfe2fe",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 25314,
            "upload_time": "2024-03-06T10:10:30",
            "upload_time_iso_8601": "2024-03-06T10:10:30.254036Z",
            "url": "https://files.pythonhosted.org/packages/b3/4f/083dd82168546a36ff77010b0031c12fa70f1a5f5f77718bc116d5620494/collective.tiles.collection-2.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-06 10:10:30",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "collective.tiles.collection"
}
        
Elapsed time: 2.78000s