diff -r 76ab3c71aff2 -r c67bcee93248 doc/index.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/index.rst Thu Jan 08 22:11:06 2015 +0100 @@ -0,0 +1,111 @@ +===================================================== +|cubicweb| - The Semantic Web is a construction game! +===================================================== + +|cubicweb| is a semantic web application framework, licensed under the LGPL, +that empowers developers to efficiently build web applications by reusing +components (called `cubes`) and following the well known object-oriented design +principles. + +Main Features +~~~~~~~~~~~~~ + +* an engine driven by the explicit :ref:`data model + ` of the application, + +* a query language named :ref:`RQL ` similar to W3C's SPARQL, + +* a :ref:`selection+view ` + mechanism for semi-automatic XHTML/XML/JSON/text generation, + +* a library of reusable :ref:`components ` (data model and views) that + fulfill common needs, + +* the power and flexibility of the Python_ programming language, + +* the reliability of SQL databases, LDAP directories, Subversion and Mercurial + for storage backends. + +Built since 2000 from an R&D effort still continued, supporting 100,000s of +daily visits at some production sites, |cubicweb| is a proven end to end solution +for semantic web application development that promotes quality, reusability and +efficiency. + +QuickStart +~~~~~~~~~~ + +The impatient developer will move right away to :ref:`SetUpEnv` then to :ref:`ConfigEnv`. + +Social +~~~~~~ + +* Chat on the `jabber forum`_ +* Discuss on the `mailing-list`_ +* Discover on the `blog`_ +* Contribute on the forge_ + + +.. _Logilab: http://www.logilab.fr/ +.. _forge: http://www.cubicweb.org/project/ +.. _Python: http://www.python.org/ +.. _`jabber forum`: http://www.logilab.org/blogentry/6718 +.. _`mailing-list`: http://lists.cubicweb.org/mailman/listinfo/cubicweb +.. _blog: http://www.cubicweb.org/blog/1238 + + +Narrative Documentation +~~~~~~~~~~~~~~~~~~~~~~~ + +A.k.a. "The Book" + +.. toctree:: + :maxdepth: 2 + + book/intro/index + +.. toctree:: + :maxdepth: 3 + + book/devrepo/index + book/devweb/index + +.. toctree:: + :maxdepth: 2 + + book/admin/index + book/additionnal_services/index + book/annexes/index + +Tutorial +~~~~~~~~ + +We present two tutorials of different levels. The blog building +tutorial introduces one smoothly to the basic concepts. + +Then there is a photo gallery construction tutorial which highlights +more advanced concepts such as unit tests, security settings, +migration scripts. + +.. toctree:: + :maxdepth: 1 + :numbered: + + tutorials/base/index + tutorials/advanced/index + tutorials/tools/windmill.rst + tutorials/textreports/index + + +Reference documentation +~~~~~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + + js_api/index + +Indexes +~~~~~~~ + +* the :ref:`genindex`, +* the :ref:`modindex`,