.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: Tutorials


    tutorials/index

.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: ⚙ Setup and Usage

    book/admin/index
    book/devweb/index
    book/pyramid/index
    book/additionnal_services/index

.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: ➕ More

    book/annexes/index

    changes/index

    api/index


************************************************
|cubicweb_web| - And how to use it with CubicWeb
************************************************


|cubicweb_web| is a cube which used to be part of CubicWeb.
It provides a lot of generic HTML views and a controller mechanism.


First steps
===========

* **From scratch:**

  - :ref:`SetUpEnv`

  - :ref:`ConfigEnv`

  - :ref:`DeployEnv`


Routing
=======

|cubicweb| offers two different ways of routing : one internal to CubicWeb and a one with the `pyramid framework <https://trypyramid.com/>`_.

* **Principle:**

  - :doc:`cubicweb and pyramid <>`

  - :doc:`the CW request object <>`

  - :doc:`the pyramid request object <book/pyramid/index>`

  - :doc:`encapsulation of the CW request in the pyramid request <>`

  - :doc:`bw_compat and the options to use, fallback when CW doesn't find anything <>`

* **CubicWeb routing:**

  - :doc:`url publishers <book/devweb/publisher>`

  - :doc:`url rewriters <book/devweb/views/urlpublish>`

* **Pyramid routing:**

  - :doc:`general principles <>`

  - :doc:`predicates <>`

  - :doc:`tweens <>`

  - :doc:`content negociation <>`


Front development
=================

* **With Javascript / Typescript (using React):**

  - :doc:`general principle <>`

  - :doc:`how to install and integrate js tooling into CW <>`

  - :doc:`cwelements <>`

  - :doc:`rql browser <>`

* **With Pyramid:**

  - :doc:`general integration with CubicWeb <>`

  - `The renderers <https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/renderers.html>`_

  - `Jinja2 templates <https://jinja.palletsprojects.com/>`_

  - :doc:`example of usages with CW <>`

* **With CubicWeb Views:**

  - :ref:`Introduction <ViewSystem>`

  - :ref:`Select a view with registers <object_selection>`

  - :doc:`Facets <>`

  - :doc:`How to use javascript inside CW views <>`

  - :doc:`Customize CSS <>`

* **RDF:**

  - :doc:`the RDF adaptator <>`

  - :doc:`RDFLib integration into CW <>`


Security
========

* **Security:**

  - :ref:`securitymodel`

  - :doc:`Permissions management with Pyramid <>`

  - :ref:`csrf_protection`


Cubicweb configuration files
============================

* **Base configuration:**

  - :ref:`The all-in-one.conf <WebServerConfig>`

  - :ref:`The Pyramid configuration <cubicweb_settings>`

* **Advanced configuration:**

  - :ref:`The database connection pooler <connection_poller>`



Common Web application tools
=============================

* **Test**

  - :ref:`CubicWeb <Tests>`

* **Caching**

  - :ref:`HttpCaching`

* **Internationalization**

  - :ref:`Localize your application <internationalization>`

* **Full text indexation**

  - :ref:`searchbar`

.. _forge: https://forge.extranet.logilab.fr/cubicweb/cubes/web