Commit c6e14ffa authored by Nicolas Chauvat's avatar Nicolas Chauvat
Browse files

[doc] some more rewriting

parent 6f8ffaa2a700
......@@ -6,9 +6,8 @@ Creation of your first instance
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 @@ This is it! All is settled down to start developping your data model...
upgrade
~~~~~~~
The command is::
cubicweb-ctl upgrade myinstance
XXX write me
......@@ -10,7 +10,7 @@ While creating an instance, a configuration file is generated in::
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
......
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
......@@ -77,18 +77,21 @@ if you do not intend to develop the framework itself.
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 @@ Databases configuration
.. _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
......
......@@ -9,6 +9,8 @@ life easier.
* 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: ::
......
......@@ -44,5 +44,8 @@ to have installed in order for CubicWeb to work:
* 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.
......@@ -51,7 +51,7 @@ copyright = '2008-2009, Logilab'
# 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:
......
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 @@ Entity types used to manage workflows
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
......
......@@ -2,8 +2,8 @@
.. _Workflow:
An Example: Workflow definition
===============================
Define a Workflow
=================
General
-------
......
......@@ -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
......@@ -5,21 +5,22 @@ Sessions
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]
......
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
......
......@@ -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`_.
......
......@@ -2,7 +2,7 @@ Data as objects
===============
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 @@ the data stored in the database.
data-as-objects
load-sort
interfaces
more
\ No newline at end of file
more
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:
......@@ -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.
......
......@@ -22,9 +22,7 @@ The structure of each line is::
<RQL QUERY> <QUERY ARGS IF ANY> -- <TIME SPENT>
CubicWeb also provides the **exlog** command to examine and summarize data found
in such a file:
::
in such a file::
$ cubicweb-ctl exlog < ~/myapp-rql.log
0.07 50 Any A WHERE X eid %(x)s, X firstname A {}
0.05 50 Any A WHERE X eid %(x)s, X lastname A {}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment