Doc : updated documentation with the new file tree and git scm
authorBenjamin Renard <brenard@aconit.easter-eggs.fr>
Fri, 13 Nov 2009 14:31:09 +0000 (15:31 +0100)
committerBenjamin Renard <brenard@aconit.easter-eggs.fr>
Fri, 13 Nov 2009 14:31:09 +0000 (15:31 +0100)
doc/install/arbo.docbook
doc/install/install.docbook
public_html/INSTALL

index ad4c098..7ae597e 100644 (file)
   
   <variablelist>
     <title>Racine</title>
-    <!-- Début - conf -->
+    
+    <varlistentry>
+      <term><filename>doc/</filename></term>
+      <listitem>
+        <simpara>Les fichiers sources de la documentation (docbook).</simpara>
+      </listitem>
+    </varlistentry>
+    
     <varlistentry>
-      <term><filename>conf/</filename></term>
+      <term><filename>lsexample/</filename></term>
       <listitem>
-        <simpara>Contient les fichiers de configuration.</simpara>
-        
-        <!-- Début - conf - Sous dossiers-->
+        <simpara>Les fichiers relatifs à l'annuaire d'exemple.</simpara>
+      </listitem>
+    </varlistentry>
+    
+    <!-- Début - public_html -->
+    <varlistentry>
+      <term><filename>public_html/</filename></term>
+      <listitem>
+        <simpara>Racine Web.</simpara>
         <variablelist>
-        
+          <!-- Début - conf -->
           <varlistentry>
-            <term><filename>LSobjects/</filename></term>
+            <term><filename>conf/</filename></term>
             <listitem>
-              <simpara>Configuration des LSobjets.</simpara>
+              <simpara>Contient les fichiers de configuration.</simpara>
+              
+              <!-- Début - conf - Sous dossiers-->
+              <variablelist>
+              
+                <varlistentry>
+                  <term><filename>LSobjects/</filename></term>
+                  <listitem>
+                    <simpara>Configuration des LSobjets.</simpara>
+                  </listitem>
+                </varlistentry>
+                
+                <varlistentry>
+                  <term><filename>LSaddons/</filename></term>
+                  <listitem>
+                    <simpara>Configuration des LSaddons.</simpara>
+                  </listitem>
+                </varlistentry>
+                
+              </variablelist>
+              <!-- Fin - conf - Sous dossiers -->
+              
             </listitem>
           </varlistentry>
+          <!-- Fin - conf -->
           
+          <!-- Début - include -->
           <varlistentry>
-            <term><filename>LSaddons/</filename></term>
+            <term><filename>includes/</filename></term>
+            
             <listitem>
-              <simpara>Configuration des LSaddons.</simpara>
+              <simpara>Contient les fichiers des ressources.</simpara>
+              
+              <!-- Début - include - Sous dossiers-->
+              <variablelist>
+              
+                <varlistentry>
+                  <term><filename>addons/</filename></term>
+                  <listitem>
+                    <simpara>Les addons au projet.</simpara>
+                  </listitem>
+                </varlistentry>
+                
+                <varlistentry>
+                  <term><filename>class/</filename></term>
+                  <listitem>
+                    <simpara>Les fichiers de définition des classes &php;.</simpara>
+                  </listitem>
+                </varlistentry>
+                
+                <varlistentry>
+                  <term><filename>js/</filename></term>
+                  <listitem>
+                    <simpara>Les fichiers Javascript.</simpara>
+                  </listitem>
+                </varlistentry>
+                
+                <varlistentry>
+                  <term><filename>libs/</filename></term>
+                  <listitem>
+                    <simpara>Les librairies utilisées.</simpara>
+                  </listitem>
+                </varlistentry>
+                
+              </variablelist>
+              <!-- Fin - include - Sous dossiers -->
+              
+            </listitem>
+          </varlistentry>
+          <!-- Fin - include -->
+          
+          <varlistentry>
+            <term><filename>lang/</filename></term>
+            <listitem>
+              <simpara>Les fichiers d'internationalisation.</simpara>
             </listitem>
           </varlistentry>
           
-        </variablelist>
-        <!-- Fin - conf - Sous dossiers -->
-        
-      </listitem>
-    </varlistentry>
-    <!-- Fin - conf -->
-    
-    <!-- Début - include -->
-    <varlistentry>
-      <term><filename>includes/</filename></term>
-      
-      <listitem>
-        <simpara>Contient les fichiers des ressources.</simpara>
-        
-        <!-- Début - include - Sous dossiers-->
-        <variablelist>
-        
           <varlistentry>
