Carnet Wiki

DocSpipLettres

SPIP-Contrib :: Carnet Wiki :: Recherche :

DocSpipLettres

Ceci n’est PAS la doc de spip-lettres .

Cette page est une vieille doc qui n’est pas sous licence libre et ne doit pas être modifiée. Si vous voulez modifier ou améliorer la doc, c’est sur la future doc définitive complétée qu’il faut travailler.

Voir aussi la Todo liste

Doc temporaire, en attendant sa mise en forme ici.

-  introduction au plugin
-  doc utilisateur
-  personnalisation des mails
-  sources de cette doc
-  signalement de bugs

Préconisations pour la doc définitive :
-  ne pas modifier cette doc originale, qui date du temps où Artego s’occupait de ce plugin.
-  utiliser la rubrique Spip-Lettres de spip-contrib, et les articles déjà créés ou d’autres à créer pour élaborer la future doc publique, reflet du plugin actualisé.

Ce plugin est en développement

Ce plugin est utilisé pour des milliers voire des dizaines ou centaines de milliers d’envois réels sur des sites en production, mais certains aspects, de l’interface notamment, sont encore à améliorer, ainsi que les possibilités de configuration.

Voir la liste des « todo »


Introduction au plugin


SPIP-Lettres est un plugin SPIP qui permet l’envoi de lettres d’information et la gestion de leurs abonnés depuis l’administration de votre site SPIP.

Ce module se veut simple d’utilisation, il reprend la logique de l’administration de SPIP, la puissance des squelettes et le multilinguisme de SPIP pour la création de belles lettres d’information HTML.
Personnalisez les squelettes

Une fois installé le plugin, vous pouvez personnaliser les squelettes selon la charte graphique de votre site, ou utiliser les squelettes par défaut.

Vous pouvez imaginer avoir des lettres simples ou inclure le contenu de votre site SPIP.

De la même manière que la grammaire des squelettes SPIP nous permet de créer des sites complets, les possibilités pour la mise en page et le contenu de vos lettres d’information sont illimitées.

Ecrivez votre lettre d’information

Créez votre lettre d’information, vous pouvez en modifier le titre, la date, le descriptif, le texte, y ajouter des logos, des images, enrichir le texte avec des raccourcis typographiques comme vous le feriez pour un courrier électronique.

Il est également possible d’associer à la lettre un article déjà existant.

Vous pouvez bien entendu prévisualiser la lettre à chaque instant, sa mise en page dépend des choix que vous avez faits pour les squelettes.

Une gestion des abonnements automatique

Le plugin possède un formulaire pour la gestion des abonnements/désabonnements : son fonctionnement est automatique, les abonnés gèrent leur compte sans manipulation de votre part.

Depuis la version 2.6 du plugin, une page d’administration vous permet de sélectionner les thèmes auxquels peuvent s’abonner les internautes.

Vous pouvez suivre l’évolution du nombre d’abonnés depuis l’administration du module, et gérer leurs comptes si besoin est.

Testez l’envoi, envoyez, reprenez les envois, importez, exportez, renvoyez

Testez l’envoi de votre lettre d’information avant de la faire parvenir aux abonnés.

Créez une lettre pour chaque envoi.

Ce module dispose de fonctions d’import et d’export de liste d’abonnés.

Vous pouvez aussi renvoyer une lettre à un abonné.

Envoyez de belles lettres

Chaque abonné reçoit la lettre dans le format qu’il a choisi : HTML, texte ou mixte, et les éventuelles images sont jointes à l’email pour une consultation hors-ligne.

Chaque lettre envoyée contient un lien de désabonnement afin de respecter de la loi pour la confiance dans l’économie numérique du 21 juin 2004.

Récupérez des informations complémentaires

Grâce aux champs extra des abonnés, vous pouvez récupérer des informations complémentaires au sujet de vos abonnés lors de leur inscription.

Vous pouvez aussi les modifier depuis l’espace privé de SPIP.

Utilisez celles-ci dans vos lettres d’information pour les rendre plus personnelles.

Mesurez le succès d’une campagne d’envois

Le plugin SPIP-Lettres gère les statistiques essentielles pour vous :

