doc/book/en/index.rst
author Aurelien Campeas <aurelien.campeas@logilab.fr>
Fri, 13 Jun 2014 15:56:08 +0200
changeset 10356 a009a31fb1ea
parent 8698 b2443e266661
permissions -rw-r--r--
[connection] eliminate ClientConnection leftovers * in the documentation * in the docstrings * in code notations (e.g. clt_cnx -> cnx) Related to #3837233. From now, there should be just one ClientConnection left in repoapi.py.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
94
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     1
.. -*- coding: utf-8 -*-
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     2
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     3
.. _contents:
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     4
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     5
=====================================================
4437
21f2e01fdd6a update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2175
diff changeset
     6
|cubicweb| - The Semantic Web is a construction game!
94
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     7
=====================================================
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     8
4437
21f2e01fdd6a update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2175
diff changeset
     9
|cubicweb| is a semantic web application framework, licensed under the LGPL,
255
5d2804b9a28c [doc] add internal links from book abstract
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    10
that empowers developers to efficiently build web applications by reusing
5d2804b9a28c [doc] add internal links from book abstract
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    11
components (called `cubes`) and following the well known object-oriented design
5d2804b9a28c [doc] add internal links from book abstract
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    12
principles.
97
d507caa1b386 [doc] rewrite first paragraphs on home page
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 95
diff changeset
    13
255
5d2804b9a28c [doc] add internal links from book abstract
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    14
Its main features are:
94
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    15
6880
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    16
* an engine driven by the explicit :ref:`data model
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    17
  <TutosBaseCustomizingTheApplicationDataModel>` of the application,
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    18
2175
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2174
diff changeset
    19
* a query language named :ref:`RQL <RQL>` similar to W3C's SPARQL,
6880
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    20
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    21
* a :ref:`selection+view <TutosBaseCustomizingTheApplicationCustomViews>`
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    22
  mechanism for semi-automatic XHTML/XML/JSON/text generation,
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    23
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    24
* a library of reusable :ref:`components <Cube>` (data model and views) that
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    25
  fulfill common needs,
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    26
255
5d2804b9a28c [doc] add internal links from book abstract
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    27
* the power and flexibility of the Python_ programming language,
6880
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    28
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    29
* the reliability of SQL databases, LDAP directories, Subversion and Mercurial
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    30
  for storage backends.
94
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    31
255
5d2804b9a28c [doc] add internal links from book abstract
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    32
Built since 2000 from an R&D effort still continued, supporting 100,000s of
4437
21f2e01fdd6a update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2175
diff changeset
    33
daily visits at some production sites, |cubicweb| is a proven end to end solution
255
5d2804b9a28c [doc] add internal links from book abstract
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    34
for semantic web application development that promotes quality, reusability and
97
d507caa1b386 [doc] rewrite first paragraphs on home page
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 95
diff changeset
    35
efficiency.
94
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    36
6880
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6120
diff changeset
    37
The unbeliever will read the :ref:`Tutorials`.
94
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    38
255
5d2804b9a28c [doc] add internal links from book abstract
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    39
The hacker will join development at the forge_.
5d2804b9a28c [doc] add internal links from book abstract
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    40
7226
e88c57c10b34 [doc] major update of the install documentation
Alain Leufroy <alain.leufroy@logilab.fr>
parents: 6880
diff changeset
    41
The impatient developer will move right away to :ref:`SetUpEnv` then to :ref:`ConfigEnv`.
94
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    42
2175
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2174
diff changeset
    43
The chatter lover will join the `jabber forum`_, the `mailing-list`_ and the blog_.
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2174
diff changeset
    44
94
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    45
.. _Logilab: http://www.logilab.fr/
255
5d2804b9a28c [doc] add internal links from book abstract
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    46
.. _forge: http://www.cubicweb.org/project/
5d2804b9a28c [doc] add internal links from book abstract
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    47
.. _Python: http://www.python.org/
2175
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2174
diff changeset
    48
.. _`jabber forum`: http://www.logilab.org/blogentry/6718
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2174
diff changeset
    49
.. _`mailing-list`: http://lists.cubicweb.org/mailman/listinfo/cubicweb
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2174
diff changeset
    50
.. _blog: http://www.cubicweb.org/blog/1238
94
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    51
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    52
.. toctree::
5256
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5231
diff changeset
    53
   :maxdepth: 2
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5231
diff changeset
    54
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5231
diff changeset
    55
   intro/index
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5231
diff changeset
    56
   tutorials/index
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5231
diff changeset
    57
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5231
diff changeset
    58
.. toctree::
5231
40f53867e332 [doc/book] misc fixes/enhancements & notes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4437
diff changeset
    59
   :maxdepth: 3
94
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    60
5394
105011657405 [doc/book] move devweb up from development, turn development into devrepo (much better structure)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5393
diff changeset
    61
   devrepo/index
105011657405 [doc/book] move devweb up from development, turn development into devrepo (much better structure)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5393
diff changeset
    62
   devweb/index
5256
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5231
diff changeset
    63
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5231
diff changeset
    64
.. toctree::
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5231
diff changeset
    65
   :maxdepth: 2
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5231
diff changeset
    66
1714
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents: 1440
diff changeset
    67
   admin/index
8698
b2443e266661 [doc] Book entry for the undo functionnality.
Anthony Truchet <anthony.truchet@logilab.fr>
parents: 7226
diff changeset
    68
   additionnal_services/index
1714
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents: 1440
diff changeset
    69
   annexes/index
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents: 1440
diff changeset
    70
2175
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2174
diff changeset
    71
See also:
94
7044297a70ab [doc] missing files
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    72
2175
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2174
diff changeset
    73
* the :ref:`genindex`,
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2174
diff changeset
    74
* the :ref:`modindex`,