cubicweb: comparison doc/book/en/A02a-create-cube.en.txt

equal deleted inserted replaced

-:843e0b1bf991
+:0575e7973c5e
 .. -*- coding: utf-8 -*-
 Create your cube
 ----------------
-After you installed your `CubicWeb` development environment, you can start
+Once your `CubicWeb` development environment is set up, you can create a new
-to build your first cube: ::
+cube::
 cubicweb-ctl newcube blog
-This will create in ``/path/to/forest/cubes`` a directory containing: ::
+This will create in ``/path/to/forest/cubes`` a directory named ``blog`` containing::
 blog/
 |
 |-- data/
 |   |-- cubes.blog.css
 |   |-- cubes.blog.js
-|   |-- external_resources
+|   `-- external_resources
 |
 |-- debian/
 |   |-- changelog
 |   |-- compat
 |   |-- control
 |   |-- copyright
 |   |-- cubicweb-blog.prerm
-|   |-- rules
+|   `-- rules
 |
 |-- entities.py
 |
 |-- i18n/
 |   |-- en.po
-|   |-- fr.po
+|   `-- fr.po
 |
 |-- __init__.py
 |
 |-- MANIFEST.in
 |
 |-- migration/
 |   |-- postcreate.py
-|   |-- precreate.py
+|   `-- precreate.py
 |
 |-- __pkginfo__.py
 |
 |-- schema.py
 |
 |
 |-- sobjects.py
 |
 |-- test/
 |   |-- data/
-|       |-- bootstrap_cubes
+|   |   `-- bootstrap_cubes
 |   |-- pytestconf.py
 |   |-- realdb_test_blog.py
-|   |-- test_blog.py
+|   `-- test_blog.py
 |
-|-- views.py
+`-- views.py
-Any changes applied to your data model should be done in this
-directory.
 .. _DefineDataModel:
-Define your data schema
+Define your data model
------------------------
+----------------------
-The data model or schema is hte core of your `CubicWeb` application.
+The data model or schema is the core of your `CubicWeb` application.
-This is where is defined the type of content you application will handle.
+It defines the type of content your application will handle.
-The data model is defined in the file ``schema.py`` of your cube
+The data model of your cube ``blog`` is defined in the file ``schema.py``:
-``blog`` such as follows.
 ::
 from cubicweb.schema import format_constraint
 class Blog(EntityType):
 title = String(maxsize=50, required=True)
 description = String()
 class BlogEntry(EntityType):
 Create your instance
 --------------------
-::
+To use this cube as an application and create a new instance named ``blogdemo``, do::
 cubicweb-ctl create blog blogdemo
 This command will create a directory ``~/etc/cubicweb.d/blogdemo``
 which will contain all the configuration files required to start
 you web application.
-The instance ``blogdemo`` is based on the cube ``blog``.
+Welcome to your web application
-Welcome in your web application
 -------------------------------
-Run your application with the following command: ::
+Start your application in debug mode with the following command: ::
 cubicweb-ctl start -D blogdemo
-You can now access to your web application to create blogs and post messages
+You can now access your web application to create blogs and post messages
-by visitin the URL http://localhost:8080/.
+by visiting the URL http://localhost:8080/.
-A login form will first be prompted. By default, the application will not allow
-anonymous user to get in the application. You should then use the admin
+A login form will appear. By default, the application will not allow anonymous
-account you created at the time you initialized the database with
+users to enter the application. To login, you need then use the admin account
-``cubicweb-ctl create``.
+you created at the time you initialized the database with ``cubicweb-ctl
+create``.
 .. image:: images/login-form.png
 Once authenticated, you can start playing with your application
-and create entities. Bravo!
+and create entities.
 .. image:: images/blog-demo-first-page.png
-Please notice that so far, `CubicWeb` franework managed all aspects of
+Please notice that so far, the `CubicWeb` franework managed all aspects of
-the web application based in the schema provided at first.
+the web application based on the schema provided at first.
-Create entities
+Add entities
----------------
+------------
-We will now create a couple of entities in our web application.
+We will now add entities in our web application.
-Create a Blog
+Add a Blog
-~~~~~~~~~~~~~
+~~~~~~~~~~
-Let us create a few of these entities. Click on the `[+]` at the right
+Let us create a few of these entities. Click on the `[+]` at the left of the
-of the link Blog.  Call this new Blog ``Tech-blog`` and type in
+link Blog on the home page. Call this new Blog ``Tech-blog`` and type in
-``everything about technology`` as the description, then validate the
+``everything about technology`` as the description, then validate the form by
-form by clicking on ``Validate``.
+clicking on ``Validate``.
 .. image:: images/cbw-create-blog.en.png
 :alt: from to create blog
 Click on the logo at top left to get back to the home page, then
 has two items.
 .. image:: images/cbw-list-two-blog.en.png
 :alt: displaying a list of two blogs
-Create a BlogEntry
+Add a BlogEntry
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~
-Get back to the home page and click on [+] at the right of the link
+Get back to the home page and click on [+] at the left of the link
 BlogEntry. Call this new entry ``Hello World`` and type in some text
 before clicking on ``Validate``. You added a new blog entry without
 saying to what blog it belongs. There is a box on the left entitled
 ``actions``, click on the menu item ``modify``. You are back to the form
 to edit the blog entry you just created, except that the form now has
 `EntityView`, for a complete list, you
 will have to read the code in directory ``cubicweb/web/views/``
 A view is applied on a `result set` which contains a set of
 entities we are trying to display. `CubicWeb` uses a selector
-mecanism which computes a score used to identify which view
+mechanism which computes a score used to identify which view
 is the best to apply for the `result set` we are trying to
 display. The standard library of selectors is in
 ``cubicweb.common.selector`` and a library of methods used to
 compute scores is available in ``cubicweb.vregistry.vreq``.

changeset 268	0575e7973c5e
parent 255	5d2804b9a28c
child 272	06077d56f2c4