author | Denis Laxalde <denis.laxalde@logilab.fr> |
Tue, 25 Jun 2019 16:21:41 +0200 | |
branch | 3.26 |
changeset 12669 | f035fa5a6e67 |
parent 12445 | 21651da94d2d |
child 12792 | e2cdb1be6bd9 |
permissions | -rw-r--r-- |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
1 |
===================================================== |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
2 |
|cubicweb| - The Semantic Web is a construction game! |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
3 |
===================================================== |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
4 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
5 |
|cubicweb| is a semantic web application framework, licensed under the LGPL, |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
6 |
that empowers developers to efficiently build web applications by reusing |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
7 |
components (called `cubes`) and following the well known object-oriented design |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
8 |
principles. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
9 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
10 |
Main Features |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
11 |
~~~~~~~~~~~~~ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
12 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
13 |
* an engine driven by the explicit :ref:`data model |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
14 |
<TutosBaseCustomizingTheApplicationDataModel>` of the application, |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
15 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
16 |
* a query language named :ref:`RQL <RQL>` similar to W3C's SPARQL, |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
17 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
18 |
* a :ref:`selection+view <TutosBaseCustomizingTheApplicationCustomViews>` |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
19 |
mechanism for semi-automatic XHTML/XML/JSON/text generation, |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
20 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
21 |
* a library of reusable :ref:`components <Cube>` (data model and views) that |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
22 |
fulfill common needs, |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
23 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
24 |
* the power and flexibility of the Python_ programming language, |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
25 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
26 |
* the reliability of SQL databases, LDAP directories, Subversion and Mercurial |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
27 |
for storage backends. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
28 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
29 |
Built since 2000 from an R&D effort still continued, supporting 100,000s of |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
30 |
daily visits at some production sites, |cubicweb| is a proven end to end solution |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
31 |
for semantic web application development that promotes quality, reusability and |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
32 |
efficiency. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
33 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
34 |
QuickStart |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
35 |
~~~~~~~~~~ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
36 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
37 |
The impatient developer will move right away to :ref:`SetUpEnv` then to :ref:`ConfigEnv`. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
38 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
39 |
Social |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
40 |
~~~~~~ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
41 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
42 |
* Chat on the `jabber forum`_ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
43 |
* Discuss on the `mailing-list`_ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
44 |
* Discover on the `blog`_ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
45 |
* Contribute on the forge_ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
46 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
47 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
48 |
.. _Logilab: http://www.logilab.fr/ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
49 |
.. _forge: http://www.cubicweb.org/project/ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
50 |
.. _Python: http://www.python.org/ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
51 |
.. _`jabber forum`: http://www.logilab.org/blogentry/6718 |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
52 |
.. _`mailing-list`: http://lists.cubicweb.org/mailman/listinfo/cubicweb |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
53 |
.. _blog: http://www.cubicweb.org/blog/1238 |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
54 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
55 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
56 |
Narrative Documentation |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
57 |
~~~~~~~~~~~~~~~~~~~~~~~ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
58 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
59 |
A.k.a. "The Book" |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
60 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
61 |
.. toctree:: |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
62 |
:maxdepth: 2 |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
63 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
64 |
book/intro/index |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
65 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
66 |
.. toctree:: |
10500
d1164ba9ac23
[doc] put the tutorials between the intro and the `Repository development` toc of the book
David Douard <david.douard@logilab.fr>
parents:
10496
diff
changeset
|
67 |
:maxdepth: 2 |
d1164ba9ac23
[doc] put the tutorials between the intro and the `Repository development` toc of the book
David Douard <david.douard@logilab.fr>
parents:
10496
diff
changeset
|
68 |
|
d1164ba9ac23
[doc] put the tutorials between the intro and the `Repository development` toc of the book
David Douard <david.douard@logilab.fr>
parents:
10496
diff
changeset
|
69 |
tutorials/index |
d1164ba9ac23
[doc] put the tutorials between the intro and the `Repository development` toc of the book
David Douard <david.douard@logilab.fr>
parents:
10496
diff
changeset
|
70 |
|
d1164ba9ac23
[doc] put the tutorials between the intro and the `Repository development` toc of the book
David Douard <david.douard@logilab.fr>
parents:
10496
diff
changeset
|
71 |
.. toctree:: |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
72 |
:maxdepth: 3 |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
73 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
74 |
book/devrepo/index |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
75 |
book/devweb/index |
11631
faf279e33298
Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents:
10503
diff
changeset
|
76 |
book/pyramid/index |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
77 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
78 |
.. toctree:: |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
79 |
:maxdepth: 2 |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
80 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
81 |
book/admin/index |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
82 |
book/additionnal_services/index |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
83 |
book/annexes/index |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
84 |
|
10496
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
85 |
|
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
86 |
|
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
87 |
Changes |
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
88 |
~~~~~~~ |
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
89 |
|
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
90 |
.. toctree:: |
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
91 |
:maxdepth: 2 |
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
92 |
|
10503
209738650200
[doc] make the changelog chapter a one html page
David Douard <david.douard@logilab.fr>
parents:
10500
diff
changeset
|
93 |
changes/changelog |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
94 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
95 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
96 |
Reference documentation |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
97 |
~~~~~~~~~~~~~~~~~~~~~~~ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
98 |
|
10494
b6f00889355c
[doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents:
10492
diff
changeset
|
99 |
API |
b6f00889355c
[doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents:
10492
diff
changeset
|
100 |
''' |
b6f00889355c
[doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents:
10492
diff
changeset
|
101 |
|
b6f00889355c
[doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents:
10492
diff
changeset
|
102 |
.. toctree:: |
b6f00889355c
[doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents:
10492
diff
changeset
|
103 |
:maxdepth: 1 |
b6f00889355c
[doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents:
10492
diff
changeset
|
104 |
:glob: |
b6f00889355c
[doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents:
10492
diff
changeset
|
105 |
|
b6f00889355c
[doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents:
10492
diff
changeset
|
106 |
api/* |
b6f00889355c
[doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents:
10492
diff
changeset
|
107 |
|
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
108 |
.. toctree:: |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
109 |
:maxdepth: 1 |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
110 |
|
11930
83a921bae21c
[pkg] Fix some error on building documentation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
11631
diff
changeset
|
111 |
book/en/devweb/js_api/index |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
112 |
|
10492
68c13e0c0fc5
[doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents:
10491
diff
changeset
|
113 |
Developpers |
68c13e0c0fc5
[doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents:
10491
diff
changeset
|
114 |
~~~~~~~~~~~ |
68c13e0c0fc5
[doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents:
10491
diff
changeset
|
115 |
|
68c13e0c0fc5
[doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents:
10491
diff
changeset
|
116 |
.. toctree:: |
68c13e0c0fc5
[doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents:
10491
diff
changeset
|
117 |
:maxdepth: 1 |
68c13e0c0fc5
[doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents:
10491
diff
changeset
|
118 |
:glob: |
68c13e0c0fc5
[doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents:
10491
diff
changeset
|
119 |
|
12374
bb18c84aed54
[doc] link to README regarding how to contribute to the code base
Laurent Peuch <cortex@worlddomination.be>
parents:
11930
diff
changeset
|
120 |
How to contribute to the code base <https://hg.logilab.org/master/cubicweb/file/tip/README#l39> |
12445
21651da94d2d
[doc] add link to cubes contribution document
Laurent Peuch <cortex@worlddomination.be>
parents:
12374
diff
changeset
|
121 |
General contribution guide for cubes <https://www.logilab.org/Card/contributing> |
10492
68c13e0c0fc5
[doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents:
10491
diff
changeset
|
122 |
dev/* |
68c13e0c0fc5
[doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents:
10491
diff
changeset
|
123 |
|
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
124 |
Indexes |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
125 |
~~~~~~~ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
126 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
127 |
* the :ref:`genindex`, |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
128 |
* the :ref:`modindex`, |