mirror of
https://gitlab.easter-eggs.com/ee/ldapsaisie.git
synced 2024-11-22 18:09:06 +01:00
Doc : updated documentation with the new file tree and git scm
This commit is contained in:
Benjamin Renard
parent
f0e9116baf
commit
500669a320
3 changed files with 172 additions and 147 deletions
|
|
@ -4,85 +4,11 @@
|
||||||
|
|
||||||
<variablelist>
|
<variablelist>
|
||||||
<title>Racine</title>
|
<title>Racine</title>
|
||||||
<!-- Début - conf -->
|
|
||||||
<varlistentry>
|
|
||||||
<term><filename>conf/</filename></term>
|
|
||||||
<listitem>
|
|
||||||
<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>includes/</filename></term>
|
|
||||||
|
|
||||||
<listitem>
|
|
||||||
<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>
|
<varlistentry>
|
||||||
<term><filename>l10n/</filename></term>
|
<term><filename>doc/</filename></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<simpara>Les fichiers d'internationalisation.</simpara>
|
<simpara>Les fichiers sources de la documentation (docbook).</simpara>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
|
|
@ -93,36 +19,129 @@
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
|
<!-- Début - public_html -->
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><filename>templates/</filename></term>
|
<term><filename>public_html/</filename></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<simpara>Les fichiers <emphasis>template</emphasis> de l'interface.
|
<simpara>Racine Web.</simpara>
|
||||||
Il y a un sous-dossier par template.</simpara>
|
<variablelist>
|
||||||
</listitem>
|
<!-- Début - conf -->
|
||||||
</varlistentry>
|
<varlistentry>
|
||||||
|
<term><filename>conf/</filename></term>
|
||||||
|
<listitem>
|
||||||
|
<simpara>Contient les fichiers de configuration.</simpara>
|
||||||
|
|
||||||
<varlistentry>
|
<!-- Début - conf - Sous dossiers-->
|
||||||
<term><filename>css/</filename></term>
|
<variablelist>
|
||||||
<listitem>
|
|
||||||
<simpara>Les fichiers css de l'interface. Il y a un sous-dossier par
|
|
||||||
template CSS.</simpara>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><filename>images/</filename></term>
|
<term><filename>LSobjects/</filename></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<simpara>Les images de l'interface. Il y a un sous-dossier par template
|
<simpara>Configuration des LSobjets.</simpara>
|
||||||
d'image.</simpara>
|
</listitem>
|
||||||
</listitem>
|
</varlistentry>
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><filename>tmp/</filename></term>
|
<term><filename>LSaddons/</filename></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<simpara>Les fichiers temporaires (y compris le cache des templates).</simpara>
|
<simpara>Configuration des LSaddons.</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>
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
</variablelist>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<!-- Fin - public_html -->
|
||||||
|
|
||||||
</variablelist>
|
</variablelist>
|
||||||
</sect1>
|
</sect1>
|
||||||
|
|
|
||||||
|
|
@ -21,25 +21,25 @@
|
||||||
<sect1 id="install-download">
|
<sect1 id="install-download">
|
||||||
<title>Téléchargement</title>
|
<title>Téléchargement</title>
|
||||||
<para>Il n'existe pas encore de version stable publiée. Vous pouvez obtenir le
|
<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
|
code source soit en le rapatriant à partir du serveur Git, soit en téléchargeant
|
||||||
le dernier snapshot nocturne de l'arbre Subversion.
|
le dernier snapshot nocturne de l'arbre Git.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<sect2>
|
<sect2>
|
||||||
<title>A partir de Subversion</title>
|
<title>A partir de Git</title>
|
||||||
<para>Le dépôt Subversion peut être récupéré anonymement en utilisant la
|
<para>Le dépôt Git peut être récupéré anonymement en utilisant la
|
||||||
commande suivante :
|
commande suivante :
|
||||||
<screen>
|
<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>
|
</screen>
|
||||||
La racine web de l'application se trouvera alors dans le dossier <emphasis>
|
La racine web de l'application se trouvera alors dans le dossier <emphasis>
|
||||||
/ldapsaisie/trunk/</emphasis>.
|
/ldapsaisie/public_html/</emphasis>.
|
||||||
</para>
|
</para>
|
||||||
</sect2>
|
</sect2>
|
||||||
|
|
||||||
<sect2>
|
<sect2>
|
||||||
<title>A partir des snapshot</title>
|
<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 :
|
téléchargeable au format <emphasis>tar.gz</emphasis> à l'adresse suivante :
|
||||||
<ulink url='http://labs.libre-entreprise.org/snapshots.php?group_id=118'>
|
<ulink url='http://labs.libre-entreprise.org/snapshots.php?group_id=118'>
|
||||||
http://labs.libre-entreprise.org/snapshots.php?group_id=118</ulink>
|
http://labs.libre-entreprise.org/snapshots.php?group_id=118</ulink>
|
||||||
|
|
|
||||||
|
|
@ -19,22 +19,22 @@ La librairie Net_LDAP2 oblige le fait que la racine DSE de l'annuaire soit lisib
|
||||||
2. Téléchargement
|
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
|
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
|
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
|
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/
|
lsexample/
|
||||||
Les fichiers relatifs à l'annuaire d'exemple.
|
Les fichiers relatifs à l'annuaire d'exemple.
|
||||||
templates/
|
|
||||||
Les fichiers template de l'interface. Il y a un sous-dossier par template.
|
public_html /
|
||||||
css/
|
|
||||||
Les fichiers css de l'interface. Il y a un sous-dossier par template CSS.
|
conf/
|
||||||
images/
|
|
||||||
Les images de l'interface. Il y a un sous-dossier par template d'image.
|
Contient les fichiers de configuration.
|
||||||
tmp/
|
|
||||||
Les fichiers temporaires (y compris le cache des templates).
|
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
|
4. Les étapes de l'installation
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue