eea.uberlisting 2.0

Plone product for ajax display of available templates for the given content type

EEA Uberlisting
================
.. image:: http://ci.eionet.europa.eu/job/eea.uberlisting-www/badge/icon
:target: http://ci.eionet.europa.eu/job/eea.uberlisting-www/lastBuild
.. image:: http://ci.eionet.europa.eu/job/eea.uberlisting-plone4/badge/icon
:target: http://ci.eionet.europa.eu/job/eea.uberlisting-plone4/lastBuild

Introduction
============
`EEA Uberlisting`_ enhances and extends the listing layouts capabilities of Plone.

| By default this package can enable a view on the **Folder**, **Topic** and
**Collection** Content Type, which when enabled it gives the web visitor the
ability to switch between the views that are available for that Content Type,
instead of having a fixed one, all from the same template.

This is accomplished by loading the available template through ajax passing
in the the ajax_load parameter set by plonetheme.sunburst to
load the page without the columns and resources and then inject the result
in the uberlisting view.

|

.. contents::

Upgrade
=======

* As of 2.0 all of the Plone tricks that are described in the section of tips
and tricks can be added through the Uberlisting View form

Tips and tricks
===============

Javascript tips
---------------

Calling javascript on listing load
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* After we load these results we trigger an event which you can hook on in order
to modify the listing

::

ex: $(window).bind('Uberlisting.Success', function(ev) {
// Run galleryView on the listing results
$('#content').galleryView();
});

Modify the returning listing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* By default when doing the ajax load the load is checking if content-core is
available and if so it's content is added in the div with the id uber-view-content.

If your template doesn't have the content inside the content-core div then it will
return the results of the first div it find on the content that was returned from
the ajax load.

Therefore if you want to influence the result or your template doesn't
have the content-core id than just wrap the desired content inside of div tag.

Plone tips
----------

Choose the right templates to use for this package
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* The python logic that retrieves the contents of the template listings
expects the template to implement the **listing** macro.

By default all of the Plone templates implement this macro so all
templates that come from Plone and those that implement a listing macro
to list results should work with the Uberlisting View.

Disable templates from showing up in the Uberlisting View
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* In ZMI > context > manage_properties: Add a '*lines*' property named
**bannedUberlistingTemplates**.

Here add one by one the template id's that you would like to be skipped
from the listing.

::

ex: folder_summary_view
folder_contents

Set default template when visiting template for first time
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* In ZMI > context > manage_properties: Add a '*string*' property named
**defaultUberlistingTemplate** and add the template id that should be used
as the default template.

::

ex: folder_summary_view

By default if this property isn't set and no cookie is present with the name
of the default template then **folder_listing** will be used as default.

Get listing of templates as images instead of template title name
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* This packages looks for a png image to use for the views listing in the
format of template id + '.png'.

::

ex: folder_summary_view.png

We have provides some images for the common Plone templates as well as
some for our own templates, if you need a different style for the icons you can
customize them TTW or you can have a skin layer before **uberlisting_imgs** with
images that have the same name.

* If no images are found then the template name will be displayed in the listing.

* If you don't want to have the listing of templates with images and you would
prefer to have only template name then In ZMI > context > manage_properties:
Add a checked **boolean** property named '**noUberlistingTemplateImages**'

EEA products integration tips
-----------------------------

Get enhanced thumbnails when used with eea.depiction
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* If you have eea.depiction installed you can configure a fallback image for
the contenttypes that do not have an image field by default, allowing the
content to be displayed in a view where the listing would look better
with images like album view.

Get enhanced search capabilities when used with eea.facetednavigation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* If you have eea.facetednavigation installed you can use uberlisting_view as
a view for the Faceted Navigation, allowing you to combine the search capabilities
of it with the ability to change between views from the same template.


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

zc.buildout
-----------
If you are using `zc.buildout`_ and the `plone.recipe.zope2instance`_
recipe to manage your project, you can do this:

* Update your buildout.cfg file:

* Add ``eea.uberlisting`` to the list of eggs to install

* You can skip the ZCML slug since this package is using the z3c.autoinclude
include directive

::

[instance]
...
eggs =
...
eea.uberlisting

* Re-run buildout, e.g. with::

$ ./bin/buildout


Dependencies
============

`EEA Uberlisting`_ has the following dependencies:
- Plone 4+
- `EEA jQuery`_ - we are depending and loading only the `jquery.bbq`_ plugin

This package also supports other EEA Packages. Thus the following dependencies are optional:
- `EEA Depiction`_
- `EEA Faceted Navigation`_


Source code
===========

Latest source code (Plone 4 compatible):
- http://github.com/eea/eea.uberlisting
- http://github.com/collective/eea.uberlisting


Copyright and license
=====================
The Initial Owner of the Original Code is European Environment Agency (EEA).
All Rights Reserved.

The eea.uberlisting (the Original Code) is free software;
you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any later
version.

More details under docs/License.txt


Funding and project management
==============================

EEA_ - European Environment Agency (EU)

.. _EEA: http://www.eea.europa.eu/
.. _`EEA Uberlisting`: http://eea.github.com/docs/eea.uberlisting
.. _`EEA jQuery`: http://eea.github.com/docs/eea.jquery
.. _`EEA Depiction`: http://eea.github.com/docs/eea.depiction
.. _`EEA Faceted Navigation`: http://eea.github.com/docs/eea.facetednavigation
.. _`jquery.bbq`: https://github.com/cowboy/jquery-bbq
.. _`plone.recipe.zope2instance`: http://pypi.python.org/pypi/plone.recipe.zope2instance
.. _`zc.buildout`: http://pypi.python.org/pypi/zc.buildout

Changelog
=========

2.0 - (2013-04-06)
------------------
* Feature: added migration script which adds IUberlistingView to every Folder
that had uberlisting_view as enabled layout in order to enable Uberlisting
View z3c.form editing form
[ichim-david]
* Feature: Added default images for Topic, Collection and Folder
[ichim-david]
* Feature: Register package for Folder, Collection, Topic and
Dexterity Container
[ichim-david]
* Change: Load template also with ajax that loads on first page load.
This returns consistent result with loading of template from the uberlisting
switch buttons
[ichim-david]
* Change: Updated eea.pot file with newest translation terms
[ichim-david]
* Feature: Added a z3c.form BrowserView to enable easier customization of
these properties and available options
[ichim-david]
* Feature: Added object action that enables UberlistingView instead of relying
on just setting a template as default view.
[ichim-david]
* Feature: Added dedicated permissions for package usage, by default the
following Roles inherit this permission: Editor, Manager and
Site Administrator
[ichim-david]
* Feature: Added onlyUberlistingTemplateWithImages property in order to display
only templates that have corresponding images
[ichim-david]

1.0 - (2012-11-22)
------------------
* Feature: Added information for contributors
[ciobabog refs #13892]
- Initial release
[ichim-david]