Skip to main content

An alternative method for handling and showing tiles

Project description

.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide_addons.html
This text does not appear on pypi or github. It is a comment.

==============================================================================
redturtle.tiles.management
==============================================================================

.. image:: https://travis-ci.org/RedTurtle/redturtle.tiles.management.svg?branch=master
:target: https://travis-ci.org/RedTurtle/redturtle.tiles.management

A tiles management system, easier than plone.app.mosaic that uses
`plone.app.tiles`__ and `Mockup`__ functionalities to build a simple UI.

__ https://github.com/plone/plone.app.tiles
__ https://github.com/plone/mockup

Features
--------

- Simple UI to add/remove/edit registered tiles
- Tiles sorting with drag-and-drop (thanks to mockup)
- Tiles resizing (with default or custom CSS classes)
- Tile manager is a pattern that can be included in every custom page
- **plone.layoutaware** behavior enabled for Documents
- Example *tiles_view* view available for all objects with "plone.layoutaware" behavior enabled
- Customizable available tiles list from control panel

Usage
-----

Tiles manager works with plone.app.blocks features and its plone.layoutaware behavior, so you can use this functionality
only on Content Types with this behavior enabled.

Installing this product, a new pattern will be available: "*pat-tiles-management*", and you only need to insert a pattern-style tag into your view like this:

.. code-block:: html

<div class="pat-tiles-management" data-pat-tiles-management="managerId:myManager" />

You need to provide a **managerId** attribute, because multiple managers can be instantiated in a view, and with this, the pattern can handle the tiles stored in each manager.


Available tiles list
--------------------

You can configure a list of addable tiles for this manager in Plone's control panel:
http://yoursite/@@tiles-management-settings

In the "Add new tile" menu you'll see this list filtered also by single tiles permission.


Tile resizing
-------------

If you want two tiles in a row, from tile control buttons select a style in the "resize" dropdown.
There are two default styles:

- reset (with no CSS classes)
- two tiles in a row (`half-width` class)

These CSS classes can be configured in control panel.


JS Development and bundling
---------------------------

If you need to develop this product's javascripts or styles, you need to compile the code
for the resource registry bundle. To do this, there are two grunt tasks.

First of all, you need to install grunt dependencies listed in package.json file in the root of this package:

.. code-block:: shell

npm install

or if you prefer yarn:

.. code-block:: shell

yarn

After that, you can use two different grunt tasks:

- `grunt`: the default task, that listen files changes with `watch` and re-build resources and bundles automatically
- `grunt compile`: to manually compile all resources and bundles


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

This product has been translated into

- Italian


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

Install redturtle.tiles.management by adding it to your buildout::

[buildout]

...

eggs =
redturtle.tiles.management


and then running "bin/buildout"


Compatibility
-------------
This package is developed with mockup, so is fully compatible for Plone 5.

From 1.0.0 version, Plone 4 compatibility has been dropped, so you need to use the 0.x branch.

Contribute
----------

- Issue Tracker: https://github.com/RedTurtle/redturtle.tiles.management/issues
- Source Code: https://github.com/RedTurtle/redturtle.tiles.management


License
-------

The project is licensed under the GPLv2.

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

- RedTurtle Technology, sviluppoplone@redturtle.it

Changelog
=========


1.2.0 (2018-08-21)
------------------

BREAKING CHANGES:

- Handled tile sizing with a new button with styles given in controlpanel [nzambello]


Other changes:

- Fix IE11 compatibility in js.
[cekk]
- Sorting not enabled on mobile [nzambello]
- Removed container margin, it should be styled by themes, if needed [pnicolli]
- Fix z-index of tileEditButtons [fdelia]


1.1.3 (2018-04-30)
------------------

- Fix data-tile urls generation to don't break subrequest rendering when there
is a reverse proxy configuration with `_vh_ ` (https://github.com/plone/plone.subrequest/issues/17).
[cekk]



1.1.2 (2018-03-16)
------------------

- Fix permission checks in addable tiles vocabulary.
Now use correct permission (name) and not the id.
[cekk]


1.1.1 (2018-03-12)
------------------

- Fix pypi brown bag release
[cekk]

1.1.0 (2018-03-12)
------------------

- Add a loader when tiles are fetched
[cekk]
- Remove empty managers when user can't add tiles
[cekk]
- Refactor manager render view. Now is lighter (no more unused Plone body macros)
and can be used also in static renders
[cekk]

1.0.2 (2017-12-21)
------------------

- Fix IE11 compatibility: add babel-polyfill to correctly handle CustomEvent raise
[cekk]


1.0.1 (2017-09-13)
------------------

- Fix README code syntax
[cekk]

1.0.0 (2017-09-13)
------------------

- Massive changes in tiles storing (with p.a.blocks plone.layoutaware behavior)
and in tiles management: now it's a pattern that can be instantiated several
times in the view
[cekk]
- Add controlpanel to configure a list of addable tiles from registered ones.
[cekk]
- Add icon and button color for action hide tile [nekorin]
- Handle error message when there are problems fetching tiles
[cekk]
- Added an event dispatched when tiles are added to the DOM [nzambello]
- Drop support for Plone4. Use branch 0.x for Plone 4
[cekk]

0.2.1 (2017-04-12)
------------------

- Fixed resources import in tiles_view [pnicolli]
- Fixed rolemap. Permission to edit tiles given to 'Editor' #10460 [arsenico13]
- .DS_Store added to .gitignore and MANIFEST [arsenico13]
- Fixed tiles edit link. This fixes the edit capability when a page is a default view for a folder. [arsenico13]


0.2.0 (2016-12-09)
------------------

- Replaced unused plone.app.tiles.AddTile permission with "cmf.ModifyPortalContent"
[cekk]
- Add Plone4 compatibility
[cekk]
- Fix permission for add tile to "cmf.ModifyPortalContent"
[arsenico13]
- Add italian translations
[cekk]


0.1.0 (2016-09-19)
------------------

- Initial release.
[cekk]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

redturtle.tiles.management-1.2.0.tar.gz (103.5 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page