doc/book/en/devweb/facets.rst
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Sun, 17 Oct 2010 21:10:44 +0200
changeset 6528 6c6859a67673
parent 6120 c000e41316ec
permissions -rw-r--r--
[doc] generate doc in cw/doc/html and include html files in cubicweb-documentation

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