doc/index.rst
author Laurent Peuch <cortex@worlddomination.be>
Wed, 12 Jun 2019 19:58:00 +0200
changeset 12741 90348f847b4b
parent 12380 5efff873705e
child 12792 e2cdb1be6bd9
permissions -rw-r--r--
[pyramid/debug] on every request display request path and selected controller This will display lines like: 2019-06-12 16:26:57 - (cubicweb.pyramid.bwcompat) INFO: REQUEST [view] '/wiki/334037' selected controller <cubicweb.web.views.basecontrollers.ViewController object at 0x7f133802ae90> at /root/.virtualenvs/abreton/local/lib/python2.7/site-packages/cubicweb/web/views/basecontrollers.py:120 2019-06-12 16:26:59 - (cubicweb.pyramid.bwcompat) INFO: REQUEST [data] '/data/ea5eb3b6f89fba0ff4b671093c88d3dd/images/cartouche-mur.jpg' selected controller <cubicweb.web.views.staticcontrollers.DataController object at 0x7f1332a84d50> at /root/.virtualenvs/abreton/local/lib/python2.7/site-packages/cubicweb/web/views/staticcontrollers.py:179 The make debugging easier as this isn't done already. Most other web frameworks do something similar for the developper to be able to understand what is happening right now. Closes #17219741

=====================================================
|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
  <TutosBaseCustomizingTheApplicationDataModel>` of the application,

* a query language named :ref:`RQL <RQL>` similar to W3C's SPARQL,

* a :ref:`selection+view <TutosBaseCustomizingTheApplicationCustomViews>`
  mechanism for semi-automatic XHTML/XML/JSON/text generation,

* a library of reusable :ref:`components <Cube>` (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: 2

   tutorials/index
   
.. toctree::
   :maxdepth: 3

   book/devrepo/index
   book/devweb/index
   book/pyramid/index

.. toctree::
   :maxdepth: 2

   book/admin/index
   book/additionnal_services/index
   book/annexes/index



Changes
~~~~~~~

.. toctree::
   :maxdepth: 2

   changes/changelog


Reference documentation
~~~~~~~~~~~~~~~~~~~~~~~

API
'''

.. toctree::
    :maxdepth: 1
    :glob:

    api/*

.. toctree::
    :maxdepth: 1

    book/en/devweb/js_api/index

Developpers
~~~~~~~~~~~

.. toctree::
    :maxdepth: 1
    :glob:

    How to contribute to the code base <https://hg.logilab.org/master/cubicweb/file/tip/README#l39>
    General contribution guide for cubes <https://www.logilab.org/Card/contributing>
    dev/*

Indexes
~~~~~~~

* the :ref:`genindex`,
* the :ref:`modindex`,