-            <term><filename>addons/</filename></term>
+            <term><filename>templates/</filename></term>
             <listitem>
-              <simpara>Les addons au projet.</simpara>
+              <simpara>Les fichiers <emphasis>template</emphasis> de l'interface. 
+              Il y a un sous-dossier par template.</simpara>
             </listitem>
           </varlistentry>
           
           <varlistentry>
-            <term><filename>class/</filename></term>
+            <term><filename>css/</filename></term>
             <listitem>
-              <simpara>Les fichiers de définition des classes &php;.</simpara>
+              <simpara>Les fichiers css de l'interface. Il y a un sous-dossier par 
+              template CSS.</simpara>
             </listitem>
           </varlistentry>
           
           <varlistentry>
-            <term><filename>js/</filename></term>
+            <term><filename>images/</filename></term>
             <listitem>
-              <simpara>Les fichiers Javascript.</simpara>
+              <simpara>Les images de l'interface. Il y a un sous-dossier par template
+              d'image.</simpara>
             </listitem>
           </varlistentry>
           
           <varlistentry>
-            <term><filename>libs/</filename></term>
+            <term><filename>tmp/</filename></term>
             <listitem>
-              <simpara>Les librairies utilisées.</simpara>
+              <simpara>Les fichiers temporaires (y compris le cache des templates).</simpara>
             </listitem>
           </varlistentry>
           
         </variablelist>
-        <!-- Fin - include - Sous dossiers -->
-        
-      </listitem>
-    </varlistentry>
-    <!-- Fin - include -->
-    
-    <varlistentry>
-      <term><filename>l10n/</filename></term>
-      <listitem>
-        <simpara>Les fichiers d'internationalisation.</simpara>
-      </listitem>
-    </varlistentry>
-    
-    <varlistentry>
-      <term><filename>lsexample/</filename></term>
-      <listitem>
-        <simpara>Les fichiers relatifs à l'annuaire d'exemple.</simpara>
-      </listitem>
-    </varlistentry>
-    
-    <varlistentry>
-      <term><filename>templates/</filename></term>
-      <listitem>
-        <simpara>Les fichiers <emphasis>template</emphasis> de l'interface. 
-        Il y a un sous-dossier par template.</simpara>
-      </listitem>
-    </varlistentry>
-    
-    <varlistentry>
-      <term><filename>css/</filename></term>
-      <listitem>
-        <simpara>Les fichiers css de l'interface. Il y a un sous-dossier par 
-        template CSS.</simpara>
-      </listitem>
-    </varlistentry>
-    
-    <varlistentry>
-      <term><filename>images/</filename></term>
-      <listitem>
-        <simpara>Les images de l'interface. Il y a un sous-dossier par template
-        d'image.</simpara>
-      </listitem>
-    </varlistentry>
-    
-    <varlistentry>
-      <term><filename>tmp/</filename></term>
-      <listitem>
-        <simpara>Les fichiers temporaires (y compris le cache des templates).</simpara>
       </listitem>
     </varlistentry>
+    <!-- Fin - public_html -->
     
   </variablelist>
 </sect1>
index 00998c5..854b421 100644 (file)
 <sect1 id="install-download">
   <title>Téléchargement</title>
   <para>Il n'existe pas encore de version stable publiée. Vous pouvez obtenir le
-  code source soit en le rapatriant à partir du serveur Subversion, soit en téléchargeant
-  le dernier snapshot nocturne de l'arbre Subversion.
+  code source soit en le rapatriant à partir du serveur Git, soit en téléchargeant
+  le dernier snapshot nocturne de l'arbre Git.
   </para>
   
   <sect2>
-    <title>A partir de Subversion</title>
-    <para>Le dépôt Subversion peut être récupéré anonymement en utilisant la
+    <title>A partir de Git</title>
+    <para>Le dépôt Git peut être récupéré anonymement en utilisant la
     commande suivante :
     <screen>
-      <command>svn checkout svn://labs.libre-entreprise.org/svnroot/ldapsaisie</command>
+      <command>git clone git://git.labs.libre-entreprise.org/ldapsaisie.git</command>
     </screen> 
     La racine web de l'application se trouvera alors dans le dossier <emphasis>
-    /ldapsaisie/trunk/</emphasis>.
+    /ldapsaisie/public_html/</emphasis>.
     </para>
   </sect2>
 
   <sect2>
     <title>A partir des snapshot</title>
