Structure de la documentation

Ajout d’un répertoire utilisation
Ybbet · May 16, 2016 · 244368f · 244368f
1 parent ff5a322
commit 244368f
Show file tree

Hide file tree

Showing 10 changed files with 47 additions and 18 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -22,6 +22,7 @@ Table des matières :
    :glob:
 
    installation/index
+   utilisation/index
    contributing
    about
 
diff --git a/docs/source/installation/config.rst b/docs/source/installation/config.rst
@@ -2,9 +2,9 @@ Configurer SPIP
 ===============
 Après avoir récupérer les fichiers sources de SPIP, dans votre navigateur, aller à l'adresse suivante : `http://example.tld/ecrire/`. Et suivre les différentes étapes à l'écran.
 
-Cela fait, aller sur la page de gestion des plugins : ``Configuration > Gestion des plugins``.
+Cela fait, aller sur la page de gestion des plugins : **Configuration > Gestion des plugins**.
 
-* Puis cliquer sur ``Verrouilés`` ;
+* Puis cliquer sur **Verrouilés** ;
 * Rechercher le plugin ``SVP`` ;
 * Cliquer sur l'icône de configuration à droite de la ligne. Cela vous amènera sur la page ``http://example.tkd/ecrire/?exec=configurer_svp`` ;
 * Sélectionner les éléments suivants dans le formulaire :
@@ -17,24 +17,24 @@ Cela fait, aller sur la page de gestion des plugins : ``Configuration > Gestion
    Autoriser l'activation des paquets obsolètes ? 'Non'
    Permettre l'édition des dépôts ? 'Non'
 
-* Cliquer sur ``Enregistrer`` après avoir sélectionné 'Non' à chaque élément.
+* Cliquer sur **Enregistrer** après avoir sélectionné 'Non' à chaque élément.
 
 Ajouter un dépôt
 ----------------
-* Revenir sur la page de gestion des plugins : ``Configuration > Gestion des plugins`` ;
-* Cliquer sur l'onglet ``Ajouter des plugins > Dépôts`` ;
-* Dans le formulaire ``Ajouter un dépôt``, saisir le lien ``http://plugins.spip.net/depots/principal.xml`` dans le champ ``Fichier XML du dépôt`` ;
-* Cliquer sur le bouton ``Ajouter``.
+* Revenir sur la page de gestion des plugins : **Configuration > Gestion des plugins** ;
+* Cliquer sur l'onglet **Ajouter des plugins > Dépôts** ;
+* Dans le formulaire **Ajouter un dépôt**, saisir le lien ``http://plugins.spip.net/depots/principal.xml`` dans le champ **Fichier XML du dépôt** ;
+* Cliquer sur le bouton **Ajouter**.
 
 Installer le plugin Info Sites
 ------------------------------
-* Aller sur la page de gestion des plugins : ``Configuration > Gestion des plugins`` ;
-* Cliquer sur l'onglet ``Ajouter des plugins > Plugins`` ;
-* Dans le champ ``Rechercher dans les plugins``, taper *info sites* ;
-* Sélectionner ``Tous les états`` dans le champ ``États`` ;
-* Cliquer sur le bouton ``Rechercher`` ;
-* Cocher la case correspondant à la ligne ``Info Sites`` ;
-* Puis cliquer sur le bouton ``Télécharger et activer`` ;
+* Aller sur la page de gestion des plugins : **Configuration > Gestion des plugins** ;
+* Cliquer sur l'onglet **Ajouter des plugins > Plugins** ;
+* Dans le champ **Rechercher dans les plugins**, taper ``info sites`` ;
+* Sélectionner **Tous les états** dans le champ **États** ;
+* Cliquer sur le bouton **Rechercher** ;
+* Cocher la case correspondant à la ligne **Info Sites** ;
+* Puis cliquer sur le bouton **Télécharger et activer** ;
 * Enfin, valider la fenêtre de dialogue pour lancer l'installation du plugin et de ses dépendances ;
 * Recharger la page si nécessaire.
 
