doc/book/devweb/views/baseviews.rst
author Christophe de Vienne <christophe@unlish.com>
Thu, 08 Jan 2015 22:11:06 +0100
changeset 10491 c67bcee93248
parent 8057 doc/book/en/devweb/views/baseviews.rst@0f128fd3cbc8
permissions -rw-r--r--
[doc] Restructure the documentation * Create a new index file * Move the sphinx configuration files do the documentation root * Move book/README to dev/documenting.rst * Move book/mode_plan.py to tools/ * Move book/en/images to images * Move book/en/* to book/ * Move changelogs to changes/* * Adapt the Makefile * Add a title to the javascript api index Related to #4832808
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5312
d2dbba898a96 [doc/book] misc on views, docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5266
diff changeset
     1
Base views
d2dbba898a96 [doc/book] misc on views, docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5266
diff changeset
     2
----------
1714
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     3
7836
0ada13ce2e16 [doc] get back baseviews documentation into the code, enhance it and reorganize the module accordingly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6303
diff changeset
     4
|cubicweb| provides a lot of standard views, that can be found in
6303
1aad5389c013 [book] backport documentation about primary/base views sent on the list
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
     5
:mod:`cubicweb.web.views` sub-modules.
1714
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     6
6303
1aad5389c013 [book] backport documentation about primary/base views sent on the list
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
     7
A certain number of views are used to build the web interface, which apply to one
7836
0ada13ce2e16 [doc] get back baseviews documentation into the code, enhance it and reorganize the module accordingly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6303
diff changeset
     8
or more entities. As other appobjects, their identifier is what distinguish them
6303
1aad5389c013 [book] backport documentation about primary/base views sent on the list
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
     9
from each others. The most generic ones, found in
1aad5389c013 [book] backport documentation about primary/base views sent on the list
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
    10
:mod:`cubicweb.web.views.baseviews`, are described below.
1714
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    11
7836
0ada13ce2e16 [doc] get back baseviews documentation into the code, enhance it and reorganize the module accordingly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6303
diff changeset
    12
You'll probably want to customize one or more of the described views which are
0ada13ce2e16 [doc] get back baseviews documentation into the code, enhance it and reorganize the module accordingly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6303
diff changeset
    13
default, generic, implementations.
2474
23e8aa37b2df fix/enhance baseview doc
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2175
diff changeset
    14
6303
1aad5389c013 [book] backport documentation about primary/base views sent on the list
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5394
diff changeset
    15
7836
0ada13ce2e16 [doc] get back baseviews documentation into the code, enhance it and reorganize the module accordingly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6303
diff changeset
    16
.. automodule:: cubicweb.web.views.baseviews
2474
23e8aa37b2df fix/enhance baseview doc
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2175
diff changeset
    17
8057
0f128fd3cbc8 [navigation] extract method from SortedNavigation.call to ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7836
diff changeset
    18
You will also find modules providing some specific services:
0f128fd3cbc8 [navigation] extract method from SortedNavigation.call to ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7836
diff changeset
    19
0f128fd3cbc8 [navigation] extract method from SortedNavigation.call to ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7836
diff changeset
    20
.. automodule:: cubicweb.web.views.navigation
0f128fd3cbc8 [navigation] extract method from SortedNavigation.call to ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7836
diff changeset
    21