doc/tutorials/base/index.rst
author Laurent Peuch <cortex@worlddomination.be>
Mon, 22 Jul 2019 11:21:10 +0200
changeset 12696 eb83daa69495
parent 10491 c67bcee93248
permissions -rw-r--r--
[cubicweb-ctl] respect sys.exit status code when aborting a command When exploring the stack of all calls to a cubicweb-ctl command, it has been discovered than on a KeyboardInterrupt and on a SystemExit exception the base class InstanceCommand (for commands that works on one instance) will always set the return code of cubicweb-ctl to 8: this mean that if another command do a `sys.exit(some_code)` the exit code will be ignored and overwritten by '8'. This behavior is not intuitive, apparently not documented and doesn't seems to have any justification. It also prevent commands from exciting with different return codes which could be a desired behavior in the situation of scripting.

.. -*- coding: utf-8 -*-

.. _TutosBase:

Building a simple blog with |cubicweb|
======================================

|cubicweb| is a semantic web application framework that favors reuse and
object-oriented design.


This tutorial is designed to help in your very first steps to start with
|cubicweb|. We will tour through basic concepts such as:

* getting an application running by using existing components
* discovering the default user interface
* basic extending and customizing the look and feel of that application

More advanced concepts are covered in :ref:`TutosPhotoWebSite`.


.. _TutosBaseVocab:

Some vocabulary
---------------

|cubicweb| comes with a few words of vocabulary that you should know to
understand what we're talking about. To follow this tutorial, you should at least
know that:

* a `cube` is a component that usually includes a model defining some data types
  and a set of views to display them. A cube can be built by assembling other
  cubes;

* an `instance` is a specific installation of one or more cubes and includes
  configuration files, a web server and a database.

Reading :ref:`Concepts` for more vocabulary will be required at some point.

Now, let's start the hot stuff!

.. toctree::
   :maxdepth: 2

   blog-in-five-minutes
   discovering-the-ui
   customizing-the-application
   conclusion