On segmente la documentation d'installation.

Cela permet de comprendre le découpage de ce chapitre.
Ybbet · May 16, 2016 · a0f024f · a0f024f
1 parent aba3fdc
commit a0f024f
Show file tree

Hide file tree

Showing 6 changed files with 258 additions and 121 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -57,9 +57,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'0.0.1'
+version = u'0.1.0'
 # The full version, including alpha/beta/rc tags.
-release = u'0.0.1'
+release = u'0.1.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,7 +13,9 @@ Cette documentation va vous permettre de prendre en main l'outil rapidement.
 Il est distribué sous forme de plugin pour le CMS SPIP.
 
 
-Contents:
+====================
+Table des matières :
+====================
 
 .. toctree::
    :maxdepth: 3
@@ -22,11 +24,3 @@ Contents:
 
    installation/index
 
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
diff --git a/docs/source/installation/config.rst b/docs/source/installation/config.rst
@@ -0,0 +1,38 @@
+----------------
+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``. 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 :
+
+.. code-block:: html
+
+   Activer le mode runtime ? 'Non'
+   Activer le mode pas-à-pas ? 'Non'
+   Activer les logs verbeux ? 'Non'
+   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.
+
+~~~~~~~~~~~~~~~~
+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``.
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Installer le plugin InfoSites
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+* 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
@@ -0,0 +1,86 @@
+----------------
+Télécharger SPIP
+----------------
+~~~~~~~~~~~~
+Manuellement
+~~~~~~~~~~~~
+`SPIP`_ fournit une archive zip pour permettre son installation. Vous pouvez la télécharger à cette `adresse`_.
+
+Une fois que vous avez récupéré l'archive, vous devez la décompresser et copier le contenu de l'archive dans le répertoire qui contiendra votre site de supervision.
+
+
+~~~~~~~~~~~~~~~
+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.
+
+.. 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.
+
+
+~~~~~~~~~~~~~~~~~~~~~~
+Structure des fichiers
+~~~~~~~~~~~~~~~~~~~~~~
+Quelque soit la méthode de récupération des sources de SPIP, vous aurez une structure de fichiers telle que ceci :
+
+.. code-block:: shell
+
+   CHANGELOG.txt
+   config/
+   COPYING.txt
+   ecrire/
+   htaccess.txt
+   IMG/
+   index.php
+   INSTALL.txt
+   local/
+   plugins-dist/
+   prive/
+   rien.gif
+   spip.php
+   spip.png
+   squelettes-dist
+   svn.revision
+   tmp/
+
+Il faut maintenant créer quelques répertoires pour que l'installation soit simplifier. Aller dans le répertoire où vous avez installé les sources de SPIP et créez les répertoires suivants à la racine du site :
+
+.. code-block:: bash
+
+   lib/
+   plugins/
+   plugins/auto
+
+La nouvelle structure de répertoire sera :
+
+.. code-block:: shell
+
+   CHANGELOG.txt
+   config/
+   COPYING.txt
+   ecrire/
+   htaccess.txt
+   IMG/
+   index.php
+   INSTALL.txt
+   lib/
+   local/
+   plugins-dist/
+   plugins/
+   plugins/auto
+   prive/
+   rien.gif
+   spip.php
+   spip.png
+   squelettes-dist
+   svn.revision
+   tmp/
+
+.. warning::
+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/``
+
+
+.. On renseigne ici tous les liens de la page
+.. _SPIP: http://www.spip.net/fr
+.. _adresse: http://www.spip.net/fr_download
+.. _spip_loader.php: http://www.spip.net/spip-dev/INSTALL/spip_loader.php
diff --git a/docs/source/installation/index.rst b/docs/source/installation/index.rst
@@ -1,118 +1,16 @@
 Installation
 ============
 
-Pour installer InfoSites, il vous faut installer en tout premier lieu SPIP et faire une ou deux configurations pour qu'InfoSites puissent s'installer dans les meilleurs conditions.
+Pour installer InfoSites, il vous faut installer en tout premier lieu SPIP et faire une ou deux configurations pour qu'InfoSites puissent s'installer dans les meilleures conditions.
 InfoSites est compatible avec SPIP 3.0 à minima.
 
-----------------
-Télécharger SPIP
-----------------
-~~~~~~~~~~~~
-Manuellement
-~~~~~~~~~~~~
-`SPIP`_ fournit une archive zip pour permettre son installation. Vous pouvez la télécharger à cette `adresse`_.
+.. toctree::
+   :maxdepth: 3
+   :numbered:
+   :glob:
 
-Une fois que vous avez récupéré l'archive, vous devez la décompresser et copier le contenu de l'archive dans le répertoire qui contiendra votre site de supervision.
+   requirements
+   download
+   config
 
 
-~~~~~~~~~~~~~~~
-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.
-
-.. 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.
-
-
-~~~~~~~~~~~~~~~~~~~~~~
-Structure des fichiers
-~~~~~~~~~~~~~~~~~~~~~~
-Quelque soit la méthode de récupération des sources de SPIP, vous aurez une structure de fichiers telle que ceci :
-
-.. code-block:: shell
-
-   CHANGELOG.txt
-   config/
-   COPYING.txt
-   ecrire/
-   htaccess.txt
-   IMG/
-   index.php
-   INSTALL.txt
-   local/
-   plugins-dist/
-   prive/
-   rien.gif
-   spip.php
-   spip.png
-   squelettes-dist
-   svn.revision
-   tmp/
-
-Il faut maintenant créer quelques répertoires pour que l'installation soit simplifier. Aller dans le répertoire où vous avez installé les sources de SPIP et créez les répertoires suivants à la racine du site :
-
-.. code-block:: bash
-
-   lib/
-   plugins/
-   plugins/auto
-
-La nouvelle structure de répertoire sera :
-
-.. code-block:: shell
-
-   CHANGELOG.txt
-   config/
-   COPYING.txt
-   ecrire/
-   htaccess.txt
-   IMG/
-   index.php
-   INSTALL.txt
-   lib/
-   local/
-   plugins-dist/
-   plugins/
-   plugins/auto
-   prive/
-   rien.gif
-   spip.php
-   spip.png
-   squelettes-dist
-   svn.revision
-   tmp/
-
-.. warning::
-   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/``
-
-
-----------------
-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 suivez les différentes étapes à l'écran.
-
-Cela fait, allez sur la page de gestion des plugins : ``Configuration > Gestion des plugins``. Puis cliquez sur ``Verrouilés``. Recherchez le plugin ``SVP``. Cliquez 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électionnez les éléments suivants dans le formulaire :
-
-.. code-block:: html
-
-   Activer le mode runtime ? 'Non'
-   Activer le mode pas-à-pas ? 'Non'
-   Activer les logs verbeux ? 'Non'
-   Autoriser l'activation des paquets obsolètes ? 'Non'
-   Permettre l'édition des dépôts ? 'Non'
-
-Cliquez 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`` ;
-* Cliquez 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`` ;
-* Cliquez sur le bouton ``Ajouter``.
-
-
-.. On renseigne ici tous les liens de la page
-.. _SPIP: http://www.spip.net/fr
-.. _adresse: http://www.spip.net/fr_download
-.. _spip_loader.php: http://www.spip.net/spip-dev/INSTALL/spip_loader.php