# HG changeset patch # User Sandrine Ribeau # Date 1226432108 28800 # Node ID dfddcbef6684b30cc8e789758b72212eee4500b4 # Parent eddd1ad3d08e2c26819cf2fe0d3496fe9fa17f17 Add links between sections. Re-order installation guide. Adds some details in cubicweb-ctl tool. diff -r eddd1ad3d08e -r dfddcbef6684 doc/cubicweb-uml.txt --- a/doc/cubicweb-uml.txt Mon Nov 10 13:20:02 2008 -0800 +++ b/doc/cubicweb-uml.txt Tue Nov 11 11:35:08 2008 -0800 @@ -2,7 +2,7 @@ Diagramme UML -============= +------------- .. image:: cubicweb.png diff -r eddd1ad3d08e -r dfddcbef6684 doc/devmanual_fr/chap_fondements_cubicweb.txt --- a/doc/devmanual_fr/chap_fondements_cubicweb.txt Mon Nov 10 13:20:02 2008 -0800 +++ b/doc/devmanual_fr/chap_fondements_cubicweb.txt Tue Nov 11 11:35:08 2008 -0800 @@ -25,7 +25,7 @@ le système de fichiers et est stocké dans la base de données lors de la création d'une instance. `CubicWeb` fournit un certain nombres de types d'entités inclus systématiquement car nécessaire au noyau - `CubicWeb` et une librairie de composants devant être inclus + `CubicWeb` et une librairie de cubes devant être inclus explicitement le cas échéant. *type d'entité* @@ -66,22 +66,26 @@ - ``all-in-one`` : interface web et entrepôt dans un seul processus. L'entrepôt peut ou non être accessible via Pyro -*composant* - un composant est un modèle regroupant un ou plusieurs types de données et/ou +*cube* + un cube est un modèle regroupant un ou plusieurs types de données et/ou des vues afin de fournir une fonctionalité précise, ou une application `CubicWeb` - complète utilisant éventuellement d'autres composants. Les différents - composants disponibles sur une machine sont installés dans - `/usr/share/cubicweb/cubes` + complète utilisant éventuellement d'autres cube. Les différents + cubes disponibles sur une machine sont installés dans + `/path/to/forest/cubicweb/cubes` *instance* - une instance est une installation spécifique d'un template. Par exemple - intranet/jpl et logilab.org sont deux instances du composant jpl. Les - instances sont définies dans le répertoire `/etc/cubicweb.d`. + une instance est une installation spécifique d'un template. Sont regroupes + dans une instance tous les fichiers de configurations necessaires au bon + fonctionnement de votre application web. Elle referrera au(x) cube(s) sur + le(s)quel(s) votre application se base. + Par exemple intranet/jpl et logilab.org sont deux instances du cube jpl que + nous avons developpes en interne. + Les instances sont définies dans le répertoire `~/etc/cubicweb.d`. *application* le mot application est utilisé parfois pour parler d'une instance et parfois d'un composant, en fonction du contexte... Mieux vaut donc éviter de - l'utiliser et utiliser plutôt *composant* et *instance*. + l'utiliser et utiliser plutôt *cube* et *instance*. *result set* objet encaspulant les résultats d'une requête RQL et des informations sur @@ -96,14 +100,14 @@ .. _`yams`: http://www.logilab.org/project/name/yams/ -Structure standard d'un composant ---------------------------------- +Structure standard d'un cube +---------------------------- -Un composant complexe est structuré selon le modèle suivant : +Un cube complexe est structuré selon le modèle suivant : :: - moncomposant/ + moncube/ | |-- schema.py | @@ -132,7 +136,7 @@ :: - moncomposant/ + moncube/ | |-- entities.py |-- hooks.py @@ -160,8 +164,8 @@ installé) * le fichier ``__pkginfo__.py`` donne un certain nombre de méta-données sur le composant, notamment le nom de la distribution et la version courante (coté - serveur et interface web) ou encore les sous-composants utilisés par ce - composant. + serveur et interface web) ou encore les sous-cubes utilisés par ce + cube. Le strict minimum étant : diff -r eddd1ad3d08e -r dfddcbef6684 doc/devmanual_fr/chap_i18n.txt --- a/doc/devmanual_fr/chap_i18n.txt Mon Nov 10 13:20:02 2008 -0800 +++ b/doc/devmanual_fr/chap_i18n.txt Tue Nov 11 11:35:08 2008 -0800 @@ -1,3 +1,8 @@ +.. -*- coding: utf-8 -*- + +.. _Internationalisation: + + Internationalisation ==================== diff -r eddd1ad3d08e -r dfddcbef6684 doc/devmanual_fr/index.txt --- a/doc/devmanual_fr/index.txt Mon Nov 10 13:20:02 2008 -0800 +++ b/doc/devmanual_fr/index.txt Tue Nov 11 11:35:08 2008 -0800 @@ -12,8 +12,10 @@ .. toctree:: :maxdepth: 1 - + chap_fondements_cubicweb.txt + chap_creation_instance.txt + chap_configuration_instance.txt chap_mise_en_place_environnement.txt chap_rql.txt chap_definition_schema.txt @@ -31,7 +33,5 @@ chap_i18n.txt chap_migration.txt - chap_creation_instance.txt - chap_configuration_instance.txt XXX: XXX FILLME, CSS, API sécurité diff -r eddd1ad3d08e -r dfddcbef6684 doc/devmanual_fr/sect_cubicweb-ctl.txt --- a/doc/devmanual_fr/sect_cubicweb-ctl.txt Mon Nov 10 13:20:02 2008 -0800 +++ b/doc/devmanual_fr/sect_cubicweb-ctl.txt Tue Nov 11 11:35:08 2008 -0800 @@ -1,5 +1,7 @@ .. -*- coding: utf-8 -*- +.. _cubicweb-ctl: + L'outil `cubicweb-ctl` ---------------------- `cubicweb-ctl` est le couteau suisse pour la gestion d'instances CubicWeb. @@ -19,10 +21,10 @@ cubicweb-ctl --help -Commandes pour la création d'un composant -````````````````````````````````````````` -* ``newtemplate``, crée un nouveau composant sur le système de fichiers - à partir du nom passé en paramètre. Cette commande crée le composant à partir +Commandes pour la création d'un cube +```````````````````````````````````` +* ``newcube``, crée un nouveau cube sur le système de fichiers + à partir du nom passé en paramètre. Cette commande crée le cube à partir d'une squelette d'application, incluant également les fichiers pour le packaging debian) @@ -74,10 +76,46 @@ * ``i18ncompile``, recompile les catalogues de messages d'une instance. Cela est effectué automatiquement lors d'une upgrade -Cf Internationalisation_. +Cf :ref:`Internationalisation`. Autres commandes ```````````````` * ``list``, donne la liste des configurations, des composants et des instances disponibles * ``delete``, supprime une instance (fichiers de configuration et base de données) + + + +Exemples +```````` + +Creation d'une instance a partir de cube existant +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Afin de creer une instance a partir d'un cube existant, executez la commande +suivant :: + + cubicweb-ctl create + +Cette commande va creer les fichiers de configuration d'une instance dans +``~/etc/cubicweb.d/``. +L'outil ``cubicweb-ctl`` va vous autoriser a executer au sein de ``create`` +les commandes ``db-create`` et ``db-init`` afin de completer la creation de +votre instance en une seule commande. + +Si vous decidez de ne pas le faire lorsque ``cubicweb-ctl create`` vous le +propose, alors n'oubliez pas de lancer ces commandes (``cubicweb-ctl db-create``, +``cubicweb-ctl db-init`` ) par la suite, sinon +votre installation ne sera pas complete. + + +Creation d'une instance a partir d'une nouveau cube +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Creez avant tout votre nouveau cube :: + + cubicweb-ctl newcube + +Cette commande va creer un nouveau cube dans ``/path/to/forest/cubicweb/cubes/``. + + diff -r eddd1ad3d08e -r dfddcbef6684 doc/devmanual_fr/sect_installation.txt --- a/doc/devmanual_fr/sect_installation.txt Mon Nov 10 13:20:02 2008 -0800 +++ b/doc/devmanual_fr/sect_installation.txt Tue Nov 11 11:35:08 2008 -0800 @@ -6,6 +6,10 @@ Installation de Cubicweb et de ses dépendances ---------------------------------------------- +[TODO] +Decrire l'installation de la foret mercurial plutot qu'avec +les paquets debian + Tout le système Cubicweb est préparé pour l'installation sur une machine debian. L'installation manuelle est un peu pénible du fait des nombreuses dépendances à installer (twisted, postgres, autres paquets python...). Nous @@ -36,6 +40,10 @@ Configuration de l'environnement -------------------------------- +[FIXME] +Ces variables ne sont plus requises pour le bon fonctionnement de cubicweb, non? +A part rajouter la foret dans le PYTHONPATH, rien de plus ne doit etre fait? + Ajouter les lignes suivantes à son `.bashrc` ou `.bash_profile` pour configurer votre environnement de développement :: @@ -80,3 +88,5 @@ * éditer le fichier */etc/default/pyro-nsd* pour que le serveur de nom pyro soit lancé automatiquement au démarrage de la machine + + diff -r eddd1ad3d08e -r dfddcbef6684 doc/querier.txt --- a/doc/querier.txt Mon Nov 10 13:20:02 2008 -0800 +++ b/doc/querier.txt Tue Nov 11 11:35:08 2008 -0800 @@ -1,8 +1,7 @@ .. -*- coding: utf-8 -*- Déroulement de l'éxecution d'une requête en multi-source avec insertion de sécurité -=================================================================================== - +``````````````````````````````````````````````````````````````````````````````````` * 3 sources (system, ldap (Euser) et rql (Card) * permission en lecture Card is elle appartient à l'utilisateur @@ -58,5 +57,6 @@ 6. renvoie ResultSet Notes sur UNION -=============== +``````````````` + * en multi-sources, les résultats des unions peuvent être mélangés