diff -r 76ab3c71aff2 -r c67bcee93248 doc/book/devweb/facets.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/book/devweb/facets.rst Thu Jan 08 22:11:06 2015 +0100 @@ -0,0 +1,23 @@ +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 +