-  calcul du taux d’ouverture de vos lettres (lorsqu’un abonné clique un lien)
-  liens populaires
-  assiduité des abonnés


Doc Utilisateur


Une documentation destinée aux utilisateurs de SPIP-Lettres. Elle couvre les points essentiels du plugin.

Le fonctionnement de SPIP-Lettres a changé depuis sa version 2.6. Les abonnés ne s’abonnent plus aux lettres mais aux rubriques, ce qui permet de créer une lettre par campagne d’envoi et de gérer plus facilement vos abonnés.

Les rubriques comme abonnements

PNG

Les abonnés sont désormais associés aux rubriques de votre site SPIP. Chaque rubrique à laquelle est associé un abonné est un abonnement.

Le choix des rubriques que vous associez à un abonné est important car c’est lui qui définit quelles lettres il recevra.

Exemple 1 : un abonné associé à la rubrique Racine > Nos produits > Fromages recevra seulement les lettres rédigées dans la rubrique Fromages et ses sous-rubriques. On peut considérer que les lettres rédigées dans Racine > Nos produits > Saucissons ne l’intéressent pas.

Exemple 2 : un abonné associé à la racine du site recevra toutes les lettres, on peut considérer que tout l’intéresse.

Configuration du formulaire d’abonnement

PNG

Les internautes peuvent s’abonner à un nombre restreint de rubriques depuis le formulaire d’abonnement situé sur la partie publique de votre site. Vous pouvez limiter le choix de ces rubriques depuis l’espace privé. Rendez-vous à la page "Configuration > Lettres d’information", onglet "Configuration du formulaire d’abonnement" :

-  sélectionnez la rubrique à laquelle les internautes pourront s’abonner
-  donnez-lui un nom

Cela constitue un thème.

Si la liste comporte déjà des thèmes, c’est la mise à jour qui les a créées : ces thèmes correspondent aux rubriques dans lesquelles vous aviez publié des lettres d’information.

Pour modifier le nom d’un thème :

-  supprimez le thème en question
-  ajoutez un nouveau thème

Cela n’a pas d’incidence sur les abonnés de ces rubriques.

PNG

Cette restriction n’est valable que sur la partie publique puisque vous êtes libres de gérer les abonnements comme bon vous semble dans l’espace privé. Il s’agit uniquement de la configuration du formulaire d’abonnement.

Envois de lettres d’information

La différence majeure avec les versions antérieures à la 2.6 est la création d’une lettre par campagne d’envois.

Vous commencez par créer une lettre et tant qu’elle n’a pas été envoyée elle reste en cours de rédaction. Une fois la lettre envoyée, elle n’est plus éditable et elle est automatiquement archivée.

Le choix de la rubrique dans laquelle vous écrivez votre lettre définit qui recevra cette lettre : cf "Les rubriques comme abonnements".

En bas de chaque lettre d’information en cours de rédaction figure une liste des abonnés qui recevront la lettre d’information. Il s’agit des d’abonnés :

-  directs : ils sont abonnés à la rubrique dans laquelle se trouve la lettre d’information
-  indirects : ils sont abonnés à une rubrique parente de la rubrique dans laquelle se trouve la lettre d’information

PNG

Lorsque vous visualisez une lettre en cours de rédaction, vous pouvez, au choix :

-  tester son envoi avec pour destinataires les auteurs associés à la lettre
-  l’envoyer
-  la copier
-  la supprimer

L’envoi des lettres se fait via un javascript, qui délivre les lettres 100 par 100. Les envois programmés ont été supprimés car les tâches de fond spip manquent de fiabilité.

Lettres envoyées

Selon le nombre d’abonnés qui reçoivent vos lettres, l’envoi peut prendre plus ou moins longtemps. L’état "en cours d’envoi" est donc intermédiaire.

L’envoi terminé, vous aurez accès au taux d’ouverture de vos lettres, et vous pourrez visualiser les liens (contenus dans votre texte) les plus populaires. Ces statistiques ne sont disponibles que pour les lettres envoyées après la mise à jour SPIP-Lettres 2.6.


Personnalisation des mails envoyés