-    <para>Toutes les nuits, un snapshot de l'arbre Subversion est réalisé et est
+    <para>Toutes les nuits, un snapshot de l'arbre Git est réalisé et est
     téléchargeable au format <emphasis>tar.gz</emphasis> à l'adresse suivante : 
     <ulink url='http://labs.libre-entreprise.org/snapshots.php?group_id=118'>
     http://labs.libre-entreprise.org/snapshots.php?group_id=118</ulink>
index 8563149..f88e8d5 100644 (file)
@@ -19,22 +19,22 @@ La librairie Net_LDAP2 oblige le fait que la racine DSE de l'annuaire soit lisib
 2. Téléchargement
 =================
 
-Il n'existe pas encore de version stable publiée. Vous pouvez obtenir le code source soit en le rapatriant à partir du serveur Subversion, soit en téléchargeant le dernier snapshot nocturne de l'arbre Subversion.
+Il n'existe pas encore de version stable publiée. Vous pouvez obtenir le code source soit en le rapatriant à partir du serveur Git, soit en téléchargeant le dernier snapshot nocturne de l'arbre Git.
 
-2.1. A partir de Subversion
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+2.1. A partir de Git
+~~~~~~~~~~~~~~~~~~~~
 
-Le dépôt Subversion peut être récupéré anonymement en utilisant la commande suivante :
+Le dépôt Git peut être récupéré anonymement en utilisant la commande suivante :
 
-      svn checkout svn://labs.libre-entreprise.org/svnroot/ldapsaisie
+      git clone git://git.labs.libre-entreprise.org/ldapsaisie.git
     
 
-La racine web de l'application se trouvera alors dans le dossier /ldapsaisie/trunk/.
+La racine web de l'application se trouvera alors dans le dossier /ldapsaisie/public_html/.
 
 2.2. A partir des snapshot
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Toutes les nuits, un snapshot de l'arbre Subversion est réalisé et est téléchargeable au format tar.gz à l'adresse suivante : http://labs.libre-entreprise.org/snapshots.php?group_id=118
+Toutes les nuits, un snapshot de l'arbre Git est réalisé et est téléchargeable au format tar.gz à l'adresse suivante : http://labs.libre-entreprise.org/snapshots.php?group_id=118
 
 
 3. Arborescence du projet
@@ -42,40 +42,46 @@ Toutes les nuits, un snapshot de l'arbre Subversion est réalisé et est téléc
 
 Racine
 
-conf/
+doc/
+    Les fichiers sources de la documentation (docbook).
 
-    Contient les fichiers de configuration.
-
-    LSobjects/
-        Configuration des LSobjets.
-    LSaddons/
-        Configuration des LSaddons.
-
-includes/
-
-    Contient les fichiers des ressources.
-
-    addons/
-        Les addons au projet.
-    class/
-        Les fichiers de définition des classes PHP.
-    js/
-        Les fichiers Javascript.
-    libs/
-        Les librairies utilisées.
-
-l10n/
-    Les fichiers d'internationalisation.
 lsexample/
     Les fichiers relatifs à l'annuaire d'exemple.
-templates/
-    Les fichiers template de l'interface. Il y a un sous-dossier par template.
-css/
-    Les fichiers css de l'interface. Il y a un sous-dossier par template CSS.
-images/
-    Les images de l'interface. Il y a un sous-dossier par template d'image.
-tmp/
-    Les fichiers temporaires (y compris le cache des templates).
+
+public_html /
+    
+    conf/
+    
+        Contient les fichiers de configuration.
+    
+        LSobjects/
+            Configuration des LSobjets.
+        LSaddons/
+            Configuration des LSaddons.
+    
+    includes/
+    
+        Contient les fichiers des ressources.
+    
+        addons/
+            Les addons au projet.
+        class/
+            Les fichiers de définition des classes PHP.
+        js/
+            Les fichiers Javascript.
+        libs/
+            Les librairies utilisées.
+    
+    lang/
+        Les fichiers d'internationalisation.
+    templates/
+        Les fichiers template de l'interface. Il y a un sous-dossier par template.
+    css/
+        Les fichiers css de l'interface. Il y a un sous-dossier par template CSS.
+    images/
+        Les images de l'interface. Il y a un sous-dossier par template d'image.
+    tmp/
+        Les fichiers temporaires (y compris le cache des templates).
 
 
 4. Les étapes de l'installation