Mode d’emploi

Le plugin [s’installe comme tous les autres ->http://www.spip.net/fr_article3396.html]

Pré-requis

Ce plugin nécessite le module cURL de PHP pour fonctionner.

Configuration

Une fois le plugin activé, il faut passer sur sa page de configuration accessible depuis la page des plugins.

Configurer l’accès à Twitter

Toute l’API Twitter n’étant accessible qu’en étant identifié, il faut y configurer les clés secrètes d’une Application Twitter et ajouter un ou plusieurs comptes que le site pourra utiliser. Cette partie de la configuration est décrite en détail dans [->4394].

Configurer l’envoi de Tweets

Une fois l’application et les comptes configurés, vous pouvez ensuite indiquer :

• les évènements qui déclencheront l’envoi d’une notification ; pour l’instant 4 types sont disponibles : -** le post d’un nouveau message de forum (y compris message en attente de modération)
  • la publication d’un nouveau message de forum
  • le passage d’un article en mode « Proposé à la publication » -** la publication en ligne d’un article.
• la présence ou non d’une invite de status sur chaque article pour permettre de personaliser le Tweet qui sera envoyé.

  Configurer les Widgets

  Tout cela concerne la configuration du fonctionnement par défaut des Widgets lorsqu’ils seront insérés dans les squelettes. Ces réglages par défauts sont ensuite personnalisables au cas par cas lors de l’insertion. Chose importante à noter : les résultats affichés dans les widgets sont récupérés avec le compte de l’utilisateur Twitter par défaut qui a été ajouté auparavant. Les tweets que cet utilisateur ne peut pas voir (comptes bloqués par exemple) ne s’afficheront pas. Widget de recherche
  Il affiche les tweets qui correspondent à une recherche Twitter. Pour ajouter ce widget dans votre squelette vous pouvez utiliser le code : #INCLURE{fond=inclure/twidget_search} Widget de profil
  Il affiche tous les tweets d’un utilisateur Twitter Pour ajouter ce widget dans votre squelette vous pouvez utiliser le code : #INCLURE{fond=inclure/twidget_profile}

Tweeter un article

Il est possible d’éditer le message qui sera envoyé, article par article, ou de bloquer l’envoi du message pour un article donné. On peut également relancer a posteriori l’envoi du message. Lorsque vous visualisez le message avant publication de l’article, celui-ci incorpore une url vers la page d’édition de l’article. Si vous ne modifiez pas le message par défaut, l’url sera remplacée par l’url publique lors de la publication. Mais si vous modifiez le message, faites attention à bien donner une url publique de l’article, car le plugin ne touchera plus à votre message personalisé. Pour rétablir le message d’origine, il suffit d’effacer complètement votre message personnalisé, et d’enregistrer.

Tweeter n’importe quoi !

Le plugin propose aussi une interface pour envoyer un message immédiatement sur n’importe quel sujet. La page est accessible depuis le menu Publication > Twitter

Insérer les Widgets dans le site public

Widget de recherche
Pour ajouter le widget de recherche dans votre squelette insérez le code : #INCLURE{fond=inclure/twidget_search} Vous pouvez le personnaliser lors de l’insertion : #INCLURE{fond=inclure/twidget_search,search=#SPIP,width=200} Les variables personnalisables sont :

• search : terme(s) recherché(s)
• title : titre en clair de la recherche
• subject : sous titre de la recherche
• interval : intervalle de mise à jour en millisecondes
• width : largeur en px
• height : hauteur en px
• shell_background : couleur de background
• shell_color : couleur de police
• tweets_background : couleur de background
• tweets_color : couleur de police
• tweets_links : couleur des liens
• scrollbar : true/false
• loop : true/false
• live : true/false
• hashtags : true/false
• timestamp : true/false
• avatar : true/false
• toptweets : true/false Widget de profil
  Pour ajouter le widget de profil dans votre squelette insérez le code : #INCLURE{fond=inclure/twidget_profile} Vous pouvez le personnaliser : #INCLURE{fond=inclure/twidget_profile,user=spip,width=200,height=300} Les variables personnalisables sont :
• user : nom de l’utilisateur Twitter dont la timeline est affichée
• rpp : nombre de résultats affichés
• interval : intervalle de mise à jour en millisecondes
• width : largeur en px
• height : hauteur en px
• shell_background : couleur de background
• shell_color : couleur de police
• tweets_background : couleur de background
• tweets_color : couleur de police
• tweets_links : couleur des liens
• scrollbar : true/false
• loop : true/false
• live : true/false
• hashtags : true/false
• timestamp : true/false
• avatar : true/false

API tweet()

Ce plugin offre une fonction tweet() que l’on peut utiliser pour envoyer des micro-messages (status) sur Twitter [1]. La fonction s’utilise comme suit :

 include_spip('inc/twitter); tweet('Bonjour, monde');

Boucle (DATA){source twitter}

Si vous utilisez Twitter, le plugin permet [2] l’utilisation facile de l’API Twitter dans une boucle (DATA) pour afficher par exemple vos tweets, les tweets de votre timeline, les tweets résultats d’une recherche…. Pour ce faire, il suffit d’utiliser {source twitter,...} dans une boucle (DATA), en y précisant quelle méthode de l’API utiliser (toutes les méthodes GET de https://dev.twitter.com/docs/api/1.1 sont possibles) et les arguments sous forme de query-string. Par exemple :

• pour lister ses derniers tweets on écrira {source twitter,statuses/user_timeline} (qui utilise https://dev.twitter.com/docs/api/1.1/get/statuses/user_timeline)
• pour lister les tweets résultats de recherche sur « spip » on écrira {source twitter,search/tweets?q=spip} (qui utilise https://dev.twitter.com/docs/api/1.1/get/search/tweets) Dans un exemple complet, cela donne :

• http://contrib.spip.net/#VALEUR%7Buser/profile_image_url%7D" style="float:right ;" alt="profile_image_url"> from @#VALEURuser/screen_name (#VALEURuser/name) : « #VALEURtext »

[

(#PAGINATIONprecedent_suivant)

]

Attention, il faut bien avoir en tête que les requêtes sont faites à l’API Twitter en utilisant le compte Twitter associé au site, et donc seuls les tweets visibles par cet utilisateur seront listés dans tous les cas.

Flux RSS

Le plugin Twitter génère automatiquement un flux RSS des tweets du compte Twitter par défaut auquel il est associé. Ce flux RSS est disponible à l’adresse spip.php?page=twitter-backend de votre site (par sécurité, il ne répondra rien si le compte Twitter est protégé). Le squelette twitter-backend.html peut être pris comme modèle pour générer d’autres flux RSS pour d’autres utilisateurs.