doc/book/en/D050-modules-cbw-api.en.txt
author Nicolas Chauvat <nicolas.chauvat@logilab.fr>
Sat, 22 Nov 2008 23:59:42 +0100
changeset 127 ae611743f5c6
parent 104 doc/book/en/21-04-modules-cbw-api.en.txt@8a62d2db3392
child 299 4761e0ca406d
permissions -rw-r--r--
[doc] divided book in parts
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
104
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
     1
.. -*- coding: utf-8 -*-
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
     2
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
     3
============
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
     4
CubicWeb API
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
     5
============
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
     6
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
     7
:mod:`cubicweb` 
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
     8
===============
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
     9
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    10
.. automodule:: cubicweb
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    11
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    12
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    13
:mod:`cubicweb.common`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    14
======================
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    15
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    16
.. automodule:: cubicweb.common
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    17
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    18
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    19
:mod:`cubicweb.devtools`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    20
========================
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    21
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    22
.. automodule:: cubicweb.devtools
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    23
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    24
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    25
:mod:`cubicweb.entities`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    26
========================
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    27
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    28
.. automodule:: cubicweb.entities
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    29
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    30
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    31
:mod:`cubicweb.etwist`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    32
======================
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    33
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    34
.. automodule:: cubicweb.etwist
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    35
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    36
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    37
:mod:`cubicweb.goa`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    38
===================
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    39
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    40
.. automodule:: cubicweb.goa
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    41
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    42
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    43
:mod:`cubicweb.schemas`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    44
=======================
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    45
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    46
.. automodule:: cubicweb.schemas
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    47
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    48
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    49
:mod:`cubicweb.server`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    50
======================
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    51
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    52
.. automodule:: cubicweb.server
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    53
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    54
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    55
:mod:`cubicweb.sobjects`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    56
========================
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    57
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    58
.. automodule:: cubicweb.sobjects
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    59
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    60
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    61
:mod:`cubicweb.web`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    62
===================
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    63
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    64
.. automodule:: cubicweb.web
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    65
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    66
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    67
:mod:`cubicweb.web.views`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    68
=========================
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    69
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    70
.. automodule:: cubicweb.web.views
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    71
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    72
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    73
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    74
:mod:`cubicweb.wsgi`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    75
====================
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    76
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    77
.. automodule:: cubicweb.wsgi
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    78
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    79
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    80
:mod:`indexer`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    81
==============
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    82
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    83
.. automodule:: indexer
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    84
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    85
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    86
:mod:`logilab`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    87
==============
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    88
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    89
.. automodule:: logilab
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    90
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    91
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    92
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    93
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    94
:mod:`rql`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    95
==========
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    96
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    97
.. automodule:: rql
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    98
   :members:
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
    99
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
   100
:mod:`yams`
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
   101
===========
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
   102
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
   103
.. automodule:: yams
8a62d2db3392 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff changeset
   104
   :members: