various doc fixes
authorNicolas Chauvat <nicolas.chauvat@logilab.fr>
Wed, 12 Nov 2008 21:12:49 +0100
changeset 36 f6bcad5c6dfe
parent 35 ef2bb51fbe5f
child 37 dcc7c04469f1
various doc fixes
doc/.static/cubicweb.png
doc/devmanual_fr/chap_fondements_cubicweb.txt
doc/devmanual_fr/sect_installation.txt
doc/plan_formation_python_cubicweb.txt
doc/securite.txt
Binary file doc/.static/cubicweb.png has changed
--- a/doc/devmanual_fr/chap_fondements_cubicweb.txt	Wed Nov 12 21:12:30 2008 +0100
+++ b/doc/devmanual_fr/chap_fondements_cubicweb.txt	Wed Nov 12 21:12:49 2008 +0100
@@ -33,8 +33,8 @@
   base de toute entité, qui est sa clef, est l'eid
 
 *type de relation*
-  les entités sont liées entre elles par des relations. Dans cubicweb les
-  relations sont binaires : par convention on nomme le premier terme
+  les entités sont liées entre elles par des relations. Dans `CubicWeb` 
+  les relations sont binaires : par convention on nomme le premier terme
   d'une relation son 'sujet' et le second son 'objet'.
 
 *type d'entité final*
@@ -102,8 +102,9 @@
 
 Moteur `CubicWeb`
 -----------------
-Le moteur web de cubicweb consiste en quelques classes gérant un ensemble d'objets
-chargés dynamiquement au lancement de cubicweb. Ce sont ces objets dynamiques, issus
+
+Le moteur web de `CubicWeb` consiste en quelques classes gérant un ensemble d'objets
+chargés dynamiquement au lancement de `CubicWeb`. Ce sont ces objets dynamiques, issus
 du modèle ou de la librairie, qui construisent le site web final. Les différents
 composants dynamiques sont par exemple : 
 
@@ -168,7 +169,7 @@
 
 C'est l'objet Connection qui possède les méthodes classiques `commit` et
 `rollback`. Vous ne *devriez jamais avoir à les utiliser* lors du développement
-d'interface web sur la base du framework CubicWeb étant donné que la fin de la
+d'interface web sur la base du framework `CubicWeb` étant donné que la fin de la
 transaction est déterminée par celui-ci en fonction du succès d'éxécution de la
 requête. 
 
--- a/doc/devmanual_fr/sect_installation.txt	Wed Nov 12 21:12:30 2008 +0100
+++ b/doc/devmanual_fr/sect_installation.txt	Wed Nov 12 21:12:49 2008 +0100
@@ -10,7 +10,7 @@
 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
+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
 supposerons donc ici que l'installation se fait sur une machine debian ayant
@@ -41,7 +41,7 @@
 Configuration de l'environnement
 --------------------------------
 [FIXME]
-Ces variables ne sont plus requises pour le bon fonctionnement de cubicweb, non?
+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
--- a/doc/plan_formation_python_cubicweb.txt	Wed Nov 12 21:12:30 2008 +0100
+++ b/doc/plan_formation_python_cubicweb.txt	Wed Nov 12 21:12:49 2008 +0100
@@ -1,7 +1,7 @@
 .. -*- coding: utf-8 -*-
 
 Formation Python-CubicWeb 5 jours
-==============================
+==================================
 
 Bases Python
 ------------
@@ -38,13 +38,13 @@
 
 
 Développement CubicWeb
--------------------
+-----------------------
 
 Mise en place d'un environnement de développement CubicWeb
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 :durée: 0.5j
   Introduction mercurial
-  Installation de cubicweb et de ses dépendances (debian !)
+  Installation de CubicWeb et de ses dépendances (debian !)
   Postgres
   Notion de template et d'instance
   L'outil `cubicweb-ctl`
@@ -52,7 +52,7 @@
   Création d'une instance de développement
 
 Fondements CubicWeb
-~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~
 :durée: 0.1j
   Vocabulaire
   Le langage RQL
@@ -67,7 +67,7 @@
   Migration de schéma
 
 Fondements du framework CubicWeb
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 :durée: 0.1j
   La classe `appobject`
   La base de registres
--- a/doc/securite.txt	Wed Nov 12 21:12:30 2008 +0100
+++ b/doc/securite.txt	Wed Nov 12 21:12:49 2008 +0100
@@ -1,10 +1,13 @@
+.. -*- coding: utf-8 -*-
+
 Le contrôle d'accès
 ===================
 
-
 Vocabulaire
 -----------
+
 * Personne, Societe définissent deux *types* d'entité 
+
 * "Personne travaille_pour Societé" déclare qu'une relation
   travaille_pour peut exister entre une entité de type Personne et une
   entité de type Societe. L'ensemble des règles de ce type appliqué
@@ -15,7 +18,7 @@
 Description du modèle de sécurité
 ---------------------------------
 
-Le modèle de sécurité de cubicweb est un modèle fondé sur des `Access
+Le modèle de sécurité de `CubicWeb` est un modèle fondé sur des `Access
 Control List`. Les notions sont les suivantes :
 
 * utilisateurs et groupes d'utilisateurs
@@ -23,7 +26,7 @@
 * droits (lire, modifier, créer, supprimer) 
 * les droits sont attribués aux groupes (et non aux utilisateurs)
 
-Pour CubicWeb plus spécifiquement :
+Pour `CubicWeb` plus spécifiquement :
 
 * on associe les droits au niveau des schemas d'entites / relations
 * pour chaque type d'entité, on distingue les droits de lecture,