README.rst

   1 ==========================================
   2 Souscription : dons et adhésions avec SPIP
   3 ==========================================
   4
   5 Présentation du *plugin*
   6 ========================
   7
   8 Souscription est un *plugin* permettant de mettre en place, sur un
   9 site fonctionnant sous `SPIP <http://www.spip.net/>`_, des campagnes
  10 d'adhésions ou de dons. Le paiement est délégué au *plugin* `Bank
  11 <https://github.com/nursit/bank>`_, qui prend en charge différentes
  12 plateforme de paiement en ligne (chèque, PayBox, PayPal, virement,
  13 etc.).
  14
  15 Ce *plugin* a été développé pour les besoins d'`Attac France
  16 <http://www.france.attac.org/>`_ et de `Basta !
  17 <http://www.bastamag.net>`_.
  18
  19 Installation
  20 ============
  21
  22 Le *plugin* étant encore largement en développement (bien qu'utilisé
  23 en production par Attac France), il n'est pas installable directement
  24 depuis l'interface de gestion des *plugins* de SPIP.
  25
  26 Pour installer le *plugin*, il faut récupérer l'archive de la
  27 `dernière version
  28 <https://github.com/otetard/spip_souscription/releases>`_ publiée sur
  29 GitHub ou dupliquer le dépôt Git ::
  30
  31   $ git clone https://github.com/otetard/spip_souscription souscription
  32
  33 Il faut aussi récupérer le *plugin* `Bank
  34 <https://github.com/nursit/bank>`_, hébergé lui aussi sur GitHub ::
  35
  36   $ git clone https://github.com/nursit/bank
  37
  38 Les deux répertoires ``souscription/`` et ``bank/`` doivent ensuite
  39 être placés dans votre répertoire ``plugins/`` de votre installation
  40 SPIP.
  41
  42 Enfin, vous pouvez activer le *plugin* depuis l'interface de gestion
  43 des *plugins* de SPIP, ce qui permettra de télécharger les autres
  44 dépendances automatiquement.
  45
  46 Configuration
  47 =============
  48
  49 Il est possible de configurer le *plugin* (définition des montants
  50 proposés pour l'adhésion et/ou le dons). Pour cela, il faut se rendre
  51 dans le menu « Configuration » puis « Souscriptions ».
  52
  53 Première utilisation
  54 ====================
  55
  56 La première étape pour utiliser le *plugin* souscription est de mettre
  57 en place une campagne, d'adhésions ou de dons. Une campagne peut avoir
  58 des objectifs et il est éventuellement possible de définir des
  59 montants spécifiques.
  60
  61 Pour afficher le formulaire d'adhésion, il faut ensuite ajouter le
  62 code suivant dans un article (en adaptant le numéro de la campagne) ::
  63
  64   <souscription|campagne=1>