[doc] some ReST syntax fixes stable
authorSylvain Thénault <sylvain.thenault@logilab.fr>
Mon, 17 Jan 2011 12:41:45 +0100
branchstable
changeset 6833 8fe4b003c1bc
parent 6832 f392e4fb36ec
child 6834 b4befa12bbcc
[doc] some ReST syntax fixes
doc/book/en/tutorials/advanced/index.rst
doc/book/en/tutorials/base/blog-in-five-minutes.rst
doc/book/en/tutorials/base/create-cube.rst
--- a/doc/book/en/tutorials/advanced/index.rst	Mon Jan 17 12:41:40 2011 +0100
+++ b/doc/book/en/tutorials/advanced/index.rst	Mon Jan 17 12:41:45 2011 +0100
@@ -66,7 +66,7 @@
   entities supporting the `tags` relation by linking the to `Tag` entities. This
   will allows navigation into a large number of picture.
 
-Ok, now I'll tell my cube requires all this by editing cubes/sytweb/__pkginfo__.py:
+Ok, now I'll tell my cube requires all this by editing :file:`cubes/sytweb/__pkginfo__.py`:
 
   .. sourcecode:: python
 
@@ -180,9 +180,11 @@
 Here is the ``read`` security model I want:
 
 * folders, files, images and comments should have one of the following visibility:
+
   - ``public``, everyone can see it
   - ``authenticated``, only authenticated users can see it
   - ``restricted``, only a subset of authenticated users can see it
+
 * managers (e.g. me) can see everything
 * only authenticated users can see people
 * everyone can see classifier entities, such as tag and zone
--- a/doc/book/en/tutorials/base/blog-in-five-minutes.rst	Mon Jan 17 12:41:40 2011 +0100
+++ b/doc/book/en/tutorials/base/blog-in-five-minutes.rst	Mon Jan 17 12:41:45 2011 +0100
@@ -5,11 +5,13 @@
 Get a blog running in five minutes!
 -----------------------------------
 
-For Debian or Ubuntu users, first install the following packages (:ref:`DebianInstallation`)::
+For Debian or Ubuntu users, first install the following packages
+(:ref:`DebianInstallation`)::
 
     cubicweb, cubicweb-dev, cubicweb-blog
 
-For Windows or Mac OS X users, you must install cubicweb from source (see :ref:`SourceInstallation` and  :ref:`WindowsInstallation`).
+For Windows or Mac OS X users, you must install |cubicweb| from source (see
+:ref:`SourceInstallation` and :ref:`WindowsInstallation`).
 
 Then create and initialize your instance::
 
@@ -19,7 +21,8 @@
 
     cubicweb-ctl start -D myblog
 
-The -D option is the debugging mode of cubicweb, removing it will lauch the instance in the background.
+The -D option is the debugging mode of |cubicweb|, removing it will lauch the
+instance in the background.
 
 Permission
 ~~~~~~~~~~
@@ -29,14 +32,19 @@
 Instance parameters
 ~~~~~~~~~~~~~~~~~~~
 
-If you would like to change some instance parameters, for example, the database host or the user name, edit the `source` file located in the /etc/cubicweb.d/myblog directory.
+If you would like to change some instance parameters, for example, the main
+database host or the user name, edit the `sources` file located in the
+:file:`/etc/cubicweb.d/myblog` directory.
 
 Then relaunch the database creation::
 
      cubicweb-ctl db-create myblog
 
-Other paramaters, like web server or emails parameters, can be modified in the `all-in-one.conf` file.
+Other paramaters, like web server or emails parameters, can be modified in the
+:file:`/etc/cubicweb.d/myblog/all-in-one.conf` file.
 
-This is it. Your blog is running. Visit http://localhost:8080 and enjoy it! This blog is fully functionnal. The next section section will present the way to develop new cubes and customizing the look of your instance.
+This is it. Your blog is running. Visit http://localhost:8080 and enjoy it! This
+blog is fully functionnal. The next section section will present the way to
+develop new cubes and customizing the look of your instance.
 
 
--- a/doc/book/en/tutorials/base/create-cube.rst	Mon Jan 17 12:41:40 2011 +0100
+++ b/doc/book/en/tutorials/base/create-cube.rst	Mon Jan 17 12:41:45 2011 +0100
@@ -9,33 +9,38 @@
 
 1. :ref:`CreateYourCube`
 
-Create the directory to hold the code of your cube. The most important
-files that will be useful to customize your newly created cube are:
+   Create the directory to hold the code of your cube. The most important files
+   that will be useful to customize your newly created cube are:
 
-  * schema.py: contains the data model
-  * views.py: contains your custom views
-  * entities.py: contains XXX
+     * schema.py: contains the data model
+     * views.py: contains your custom views
+     * entities.py: contains logic on top of the data model
 
