# HG changeset patch # User Nicolas Chauvat # Date 1248809206 -7200 # Node ID 0f26a76b0348a7fc6baf28b43cf6c3c7c65f19a6 # Parent 6f8ffaa2a7006883014046f56796ddfaaac6827f [doc] some more rewriting diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/admin/create-instance.rst --- a/doc/book/en/admin/create-instance.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/admin/create-instance.rst Tue Jul 28 21:26:46 2009 +0200 @@ -6,9 +6,8 @@ Instance creation ----------------- -Now that we created our cube, we can create an instance to view our -instance in a web browser. To do so we will use a `all-in-one` -configuration to simplify things :: +Now that we created a cube, we can create an instance and access it via a web +browser. We will use a `all-in-one` configuration to simplify things :: cubicweb-ctl create -c all-in-one mycube myinstance @@ -60,5 +59,9 @@ upgrade ~~~~~~~ +The command is:: + + cubicweb-ctl upgrade myinstance + XXX write me diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/admin/instance-config.rst --- a/doc/book/en/admin/instance-config.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/admin/instance-config.rst Tue Jul 28 21:26:46 2009 +0200 @@ -10,7 +10,7 @@ For example:: - /etc/cubicweb.d/JPL/all-in-one.conf + /etc/cubicweb.d/myblog/all-in-one.conf It is a simple text file format INI. In the following description, each option name is prefixed with its own section and followed by its diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/admin/multisources.rst --- a/doc/book/en/admin/multisources.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/admin/multisources.rst Tue Jul 28 21:26:46 2009 +0200 @@ -1,4 +1,6 @@ -Integrating some data from another instance -=========================================== +Multiple sources of data +======================== -XXX feed me \ No newline at end of file +Data sources include SQL, LDAP, RQL, mercurial and subversion. + +XXX feed me diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/admin/setup.rst --- a/doc/book/en/admin/setup.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/admin/setup.rst Tue Jul 28 21:26:46 2009 +0200 @@ -77,18 +77,21 @@ In both cases, make sure you have installed the dependencies (see appendixes for the list). -Postgres installation -````````````````````` +PostgreSQL installation +``````````````````````` -Please refer to the `Postgresql project online documentation`_. +Please refer to the `PostgreSQL project online documentation`_. -.. _`Postgresql project online documentation`: http://www.postgresql.org/ +.. _`PostgreSQL project online documentation`: http://www.postgresql.org/ -You need to install the three following packages: `postgres-8.3`, -`postgres-contrib-8.3` and `postgresql-plpython-8.3`. +You need to install the three following packages: `postgresql-8.3`, +`postgresql-contrib-8.3` and `postgresql-plpython-8.3`. -Then you can install: +Other dependencies +`````````````````` + +You can also install: * `pyro` if you wish the repository to be accessible through Pyro or if the client and the server are not running on the same machine @@ -134,22 +137,22 @@ -.. _ConfigurationPostgres: +.. _ConfigurationPostgresql: -Postgres configuration -`````````````````````` +PostgreSQL configuration +```````````````````````` .. note:: - If you already have an existing cluster and postgres server + If you already have an existing cluster and PostgreSQL server running, you do not need to execute the initilization step - of your Postgres database. + of your PostgreSQL database. -* First, initialize the database Postgres with the command ``initdb``. +* First, initialize the database PostgreSQL with the command ``initdb``. :: $ initdb -D /path/to/pgsql - Once initialized, start the database server Postgres + Once initialized, start the database server PostgreSQL with the command:: $ postgres -D /path/to/psql diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/annexes/cookbook.rst --- a/doc/book/en/annexes/cookbook.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/annexes/cookbook.rst Tue Jul 28 21:26:46 2009 +0200 @@ -9,6 +9,8 @@ * How to import LDAP users in *CubicWeb*? + [XXX distribute this script with cubicweb instead] + Here is a very useful script which enables you to import LDAP users into your *CubicWeb* instance by running the following: :: diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/annexes/depends.rst --- a/doc/book/en/annexes/depends.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/annexes/depends.rst Tue Jul 28 21:26:46 2009 +0200 @@ -44,5 +44,8 @@ * indexer - http://www.logilab.org/project/indexer - http://pypi.python.org/pypi/indexer - included in the forest +* fyzz - http://www.logilab.org/project/fyzz - http://pypi.python.org/pypi/fyzz + - included in the forest + Any help with the packaging of CubicWeb for more than Debian/Ubuntu (including eggs, buildouts, etc) will be greatly appreciated. diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/conf.py --- a/doc/book/en/conf.py Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/conf.py Tue Jul 28 21:26:46 2009 +0200 @@ -51,7 +51,7 @@ # The short X.Y version. version = '0.54' # The full version, including alpha/beta/rc tags. -release = '3.2' +release = '3.4' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/development/datamodel/baseschema.rst --- a/doc/book/en/development/datamodel/baseschema.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/development/datamodel/baseschema.rst Tue Jul 28 21:26:46 2009 +0200 @@ -1,5 +1,5 @@ -Pre-defined schemas in the library +Pre-defined entities in the library ---------------------------------- The library defines a set of entity schemas that are required by the system @@ -28,7 +28,7 @@ Other entity types ~~~~~~~~~~~~~~~~~~ -* `CWCache` +* `CWCache`, cache entities used to improve performances * `CWProperty`, used to configure the instance * `EmailAddress`, email address, used by the system to send notifications diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/development/datamodel/define-workflows.rst --- a/doc/book/en/development/datamodel/define-workflows.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/development/datamodel/define-workflows.rst Tue Jul 28 21:26:46 2009 +0200 @@ -2,8 +2,8 @@ .. _Workflow: -An Example: Workflow definition -=============================== +Define a Workflow +================= General ------- diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/development/datamodel/inheritance.rst --- a/doc/book/en/development/datamodel/inheritance.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/development/datamodel/inheritance.rst Tue Jul 28 21:26:46 2009 +0200 @@ -2,4 +2,7 @@ Inheritance ----------- +When describing a data model, entities can inherit from other entities as is +common in object-oriented programming. + XXX WRITME diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/development/devrepo/sessions.rst --- a/doc/book/en/development/devrepo/sessions.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/development/devrepo/sessions.rst Tue Jul 28 21:26:46 2009 +0200 @@ -5,21 +5,22 @@ There are three kinds of sessions. -* user sessions are the most common: they are related to users and +* `user sessions` are the most common: they are related to users and carry security checks coming with user credentials -* super sessions are children of ordinary user sessions and allow to +* `super sessions` are children of ordinary user sessions and allow to bypass security checks (they are created by calling unsafe_execute on a user session); this is often convenient in hooks which may touch data that is not directly updatable by users -* internal sessions have all the powers; they are also used in only a +* `internal sessions` have all the powers; they are also used in only a few situations where you don't already have an adequate session at hand, like: user authentication, data synchronisation in multi-source contexts -Do not confuse the session type with their connection mode, for -instance : 'in memory' or 'pyro'. +.. note:: + Do not confuse the session type with their connection mode, for + instance : 'in memory' or 'pyro'. [WRITE ME] diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/development/devweb/index.rst --- a/doc/book/en/development/devweb/index.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/development/devweb/index.rst Tue Jul 28 21:26:46 2009 +0200 @@ -1,7 +1,7 @@ Web development =============== -In this chapter, we will core api for web development in the CubicWeb framework. +In this chapter, we will describe the core api for web development in the *CubicWeb* framework. .. toctree:: :maxdepth: 1 diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/development/devweb/internationalization.rst --- a/doc/book/en/development/devweb/internationalization.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/development/devweb/internationalization.rst Tue Jul 28 21:26:46 2009 +0200 @@ -6,7 +6,7 @@ Internationalisation --------------------- -Cubicweb fully supports the internalization of it's content and interface. +Cubicweb fully supports the internalization of its content and interface. Cubicweb's interface internationalization is based on the translation project `GNU gettext`_. diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/development/entityclasses/index.rst --- a/doc/book/en/development/entityclasses/index.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/development/entityclasses/index.rst Tue Jul 28 21:26:46 2009 +0200 @@ -2,7 +2,7 @@ =============== In this chapter, we will introduce the objects that are used to handle -the data stored in the database. +the logic associated to the data stored in the database. .. toctree:: :maxdepth: 1 @@ -10,4 +10,4 @@ data-as-objects load-sort interfaces - more \ No newline at end of file + more diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/development/entityclasses/interfaces.rst --- a/doc/book/en/development/entityclasses/interfaces.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/development/entityclasses/interfaces.rst Tue Jul 28 21:26:46 2009 +0200 @@ -1,16 +1,19 @@ Interfaces ---------- +Same thing as object-oriented programming interfaces. + XXX how to define a cw interface Declaration of interfaces implemented by a class ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + XXX __implements__ Interfaces defined in the library ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. automodule:: cubicweb.interface - :members: -````````````` +automodule:: cubicweb.interface :members: + + diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/development/entityclasses/load-sort.rst --- a/doc/book/en/development/entityclasses/load-sort.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/development/entityclasses/load-sort.rst Tue Jul 28 21:26:46 2009 +0200 @@ -2,14 +2,14 @@ Loaded attributes and default sorting management ```````````````````````````````````````````````` -* The class attribute `fetch_attrs` allows to defined in an entity class - a list of names of attributes or relations that should be automatically - loaded when we recover the entities of this type. In the case of relations, +* The class attribute `fetch_attrs` allows to define in an entity class a list + of names of attributes or relations that should be automatically loaded when + entities of this type are fetched from the database. In the case of relations, we are limited to *subject of cardinality `?` or `1`* relations. * The class method `fetch_order(attr, var)` expects an attribute (or relation) name as a parameter and a variable name, and it should return a string - to use in the requirement `ORDER BY` of an RQL query to automatically + to use in the requirement `ORDERBY` of an RQL query to automatically sort the list of entities of such type according to this attribute, or `None` if we do not want to sort on the attribute given in the parameter. By default, the entities are sorted according to their creation date. diff -r 6f8ffaa2a700 -r 0f26a76b0348 doc/book/en/development/profiling/index.rst --- a/doc/book/en/development/profiling/index.rst Tue Jul 28 21:14:47 2009 +0200 +++ b/doc/book/en/development/profiling/index.rst Tue Jul 28 21:26:46 2009 +0200 @@ -22,9 +22,7 @@ --