doc/book/en/devweb/facets.rst
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Tue, 14 Sep 2010 15:40:31 +0200
branchstable
changeset 6240 fd0cbb801007
parent 6120 c000e41316ec
permissions -rw-r--r--
cleanups

The facets system
-----------------

Facets allow to restrict searches according to some user friendly criterias.
CubicWeb has a builtin `facet`_ system to define restrictions `filters`_ really
as easily as possible.

Here is an exemple of the facets rendering picked from our
http://www.cubicweb.org web site:

.. image:: ../images/facet_overview.png

Facets will appear on each page presenting more than one entity that may be
filtered according to some known criteria.

Base classes for facets
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cubicweb.web.facet


.. _facet: http://en.wikipedia.org/wiki/Faceted_browser
.. _filters: http://www.cubicweb.org/blogentry/154152