-The detailed structure of the code directory is described in :ref:`cubelayout`.
+   The detailed structure of the cube directory is described in
+   :ref:`cubelayout`.
 
 2. :ref:`DefineDataModel`
 
-Define the data model of your application.
+   Define the data model of your application.
 
 3. :ref:`ExploreYourInstance`
 
-Create, run, and explore an instance of your cube.
+   Create, run, and explore an instance of your cube.
 
 4. :ref:`DefineViews`
 
-Customize the views of your data: how and which part of your data are showed.
+   Customize the views of your data: how and which part of your data are showed.
 
-.. note:: views do not define the look'n'feel and the design of your application. For that, you will use CSS and the files located 'blog/data/'.
+   .. note::
+
+     views usually do not define the look'n'feel and the design of your
+     application. For that, you will use CSS and the files located 'blog/data/'.
 
 
 5. :ref:`DefineEntities`
 
-Define your own entities to add useful functions when you manipulate your data, especially when you write view.
+   Define your own entities to add useful functions when you manipulate your
+   data, especially when you write view.
 
 
 .. _CreateYourCube:
@@ -44,27 +49,27 @@
 ----------------
 
 The packages ``cubicweb`` and ``cubicweb-dev`` install a command line
-tool for *CubicWeb* called ``cubicweb-ctl``. This tool provides a wide
+tool for |cubicweb| called ``cubicweb-ctl``. This tool provides a wide
 range of commands described in details in :ref:`cubicweb-ctl`.
 
-Once your *CubicWeb* development environment is set up, you can create
+Once your |cubicweb| development environment is set up, you can create
 a new cube::
 
   cubicweb-ctl newcube blog
 
-This will create in the cubes directory (``/path/to/forest/cubes`` for Mercurial
-installation, ``/usr/share/cubicweb/cubes`` for debian packages installation)
+This will create in the cubes directory (:file:`/path/to/forest/cubes` for Mercurial
+installation, :file:`/usr/share/cubicweb/cubes` for debian packages installation)
 a directory named ``blog`` reflecting the structure described in :ref:`Concepts`.
 
 
-For packages installation, you can still create new cubes in your home directory using the following configuration. Let's say you want to develop your new cubes in `~src/cubes`, then set the following environment variables:
-::
+For packages installation, you can still create new cubes in your home directory
+using the following configuration. Let's say you want to develop your new cubes
+in `~src/cubes`, then set the following environment variables: ::
 
   CW_CUBES_PATH=~/src/cubes
   CW_MODE=user
 
-and then create your new cube using:
-::
+and then create your new cube using: ::
 
   cubicweb-ctl newcube --directory=~/src/cubes blog
 
@@ -74,14 +79,14 @@
 Define your data model
 ----------------------
 
-The data model or schema is the core of your *CubicWeb* application.
+The data model or schema is the core of your |cubicweb| application.
 It defines the type of content your application will handle.
 
 The data model of your cube ``blog`` is defined in the file ``schema.py``:
 
 .. sourcecode:: python
 
-  from yams.buildobjs import EntityType, String, SubjectRelation, Date
+  from yams.buildobjs import EntityType, SubjectRelation, String, Date
 
   class Blog(EntityType):
     title = String(maxsize=50, required=True)
@@ -93,8 +98,8 @@
     content = String(required=True, fulltextindexed=True)
     entry_of = SubjectRelation('Blog', cardinality='?*')
 
-The first step is the import of the EntityType (generic class for entity and
-attributes that will be used in both Blog and BlogEntry entities.
+The first step is the import of the :class:`EntityType` (generic class for entity
+and attributes that will be used in both Blog and BlogEntry entities.
 
 A Blog has a title and a description. The title is a string that is
 required and must be less than 50 characters.  The
@@ -156,7 +161,7 @@
 
 .. image:: ../../images/blog-demo-first-page.png
 
-Please notice that so far, the *CubicWeb* framework managed all aspects of
+Please notice that so far, the |cubicweb| framework managed all aspects of
 the web application based on the schema provided at the beginning.
 
 .. _AddEntities:
@@ -249,7 +254,7 @@
 
 A view is defined by a Python class which includes:
 
-  - an identifier (all objects in *CubicWeb* are recorded in a
+  - an identifier (all objects in |cubicweb| are recorded in a
     registry and this identifier will be used as a key)
 
   - a filter to select the result sets it can be applied to
@@ -257,11 +262,11 @@
 A view has a set of methods complying with the `View` class interface
 (`cubicweb.common.view`).
 
-*CubicWeb* provides a lot of standard views for the type `EntityView`;
+|cubicweb| provides a lot of standard views for the type `EntityView`;
 for a complete list, 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 mechanism which
+we are trying to display. |cubicweb| uses a selector mechanism which
 computes for each available view a score: the view with the highest
 score is then used to display the given `result set`.  The standard
 library of selectors is in ``cubicweb.selector``.