D’après la doc technique ARTEGO (juin 2008 - V. 2.6 du plugin, mais il semble que ça aie beaucoup évolué


Une documentation pour savoir comment personnaliser les squelettes de votre plugin SPIP-Lettres avec les boucles, critères, balises et formulaires spécifiques.

JL : Le sous répertoire ’emails’ de votre dossier squelette contient les squelettes utilisés pour définir les éléments de la lettre envoyée ainsi que les notifications a priori. Il est possible de modifier cette préférence grâce au formulaire de configuration avancé de spip-lettres.

Non documentés

Utilisés dans le squelette : emails/inc-haut
-  #LOGO_LETTRE_NORMAL : dépend de chaque lettre, définit sur l’interface de visualisation de chaque lettre
-  #LOGO_NOTIFICATION_NORMAL : global au site, mais définit je sais pas où...

Boucles LETTRES

Une boucle de lettres d’information se code en plaçant LETTRES entre parenthèses :

  1. <BOUCLEn(LETTRES) {critères...}>...</BOUCLEn>

Les critères de sélection :

-  {id_rubrique} retourne la liste des lettres d’information contenues dans la rubrique id_rubrique
-  {id_secteur} retourne les lettres d’information contenues dans ce secteur
-   {branche}
-   {id_auteur} retourne les lettres d’information liées à cet identifiant auteur
-   {id_mot}, {titre_mot=xxxx}, ou {type_mot=yyyy} retourne les lettres d’information liées au mot-clé dont l’identifiant de mot-clé est id_mot, ou le nom est « xxxx », ou liées à des mots-clés du groupe de mots-clés « yyyy ». Attention, on ne peut pas utiliser plusieurs critères titre_mot=xxxx ou type_mot=yyyy dans une même boucle. Il faut aussi que vous ayez activé le plugin SPIP-Mots
-   {id_groupe=zzzz} permet de sélectionner les lettres d’informations liées à un groupe de mots-clés ; principe identique au type_mot précédent, mais puisque l’on travaille avec un identifiant (numéro du groupe), la syntaxe sera plus « propre ».
-   {lang} sélectionne les lettres d’information de la langue demandée dans l’adresse de la page.
-   {recherche} trouve les lettres d’information pour le mot recherché

A moins que vous ne soyez en train de prévisualiser une lettre en cours de rédaction depuis l’espace privé (squelettes lettre_html.html et lettre_texte.html), seules les lettres au statut "envoyee" sont affichées dans le squelette lettre.html.

Les balises de la boucle :

-  #ID_LETTRE
-  #TITRE
-  #DESCRIPTIF
-  #TEXTE
-  #DATE
-  #LOGO_LETTRE
-  #URL_LETTRE

Boucles ARTICLES

Il est possible d’associer des articles aux lettres si vous activez cette option dans la configuration du plugin. A ce moment-là il devient possible d’intégrer des <BOUCLE_test(ARTICLES) {id_lettre}>...</BOUCLE_test> dans vos boucles.

#FORMULAIRE_LETTRES

Présent dans le répertoire formulaires/ du plugin SPIP-Lettres, ce formulaire sert à la gestion de l’abonnement d’un abonné :

-  abonnement
-  désabonnement
-  changement de format

Ce formulaire va de paire avec le formulaire #FORMULAIRE_LETTRES_MESSAGES qui a pour vocation d’afficher le résultat d’une action déclenchée par #FORMULAIRE_LETTRES.

Dans votre dossier des squelettes, vous pouvez créer à l’intérieur du répertoire formulaires/ les squelettes formulaire_lettres.html et formulaire_lettres_messages.html en vous inspirant du code fourni par le plugin.
Personnaliser les lettres d’information

Par défaut les squelettes lettre_html.html et lettre_texte.html servent à générer les lettres d’information respectivement HTML et texte.

Vous pouvez changer ces paramètres dans la configuration de votre site SPIP.

Personnaliser les notifications

Vous pouvez de la même manière personnaliser les squelettes des notifications.

Toutes les notifications de SPIP-Lettres sont présentes dans le répertoire notifications/ du plugin, vous pouvez vous en inspirer. Rangez vos notifications dans un répertoire notifications/ dans le dossier de vos squelettes.
JLuc : NON, c’est dans le répertoire emails aussi :

Si vous gérez un fichier d’abonnés dans un logiciel externe, pour vos clients par exemple, vous pouvez être notifiés lors de la suppression d’un abonné pour éviter d’importer à nouveau cette personne.

Pour cela il vous suffit d’activer l’option correspondante dans l’admin de SPIP-Lettres.

Balises propres au plugin

-   %%URL_VALIDATION_ABONNEMENTS%% se place en principe dans les notifications liées aux abonnements, il sert à valider les abonnements

-   %%URL_VALIDATION_DESABONNEMENTS%% se place soit dans les notifications liées aux désabonnements, soit dans une lettre d’information

-   %%URL_VALIDATION_CHANGEMENT_FORMAT%% se place dans les notifications liées au changement de format de l’abonné

-  #URL_FORMULAIRE_LETTRES retourne l’adresse où figure le #FORMULAIRE_LETTRES que vous avez renseignée dans la configuration du site. Par défaut il s’agit de spip.php ?page=lettres

Champs extra sur les abonnés

Nous avons ajouté la possibilité de récupérer des informations supplémentaires au sujet des abonnés en utilisant les champs extra. Suivez les étapes suivantes :

1. mes_options.php

Il faut déclarer ces champs extra dans votre fichier ecrire/mes_options.php :

  1. <?php
  2. // exemple avec un champ extra 'prenom'
  3. // obligatoire (d'où le point d'exclamation)
  4. $GLOBALS['champs_extra'] = Array (
  5. 'abonnes' => Array (
  6. "prenom!" => "ligne|brut|Prénom"
  7. )
  8.  
  9. );
  10. ?>

Télécharger

Bien entendu, intégrez ces lignes dans les vôtres. Reportez-vous à l’article sur spip-contrib.net pour une documentation sur les champs extra avec SPIP.

Pour rendre un champ obligatoire, ce champ extra doit se terminer par un point d’exclamation " !".

2. #FORMULAIRE_LETTRES

Il vous reste à ajouter du HTML dans votre le #FORMULAIRE_LETTRES, ça n’est pas automatique :

  1. ...
  2. [(#REM) champ extra prenom! ]
  3. <dl>
  4. <dt><label for="prenom">Prénom</label></dt>
  5. <dd><input type="text" name="prenom!" id="prenom" value="" /></dd>
  6. </dl>
  7. ...

Télécharger

3. Personnalisez vos lettres


Dans vos lettres d’information, vous pourrez utiliser des raccourcis typographiques de la forme : %%NOM_DU_CHAMP_EXTRA|texte sinon%%, la casse du nom du champ est importante.

Dans l’exemple précédent, vous pourriez mettre dans le texte d’une lettre : Bonjour %%PRENOM !%%, comment ça va ? ou encore : Bonjour %%PRENOM !|à toi%%, comment ça va ?.

Ces raccourcis sont remplacés à l’envoi de la lettre seulement, vous obtiendrez %%PRENOM !%% lors de la prévisualisation d’une lettre d’information.


Sources de cette doc


Ces éléments de doc sont inspirées de la doc originelle de artego, retrouvée dans les caches google et archive.org...

Voir les copies de pages de archive.org :

Plugin SPIP-Lettres - Présentation - Artégo
Plugin SPIP-Lettres tiré de archive.org
Plugin SPIP-Lettres - Documentation utilisateur - Artégo
Plugin SPIP-Lettres tiré de archive.org
Plugin SPIP-Lettres - Documentation technique - Artégo
Plugin SPIP-Lettres tiré de archive.org

Le plugin a depuis été profondément remanié et modernisé par Cédric Morin, et de nouvelles fonctionnalités ont été introduites.


Bugs et questions


(JL :) Comme avec les articles ou les rubriques, il est possible d’associer un logo et un logo survol à chaque lettre. Mais il n’y a pas de titre à droite du petit triangle qui permet de déplier le formulaire de sélection du fichier, sous l’icone de l’appareil photo.