eea.uberlisting 3.1

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

Contents

• Introduction

• How to enable

• Upgrade

• Tips and tricks

  • Javascript tips

    • Calling javascript on listing load

    • Modify the returning listing

  • Plone tips

    • Disable templates from showing up in the Uberlisting View

    • Set default template when visiting template for first time

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

  • EEA products integration tips

    • Get enhanced thumbnails when used with eea.depiction

    • Get enhanced search capabilities when used with eea.facetednavigation

• Installation

• Dependencies

• Source code

• Copyright and license

• Funding and project management

• Changelog

  • 3.1 - (2019-01-28)

  • 3.0 - (2018-08-27)

  • 2.9 - (2017-12-12)

  • 2.8 - (2017-11-07)

  • 2.7 - (2017-05-15)

  • 2.6 - (2017-04-24)

  • 2.5 - (2016-05-19)

  • 2.4 - (2015-03-17)

  • 2.3 - (2014-01-21)

  • 2.2 - (2013-09-23)

  • 2.1 - (2013-04-17)

  • 2.0 - (2013-04-06)

  • 1.0 - (2012-11-22)

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 listing 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 UberlistingView.

How to enable

This view is enabled through an action called Enable UberlistingView which is found within the actions dropdown menu for the content types mentioned in the introduction.

Upgrade

• As of 2.0 all of the Plone tips and tricks that are described in the section of tips and tricks can be added through the Uberlisting View form allowing therefore users without permission to the ZMI to make changes to the view

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

• As mentioned in the upgrade steps these steps no longer need to be added manually, however by visiting manage_properties you can see these properties added after using the view form.

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):

• https://github.com/eea/eea.uberlisting

• https://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)

Changelog

3.1 - (2019-01-28)

• Jenkins: Add sonarqube step [avoinea refs #101552]

3.0 - (2018-08-27)

• Change: Get base-url from body data base-url [avoinea refs #97843]

• Change: updated URLs pointing to eea.europa.eu with https:// [alecghica refs #95849]

2.9 - (2017-12-12)

• Change: Replace eeacms/zptlint with eeacms/plone-test:4 zptlint [avoinea refs #90415]

2.8 - (2017-11-07)

• Change: Remove Sphinx generated documentation [petchesi-iulian refs #88212]

2.7 - (2017-05-15)

• Change: fixed PyLint warnings and errors [eduard-fironda refs #84949]

2.6 - (2017-04-24)

• Change: updated package information [eduard-fironda]

2.5 - (2016-05-19)

• Bug fix: Fix pylint warnings [ichim-david refs #71940]

2.4 - (2015-03-17)

• Change: Switched to curl in the jenkins build install script [olimpiurob refs #22402]

• Change: Changed fetch url for jenkins build install script to the install script from the main EEA CPB repository [olimpiurob refs #22402]

2.3 - (2014-01-21)

• Bug fix: removed wrongly added blockquotes within README.rst [ichim-david refs #18064]

• Feature: adding Sphinx-generated documentation in Page Template format [batradav refs #9502]

2.2 - (2013-09-23)

• Change: updated README.txt to make it more clear on how to enable the UberlistingView [ichimdav fixes #16632]

2.1 - (2013-04-17)

• Change: removed documentation entry regarding use of macros since as of 2.0 we load the template through ajax [ichim-david]

• Add document to globals to avoid jslint error [ichim-david]

• Bug fix: fixed HISTORY.txt RST markup [ghicaale refs #14321]

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]