diff --git a/docs/source/installation/download.rst b/docs/source/installation/download.rst
@@ -11,10 +11,10 @@ Une fois que vous avez récupéré l'archive, vous devez la décompresser et cop
 
 Automatiquement
 ---------------
-Il est possible d'installer `SPIP`_ par le biais d'un fichier PHP : `spip_loader.php`_. Il faudra enregister ce fichier à la racine de votre site de supervision puis de l'appeler dans votre navigateur : `http://example.tld/spip_loader.php`. Cela fait, veuillez suivre la procédure affichée à l'écran.
+Il est possible d'installer `SPIP`_ par le biais d'un fichier PHP : `spip_loader.php`_. Il faudra enregistrer ce fichier à la racine de votre site de supervision puis de l'appeler dans votre navigateur : `http://example.tld/spip_loader.php`. Cela fait, veuillez suivre la procédure affichée à l'écran.
 
 .. note::
-   Par défaut, le fichier `spip_loader.php` indique la dernière version stable de SPIP. Si vous désirez utiliser une autre version, vous devez modifier ce fichier en recherchant le terme ``_CHEMIN_DEFINE_ZIP``. Depuis la version ``2.5.7``, vous pouvez trouver en commentaire dans ce fichier les 3 branches maintenues de SPIP. A vous de choisir la version qui vous convient.
+   Par défaut, le fichier `spip_loader.php` indique la dernière version stable de SPIP. Si vous désirez utiliser une autre version, vous devez modifier ce fichier en recherchant le terme **_CHEMIN_DEFINE_ZIP**. Depuis la version **2.5.7**, vous pouvez trouver en commentaire dans ce fichier les 3 branches maintenues de SPIP. A vous de choisir la version qui vous convient.
 
 
 Structure des fichiers
@@ -75,8 +75,10 @@ La nouvelle structure de répertoire sera :
    tmp/
 
 .. caution::
-   Si vous rencontrez des problèmes d'autorisation sur les répertoires dans les étapes suivantes, il faudra changer les droits sur des répertoires avec cette ligne de commande::
-      ``chmod -R 755 local/ tmp/ config/ IMG/ plugins/ lib/``
+   Si vous rencontrez des problèmes d'autorisation sur les répertoires dans les étapes suivantes, il faudra changer les droits sur des répertoires avec cette ligne de commande:
+      .. code-block:: shell
+
+         chmod -R 755 local/ tmp/ config/ IMG/ plugins/ lib/
 
 
 .. On renseigne ici tous les liens de la page

diff --git a/docs/source/utilisation/commits.rst b/docs/source/utilisation/commits.rst
@@ -0,0 +1,2 @@
+Les commits
+===========
diff --git a/docs/source/utilisation/contacts.rst b/docs/source/utilisation/contacts.rst
@@ -0,0 +1,2 @@
+Les contacts
+============
diff --git a/docs/source/utilisation/index.rst b/docs/source/utilisation/index.rst
@@ -0,0 +1,13 @@
+Utilisation
+===========
+
+.. toctree::
+   :maxdepth: 3
+   :numbered:
+   :glob:
+
+   utilisateurs
+   organisations
+   contacts
+   projets
+   sites_projets
diff --git a/docs/source/utilisation/organisations.rst b/docs/source/utilisation/organisations.rst
@@ -0,0 +1,3 @@
+Les organisations
+=================
+
diff --git a/docs/source/utilisation/projets.rst b/docs/source/utilisation/projets.rst
@@ -0,0 +1,2 @@
+Les projets
+===========
diff --git a/docs/source/utilisation/sites_projets.rst b/docs/source/utilisation/sites_projets.rst
@@ -0,0 +1,2 @@
+Les sites de projets
+====================
diff --git a/docs/source/utilisation/utilisateurs.rst b/docs/source/utilisation/utilisateurs.rst
@@ -0,0 +1,2 @@
+Les utilisateurs
+================