EEA Faceted Navigation
Project description
The EEA Faceted Navigation (FacetedNav) gives you a very powerful interface to improve search within large collections of items. No programming skills are required by the website manager to configure the faceted navigation interface, configuration is done TTW. It lets you gradually select and explore different facets (metadata/properties) of the site content and narrow down you search quickly and dynamically.
On the contrary, plone collections are static, in a way that the site admin decides the search criteria and the end user is not able to further sort or filter the presented results.
FacetedNav is fully customizable, site admin may decide that some criteria (facets) must have fixed values while other may be presented as filter options to the web visitor.
FacetedNav may very well replace the standard collection content type, since it covers same functionality and it adds a lot more features.
FacetedNav can also be used as an advanced search for your site.
Main features
It comes with plenty of configuration options and features like:
Easy customizable GUI via drag-n-drop, no restart needed.
Facets can be set to fixed default values and hidden.
Facets can be placed in standard search or extended search panels, to not intimidate novice users and have cleaner interface
Facets can be displayed via several widgets like select, radio, text input, tag cloud, date range and more
Expandable and collapsible widgets with many values
Automatically counts number of content items beside each facet value
Possibility to show or hide the options with zero results (show only the facets which return content)
Ability to create your custom content types definition to be used as a combination of interface and portal type, presented in a single widget.
Export of search result in RSS.
Pleasant user interface based on Ajax JQuery, implemented with “deep linking”, so bookmarking a faceted query works, browser history supported.
Export / Import of faceted settings as XML. Useful to replicate same facets navigation on another site.
Search engine friendly, disabling javascript acts as a normal collection batch list.
Synchronization of settings across multiple languages, I18N support.
High performance by caching faceted catalog queries via distributed memory object caching system: memcached
Smart facets hiding - hide facets criteria if there is only one page of results (This can be explicitly disabled/enabled from version 4.6. It is also disabled by default for new faceted navigable pages starting with version 5.2)
Ability to transform faceted navigable items in search forms by putting them in the ‘search mode’ (starting with version 4.6)
Ability to enable/disable Plone portlets left and right columns within faceted navigable contexts (starting with version 4.1. Both disabled by default for new faceted navigable pages starting with version 5.2)
Faceted settings
(New in version 4.1)
Faceted settings is a menu that appears once you enable Faceted navigation within your context next to the Actions menu and it allows you to perform the following actions:
Enable/disable left portlets
This allows you to gain more space for faceted navigation pages by disabling Plone portlets left column.
Default: disabled (starting with version 5.2)
Enable/disable right portlets
This allows you to gain more space for faceted navigation pages by disabling Plone portlets right column.
Default: disabled (starting with version 5.2)
Enable/disable smart facets hiding
Hide facets criteria if there is only one page of results.
Default: disabled (starting with version 5.2)
Extra
You can extend faceted navigation functionality by installing the following addons:
Customized vocabularies
Products.ATVocabularyManager
Multilingual/translation solution
Products.LinguaPlone
Cache (memcache)
plone.memoize
eea.cache
Relations
eea.relations
Faceted extensions
eea.faceted.tool
eea.faceted.inheritance
Faceted themes
eea.faceted.blue
Screenshots
See more FacetedNavigationScreenshots.
Live demo
Here some live production demos:
Buildout installation
Source code
Eggs repository
Plone versions
It has been developed and tested for Plone 2, 3 and 4. See buildouts section above.
Known bugs and ongoing development
Bugs and new features are entered on our Trac server at EEA.
Copyright and license
The EEA Faceted Navigation (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.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
The Initial Owner of the Original Code is European Environment Agency (EEA). Portions created by Eau de Web are Copyright (C) 2009 by European Environment Agency. All Rights Reserved.
Other resources
Flamenco faceted navigation made at University of Berkeley
Folder navigation (GSoC) A new product Folder Navigation in early development]
Exhibit Client based faceted navigation via javascript
Changelog
6.6 - (2014-01-21)
Bug fix: Fix field default value rendering with chameleon, avoiding use of ‘default’ name in tal, wich is a reserved keyword. [thomasdesvenain]
Bug fix: Fix xml import of ‘0’ values for boolean properties which were considered as True. [thomasdesvenain]
Feature: Add a new widget : BooleanWidget We get a checkbox widget to filter contents which gets a true boolean value for an index (FieldIndex or BooleanIndex). [thomasdesvenain]
Bug fix: In search mode, search results were not kept when we go back. [thomasdesvenain]
Feature: French translations updates. [thomasdesvenain]
Bug fix: Added translations for ‘Current filters’. [prospchr]
Feature: Radio and checkbox widgets query for unicode or encoded strings depending on the availability of plone.app.contenttypes. This is a requirement to work with dexterity [do3cc]
Feature: adding Sphinx-generated documentation in Page Template format [batradav refs #9502]
6.5 - (2013-11-20)
Bug fix: fix url handling in settings menu [kiorky]
6.4 - (2013-10-25)
Bug fix: Added ‘Current filters’ to plone-manual.pot and updated po files. [prospchr]
6.3 - (2013-10-04)
Bug fix: Add sensical da translations [tmog]
6.2 - (2013-09-23)
Feature: Option to disable inheriting the configuration from the canoical language (only displayed when the object is not canonical). [pbauer]
6.1 - (2013-09-13)
Bug fix: Allow using keywords with spaces in a radio-widget. [pbauer]
Bug fix: Fixed adding path facet on faceted navigable objects that are default views for their parents [avoinea refs #33 github]
Feature: Slovak translation updates [rlacko]
6.0 - (2013-09-06)
Feature: Possibility to make AND/OR operator within checkbox facet visible for anonymous users [voineali refs #16624]
5.9 - (2013-08-09)
Date range error message is delegated so it can be overriden. [thomasdesvenain]
Updating feeds to use the syndication available in Plone 4.3 [hman]
5.8 - (2013-07-08)
If dexterity is installed, added a behavior that allows to enable faceted navigation on all instances of a dexterity portal type. [thomasdesvenain]
We have an option to hide “All” option from radio widget. [thomasdesvenain]
Bug fix: If we have selected “search only in all elements” for text widget, behavior is the one expected. [thomasdesvenain]
Bug fix: Fix ui-icon-hide and ui-icon-show in configure_faceted.html view in Plone 4.3.1. [cedricmessiant]
5.7 - (2013-06-17)
Bug fix: Fix JS typo within DateRange widget [voineali refs #14677]
Criteria entries are each in a span container. [thomasdesvenain]
5.6 - (2013-05-20)
Add ids to criteria filtering entries. [thomasdesvenain]
Fix: Iterate on batch instead of folderContents in preview-items.pt It previously loaded all objects instead of the only first 100 when no criterion was given. [vincentfretin]
Feature: Removed lovely.memcached dependency [voineali refs #14343]
Change: Added id to <li> in checkbox widget. [cedricmessiant]
Change: changed links for open and closed issues for facetednavigation to point to taskman [ichim-david]
Fix: Prevent whole select form from appearing if vocal is empty [davismr]
Fix: Add labels for select and text field, fixes issues 29 and 30 [davismr]
Fix: text widget input immediately gets value set in the url as input value. [thomasdesvenain]
Add an option to hide all/current alternative on text search widget. [thomasdesvenain]
5.5 - (2013-02-25)
Feature: added information for contributors [ciobabog refs #13892]
Change: Plone 4.3 compatible [lewicki]
5.4 - (2013-02-04)
Bug fix: Fixed: Faceted countings are not updated for checkboxes widget if AND operator is used [hman refs #8061]
Bug fix: Fixed: Date widget doesn’t update when value comes from URL [hman refs #8382]
Bug fix: Fixed: Bug in the Alphabetic widget [hman refs #8831]
5.3 - (2012-11-22)
Bug fix: Fixed: faceted CSS overrides ui-accordion and ui-state-default styles and breaks things outside faceted navigable pages (e.g. Daviz Edit) [voineali refs #9610]
Feature: Slovak translation updates [rlacko]
5.2 - (2012-11-09)
Feature: Support new Collection (plone.app.collection) and new Folder (plone.app.folder) by default [avoinea]
Change: Disable by default for new faceted navigable pages all the advanced settings like: smart facets hiding. Also disable Plone portlets left/right columns. These still can be activated within the ‘Faceted settings’ menu. [avoinea refs #24 github]
Bug fix: folder content listing when there are no search results [hman fixes #10]
5.1 - (2012-10-08)
Bug fix: Fixed ‘smart facets hiding’ property for faceted inheritors. [ghicaale refs #5564]
Feature: Adding new “Results Filter” widget which allows filtering the resulting brains from a query using a tal expression, similar to the “TAL Expression” widget [batradav]
5.0 - (2012-09-18)
Bug fix: Review state was fixed to published only. Let the catalog filter this. Explanation at mailing list Upgrade step: warning for those still using old workflows with the infamous state ‘visible’ aka ‘Public draft’ and you want to exclude such content from searches, than follow instructions at mailing list above. [jensens]
Bug fix: Cleanup zope.app.content.interfaces.IContentType dependency [voineali]
Feature: Adding posibility to sort CountableWidget instances by the counted results [batradav]
Bug fix: Only reorder options of select widget, sorting by count is active [do3cc]
4.9 - (2012-08-27)
Bug fix: With some widgets (sort, date), batch navigation was broken. [thomasdesvenain]
Feature: Added buildouts folder which will contain various samples of configurations [ghicaale #5418]
Bug fix: Changed selector when checking for syndication which was changed from Plone 2.5 to Plone 4 [ichimdav #5412]
Feature: Extracted po message about date widget for all languages. [thomasdesvenain]
Feature: French translations [thomasdesvenain]
Feature: Fixed sort widget reverse option switch. [thomasdesvenain]
Feature: Sort widget works with checkbox/radio widget counters. [thomasdesvenain]
Bug fix: Check if type has a ‘/view’ url (is in typesUseViewActionInListings) on faceted preview item view. [thomasdesvenain]
Feature: Added a Faceted.Options object in view.js so that some behaviors can be customized [thomasdesvenain]
4.8 - (2012-07-17)
Bug fix: Fixed formated_time method in daterange widget to also accept years as valid dates [voineali fixes #5371]
Feature: Changed the i18n keys in .pt inorder to use Google translator kit for translations. Added new translations: bg, cs, da, el, et, fi, hu, is, lt, lv, mt, nl, no, pt, ru, sk, sl, sv, tr [prospchr fixes #5378]
4.7 - (2012-07-13)
Bug Fix: Fixed i18n missing attributes in .pt files [prospchr refs #5162]
4.6 - (2012-06-12)
Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for eea.facetednavigation [voineali refs #5218]
Feature: Added ‘search’ mode for faceted navigable items. See ‘Actions’ menu. ‘search mode’ => Display no items on load, just the faceted widgets/facets Useful when you want to replace Plone default search form with a faceted navigable one. Also this is useful when you enable faceted navigation on large databases. [voineali refs #5218]
Feature: Added a way to disable ‘smart facets hiding’. See ‘Faceted settings’ menu. ‘smart facets hiding’ => facets are hidden if there is only one page of results [voineali refs #3581]
4.5 - (2012-04-26)
Improve daterange index (large intervals) [kiorky]
Add range index [kiorky]
4.4 - (2012-04-03)
Change: Added ‘faceted-preview-items’ View as the default view for Faceted navigable objects instead of relaying on ‘folder_listing’ to be forever compatible with eea.facetednavigation. This is also a more flexible solution as you can customize each item display by providing a custom ‘faceted-preview-item’ z3 component for each of this items. [voineali #4968]
Fixed: Dynamically get old-style Faceted Views (Faceted Layouts) used by the Display menu, instead of caching them in annotations [voineali]
Change: Always find language-independent content [pbauer]
Change: Updated Faceted Views example (see eea.facetednavigation.views.example.summary.pt for more details on how the template should look in order to be used as a Faceted View) [voineali]
Feature: Added round corners, gradients and box shadows in edit mode [voineali]
Added Italian translation and some i18n missing strings [giacomos]
4.3 - (2012-01-03)
Hide/show criteria on criteria widget is now an option on this widget. It remains enabled by default. [thomasdesvenain]
Fixed: when a checkbox field had a default value as ‘True’, when widget was set to ‘False’ (unchecked) on the form, the checbox remained checked after submission. [thomasdesvenain]
Some internationalization fixes, msg extraction and french translations. [thomasdesvenain]
4.2 - (2011-12-15)
Bug fix: Include .mo translation files in the egg [voineali]
Bug fix: Wrapped value from select widget with “” to avoid option attribute selector error with jquery 1.7.1 when the value contained a non continuos word [ichimdav]
Feature: Added an easy way to define Faceted Views for the results using Zope3 components. See eea.facetednavigation.views.example for more details [voineali]
4.1 - (2011-11-06)
Feature: Replaced hardcoded green colors in Tags Widget in order to easily customize faceted theme [voineali]
Feature: Replaced the “basic search/extended search” accordion with a more simple and user friendly “More/Less filters” button [voineali #2408]
Feature: Added “Hide/Show filters” button to “Criteria widget” [voineali #4551]
Bug fix: Fixed back button by forcing jQuery to use traditional way to parametrize query [voineali #4524]
Bug fix: Use ‘eea.faceted.configure’ permission for all faceted related views in order to avoid having actions that raise Insufficient Privileges [voineali]
Bug fix: Fixed duplicate resources load if faceted widgets are using the same CSS/JS resource [voineali #4510]
i18n: Cleanup all widgets schema to use translations messages [voineali]
i18n: Fixed actions.xml to use ‘eea’ i18n:domain [voineali]
i18n: updated romanian translation [voineali]
i18n: updated german translation. [jensens]
Internationalization [thomasdesvenain]
Feature: Added possibility to disable plone left/right columns in view mode [voineali #4493]
Feature: Disabled plone left/right columns in edit mode [voineali #4493]
Feature: Switched show.png with hide.png as it seems more logical this way [voineali]
Feature: Added javascript that will allow to add an indipendent faceted search on any other page. it will translate the submitted keys and values into faceted anchors parameters. the js has example on how to use it. [demarant]
Feature: HTML5 validation [ghicaale #4444]
Feature: Improved performance for large queries by avoiding unnecessary iteration over results. [yomatters]
EEA Feature: Added upgrade script to fix default layout (‘folder_summary_view’ for Plone3 ported objects). [voineali #4439]
Feature: Added upgrade scripts to cleanup p4a.subtyper interface references and annotations. [voineali #4439]
Feature: Changed word break in checkbox and radio facet from 5 to 15 characters. [vincentfretin]
Bug fix: Fixed atct_album_view layout [voineali #4369]
4.0 - (2011-06-24)
Bug fix: do not display empty text criteria on criteria widget. [thomasdesvenain]
i18n: resynced, added stubs with some terms translated for: it, pl, es [jensens]
Bug fix: catalog index vocabulary works with int or float values. [thomasdesvenain]
Change: Delegate criteria display check to a view so it can be customized. [thomasdesvenain]
Bug fix: Fixed cachekeys as they where not unique in some situations. [voineali #4254]
Feature: Added a po generation script. Added french translations. Added translations file for plone domain. Internationalized schemata, forms and vocabularies. Optimizations. [thomasdesvenain]
Feature: i18n: added locales directory and registered it. Added pot-file and po file with translations for german. Added i18n-domains to a bunch of pt-files to make i18ndude happy. [jensens, 2011-05-09]
Bug fix: When navigating the tabs of eea.relations popup, the number of AJAX calls increases [voineali #3588, #4232]
Cleanup: Dropped simplejson dependency [voineali #4254]
Feature: Added a way to disable IPossibleFacetedNavigable for Plone default Content-Types [voineali #4254] - Thanks to thomasdesvenain
Feature: Removed “Layout” menu, and override “Display” menu in order to keep consistency and not to confuse novice users with to many places to select object layout/display [voineali #4254]
Feature: Dropped p4a. dependencies [voineali #4254]
Bug fix: Fixed GenericSetup circular dependencies warning [voineali #4254]
Bug fix: Fixed Schema positional arguments warning [voineali #4254]
Bug fix: Fixed faceted_subtyper permissions [voineali #4254]
Bug fix: Fixed configure faceted permission [voineali #4254]
Feature: Simplified “possible faceted navigable” mechanism. Now all you have to do is to implement IPossibleFacetedNavigable interface within your configure.zcml, no more p4a.subtyper descriptors for each portal type. [voineali #4254]
Cleanup: Fixed all pylint, pyflakes violations [voineali #4254]
Cleanup: Use “eea” i18n domain for all EEA packages [voineali #4254]
Bug fix: Non eea vocabularies values are translated [thomasdesvenain]
Bug fix: Plone 4.1 compatible [thomasdesvenain]
Feature: Keep input text for Text facet on submit [voineali]
Feature: If TAL wigdet returns a callable, call it [jensens]
Bug fix: Fix TAL and Text field set default value [voineali]
Bug fix: Fix facets position update [voineali]
Bug fix: Fix checkboxes facet set default value [voineali]
Feature: Path widget got depth query parameter. [jensens, 2011-03-01]
Bug fix: Fixed Widgets: TAL (removed index field, made expression visible), Path (default handling was broken). Some code-cleanup and simplifications. [jensens, 2011-03-01]
Change: Added entry-point for z3c.autoinclude to setup.py and thus make it simple to install [jensens, 2011-02-22]
Bug fix: Fixed counting issue caused by jQuery 1.4 params style. [voineali #3658]
Bug fix: Fixed alphabetic widget [voineali #3658]
Bug fix: Fixed text widget query [voineali #3974, #4018]
Bug fix: Fixed JS Faceted URL change trigger on first page access if no facet is visible [voineali #3970]
Bug fix: Fixed batch navigation [voineali]
Change: Modified SKOS view so that tests pass without LinguaPlone. [yomatters]
Change: Removed unnecessary menu item registration for syndication. [yomatters]
Bug fix: Fixed cache headers for @@faceted_counter, @@tagscloud_counter. [voineali #3935]
Bug fix: Faceted tal expression widget ignores values with value False [voineali #3890]
4.0-rc1 (2010-11-15)
Feature: Moved to Plone collective and start make the package compatible with Plone 4. [voineali, ghicaale, hpeteragitator]
3.11 - (2011-05-24)
Feature: Replaced hardcoded green colors in Tags Widget in order to easily customize faceted theme [voineali]
3.10 (2011-04-19)
Bug fix: Fixed subtyper access on Plone 2.5 [voineali] Use this version on Plone 2.x as version 3.9 is broken.
3.9 (2011-04-19)
Bug fix: Fixed permission for subtyper [voineali]
3.8 - (2010-12-22)
Bug fix: Removed UnicodeSplitter from text widget query as it was bugous and fixed it to work also with “(”, “)” in query [voineali #4018]
3.7 - (2010-12-13)
Bug fix: Fixed text widget query for non ZCTextIndex indexes. [voineali #3974]
Bug fix: Fixed JS Faceted URL change trigger on first page access if no facet is visible. [voineali #3970]
3.6 - (2010-11-30)
Bug fix: Set cache headers for @@faceted_counter, @@tagscloud_counter [voineali #3935]
3.5 - (2010-11-23)
Bug fix: Faceted tal expression widget ignores values with value False. [voineali #3890]
3.4 - (2010-09-30)
Bug fix: Fixed search by words containing “(”, “-” etc [ghicaale #3639c
Bug fix: Fixed random failure of daterange doctests [voineali #3664]
3.3 (2010-09-06)
Bug fix: Fixed expandable and collapsible widgets when used in combination with hide zero count items [voineali #3457]
Bug fix: Fixed faceted counter for custom portal types defined by portal_faceted tool [voineali #3139]
3.2 (2010-08-16)
Bug fix: Fixed alphabetic widget crash when REQUEST.LANGUAGE like ‘it-it’. [voineali #3499]
Change: Better small loader animation for facets, as the previous was not visible enough [demarant]
Feature: Added TAL Expression Widget to allow one to define dynamic queries (e.g. limit faceted query to context path) [voineali #3538]
Change: Cleanup faceted js/css computing mechanism and use portal_javascripts/portal_css instead as eea.jquery provides profiles for each jQuery plugin [voineali #3553, #3487]
3.1.1 (2010-07-07)
Bug fix: Fixed failing tests [voineali]
3.1 (2010-07-01)
Bug fix: Fixed facets not appearing in google chrome [voineali #3371]
Feature: Use jquery.bbq plugin for browsing history [voineali #3371]
3.0 (2010-06-16)
Change: faceted_view.css has no condition anymore in portal_css profile. Removed duplicate from faceted_edit.css [voineali #3409]
Feature: Made Large Folder faceted navigable [voineali #3059]
Feature: Added special faceted widget ETag in order to easily generate another faceted version id which is used by squid or other proxy caching systems. See docs/versions.txt [voineali #3338]
Change: Cleanup old css/js profile by removing duplicated items (@@ ones) [voineali]
Feature: Make faceted navigation aware of collection’s query. [#3275] [Thanks to Izhar Firdaus]
Bug fix: Moved faceted actions from portal_fiveactions to portal_actions as as it caused conflicts with p4a.plonecalendar and p4a.video. [#3275] [Thanks to Izhar Firdaus]
Change: Refactored field.Vocabulary to be reused also with other fields than StringField [voineali]
Upgrade step: Within portal_setup import all steps using ‘EEA Faceted Navigation’ profile or reinstall it from portal_quickinstaller.
2.0 (2010-05-07)
Change: Update API to easily access default criteria [voineali #2939]
Feature: Adjust faceted navigation JavaScript to work outside faceted navigable contexts using a previously defined faceted navigable configuration. This way, by providing faceted navigable URL it can be used in pop-ups, dialogs, etc [voineali #3198]
Bug fix: Fixed that z3 vocabularies are not updated at runtime [voineali #3239]
1.9 (2010-03-26)
Bug fix: Fixed faceted text widget error [voineali #3162]
1.8 (2010-03-18)
Bug fix: Fixed that after last update faceted widgets not responding. [voineali #3157]
Feature: Added debug widget [voineali #3141]
1.7 (2010-03-16)
Change: Replaced after_query method with IWidgetFilterBrains adapter. [voineali #3141]
Feature: Support non-ascii keywords vocabulary [voineali #3100]
1.6 (2010-02-15)
Feature: Enable and/or search operator on faceted checkbox widget. [voineali #2940]
Feature: Added an error layer in order to easily see widgets with configuration problems and fix them without disabling JavaScript in browser and then trying to figure out which one is causing the problem and remove it.
Bug fix: Fixed relative path problems for path widget when using in production [voineali #2625]
Change: Make date range widget more user friendly using jquery ui datepicker [voineali #2871]
Change: Make date widget more user friendly using jQuery slider plugin. [voineali #2871]
Bug fix: Fixed that if jquery is present in portal_javascirpts do not reload it in faceted_view.js / faceted_edit.js [voineali]
1.5 (2010-01-18)
Feature: Add path (location) widget [voineali #2625]
Bug fix: Fixed translate UnicodeDecodeError [voineali #2907]
1.4 (2009-11-27)
Feature: Memcache tagscloud_counter results. Also use eea.cache in order to dynamically set and invalidate memcache dependencies. [voineali #2801]
Feature: Implemented a version control system for faceted configuration in order to invalidate proxy cache systems like squid by requesting a new URL. [voineali #2783]
Bug fix: Fixed IE submit form when return is pressed in search field. [voineali #2825]
Feature: Keep minimum of distinct URLs for same queries in order to cache efficiently [voineali #2596]
1.3 (2009-11-18)
Bug fix: Fixed document actions position too high. [thuliper #2792]
Bug fix: Scroll window to top when Less button is clicked. [voineali #2799]
1.2 (2009-11-09)
Change: Remove LinguaPlone and ATVocabularyManager dependencies. [voineali]
Change: Make eea.faceted.tool optional. [voineali]
Bug fix: Fixed export/import criteria ids. [voineali]
1.1 (2009-10-30)
Duplicate release 1.0r1
1.0r1 (2009-10-30)
Bug fix: This package should not be zip_safe. [voineali]
1.0 (2009-10-30)
Initial release
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
