doc/book/devweb/facets.rst
author David Douard <david.douard@logilab.fr>
Tue, 03 Mar 2015 12:26:47 +0100
changeset 11152 fccc6ddd975c
parent 10495 5bd914ebf3ae
permissions -rw-r--r--
[skeleton] do not import the __pkginfo__.py module to make cubes installable via setuptools When using a simple "import" statement, running 'python setup.py install' for a cube fails in a fresh virtualenv due to the fact the install of the dependencies (here cubicweb iteself) is done by the python process doing the cube's installation, so the __pkginfo__ module from the cube is already loaded (thus used) when installing cubicweb... So we apply the third technique from: https://packaging.python.org/en/latest/single_source_version.html
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1714
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     1
The facets system
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     2
-----------------
5286
43d7044f8d0b [doc/book] complete the facet section
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 4751
diff changeset
     3
6120
c000e41316ec [book] some more documentation and cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
     4
Facets allow to restrict searches according to some user friendly criterias.
c000e41316ec [book] some more documentation and cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
     5
CubicWeb has a builtin `facet`_ system to define restrictions `filters`_ really
c000e41316ec [book] some more documentation and cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
     6
as easily as possible.
5286
43d7044f8d0b [doc/book] complete the facet section
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 4751
diff changeset
     7
6120
c000e41316ec [book] some more documentation and cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
     8
Here is an exemple of the facets rendering picked from our
c000e41316ec [book] some more documentation and cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
     9
http://www.cubicweb.org web site:
5286
43d7044f8d0b [doc/book] complete the facet section
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 4751
diff changeset
    10
10495
5bd914ebf3ae [doc] fix warnings/errors in doc build
Julien Cristau <julien.cristau@logilab.fr>
parents: 10491
diff changeset
    11
.. image:: ../../images/facet_overview.png
5286
43d7044f8d0b [doc/book] complete the facet section
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 4751
diff changeset
    12
6120
c000e41316ec [book] some more documentation and cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
    13
Facets will appear on each page presenting more than one entity that may be
c000e41316ec [book] some more documentation and cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
    14
filtered according to some known criteria.
3991
a0aa9789c6bc Pasting blog about facet in the facet section of the doc book.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 1714
diff changeset
    15
6120
c000e41316ec [book] some more documentation and cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
    16
Base classes for facets
c000e41316ec [book] some more documentation and cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
    17
~~~~~~~~~~~~~~~~~~~~~~~
c000e41316ec [book] some more documentation and cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
    18
.. automodule:: cubicweb.web.facet
3991
a0aa9789c6bc Pasting blog about facet in the facet section of the doc book.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 1714
diff changeset
    19
a0aa9789c6bc Pasting blog about facet in the facet section of the doc book.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 1714
diff changeset
    20
a0aa9789c6bc Pasting blog about facet in the facet section of the doc book.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 1714
diff changeset
    21
.. _facet: http://en.wikipedia.org/wiki/Faceted_browser
a0aa9789c6bc Pasting blog about facet in the facet section of the doc book.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 1714
diff changeset
    22
.. _filters: http://www.cubicweb.org/blogentry/154152
a0aa9789c6bc Pasting blog about facet in the facet section of the doc book.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 1714
diff changeset
    23