doc/book/en/devweb/facets.rst
author Aurelien Campeas <aurelien.campeas@logilab.fr>
Fri, 13 Jun 2014 15:56:08 +0200
changeset 10356 a009a31fb1ea
parent 6120 c000e41316ec
permissions -rw-r--r--
[connection] eliminate ClientConnection leftovers * in the documentation * in the docstrings * in code notations (e.g. clt_cnx -> cnx) Related to #3837233. From now, there should be just one ClientConnection left in repoapi.py.

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