Les plugins de SPIP Rencontres Eklesia.net à Lyon 9 au 11 novembre 2008 Philippe Giron Diocèse de Saint-Brieuc et Tréguier
Objectifs de cet atelier Savoir ce qu’est un plugin Installer un plugin Utiliser quelques plugins pour apporter de nouvelles fonctionnalités à ses sites Repartir avec quelques trucs utiles… dont la présentation éventuellement sur votre clé USB.
Avertissement Pré requis La version de SPIP Connaître le fonctionnement global de SPIP ! La version de SPIP La version actuelle de SPIP est la 1.9.2-e, le fonctionnement des plugins sera peut-être un différent avec la prochaine version, mais la plupart sont prévus pour fonctionner avec SPIP 2. Ce qui est souhaité « in fine » Ne pas avoir peur de les utiliser ! L’ébauche d’un échange entre « SPIPistes » utilisateurs de plugins pour avancer ensemble, sur les listes ou ailleurs.
Sommaire Introduction Les « plugins » Conclusion Généralités sur les plugins Le plugin CFG de configuration Les raccourcis typographiques Barre Typo V2 pour 1.9.2 et suivantes Enluminures typographiques pour 1.9.2 et suivantes Barre typographique généralisée Le Couteau Suisse Gestion des guillemets Le format des URL Le cryptage des courriel Conclusion
Introduction Le plugin… Contexte d’utilisation de SPIP Quelques principes de développement appliqués au site du diocèse
Contexte du site diocésain Site du diocèse catholique de Saint-Brieuc et Tréguier http://catholique-saint-brieuc.cef.fr/ depuis 1999. Cohérence graphique depuis le début. 1999-2003 : site HTML « en dur » 2003-2006 : CMS propriétaire Interface rigide et limitée, quoique agréable. Évolutions bloquées car… payantes ! Depuis décembre 2006 Passage à SPIP : choix bien accepté. Nouveaux rédacteurs et responsables de rubriques. Fréquentation multipliée par 3, en progression. Formations diocésaines : une trentaine de rédacteurs SPIP par an.
Quelques principes de développement appliqués au site Pérennité technique Utiliser les outils SPIP existants (si possibles stables) Limiter le javascript, pas de Flash. Ne pas ajouter de modules PHP propriétaires. Confiance et délégation Déléguer le plus possible au moins un administrateur restreint par mouvement, paroisse, service, communauté. Comité Internet Réunion (ouverte) en début et fin d’année Liste de discussion et courriel le reste du temps. Formation et responsabilité Formation : rédacteur 1 et 2, administrateur, images… Information : listes, accès réservé…
Les « Plugins » Comment ajouter de façon simple des fonctions supplémentaires presque à la demande
C’est quoi un « plugin » ? Permet d’ajouter des fonctionnalités dans SPIP Nouveauté de SPIP depuis la version 1.9 On parle aussi de greffon… Permet d’éviter l’hypertrophie du noyau de SPIP Vient de l’anglais « to plug », brancher, facile à brancher et… débrancher ! Développé par qui le souhaite Procédure de développement à suivre : http://www.spip.net/fr_article3448.html
Documentation sur les plugins La documentation officielle sur le site de SPIP Installer un plugin http://www.spip.net/fr_article3396.html Le site SPIP-Contribs http://www.spip-contrib.net/ Le site des plugins de SPIP http://plugins.spip.net/ Récupérer les plugins dans SPIP-Zone http://files.spip.org/spip-zone/ Aide à la création de plugins http://www.plugandspip.com/
Récupérer les plugins Être administrateur complet Récupérer le plugin sur son PC À partir de SPIP-Contrib, SPIP-Zone Avec FTP S’il n’existe pas, créer un répertoire /plugins sous la racine. Y copier les plugins choisis et dézippés avec leur répertoire.
Copie les plugins Copie à partir du PC Répertoire /plugins du site SPIP
Installation des plugins Les plugins copiés apparaissent au départ non cochés. Une nouvelle icône dans la configuration due à la présence du répertoire /plugins Cocher seulement les plugins à utiliser, puis valider
État des plugins À l’installation, on voit l’état des plugins : se méfier s’ils ne sont pas « verts » ou « orange ! Rappel : seuls ceux qui sont cochés sont utilisés Icônes d’état des plugins
Aide sur les plugins On clique sur le nom : le plugin se déplie ! Logo du plugin Version, état, répertoire Petit texte d’aide Auteur, année, licence Documentation en ligne, souvent sur SPIP-Contrib
Quelques plugins présentés ici Le plugin CFG, moteur de configuration Les Raccourcis Typographiques La barre typographique Barre Typo V2 pour 1.9.2 et suivantes Les enluminures Enluminures typographiques pour 1.9.2 et suivantes La barre typographique généralisée Le couteau suisse Gestion des guillemets Format des URL Cryptage des courriels
Le plugin CFG, moteur de configuration Rien à configurer !
À quoi il sert ? Ce plugin CFG permet de gérer très simplement des interfaces de configuration pour différents modules. Il est utilisé par de nombreux plugins, mais il peut aussi avoir d’autres usages comme le paramétrage de squelettes. Nous nous limiterons ici à la configuration de plugins.
Installation Il suffit de l’installer comme indiqué précédemment. Une fois installé, une icône apparaît dans l’interface privée qui donne la liste des modules que l’on peut configurer avec CFG.
Ces plugins sont installés et configurables avec CFG Écran de CFG Ces plugins sont installés et configurables avec CFG
Les raccourcis typographiques Pour agrémenter et enjoliver son texte…
Les Raccourcis Typographiques Ajoutent au texte un jeu de raccourcis typographiques supplémentaires Composés de trois modules: Barre typo v2 Enluminures typographiques v2 Barre typo généralisée Peuvent s’écrire : soit en cliquant sur un bouton, soit à la main Très appréciés des rédacteurs !
La barre standard Gras Italique Un seul niveau d’intertitre (titre de paragraphe) Notes de bas de page Liens hypertextes Caractères spéciaux Guillemets (2 niveaux) À, É accentués Œ, œ Euro
Ajouts par rapport à la barre standard Les raccourcis typographiques par défaut La barre typo v2 Les enluminures typographiques v2
Les ajouts des 2 autres barres Texte Centrage, cadrage à droite du texte Exposants, petites capitales, texte barré Surlignage de texte (2 couleurs) Formatages spéciaux Citations, insertion de code, cadre, « poésie » 4 niveaux supplémentaires d’intertitres Gestion de tableaux, des ancres internes Glossaire Wikipédia Chercher / remplacer Accès au couteau suisse (s’il est présent) …
Codes des principaux raccourcis Paragraphes : Sous-titres : {n{Texte du titre}n} , n variant de 2 à 5, la barre de raccourcis ne proposant que 2 et 3 Centrer : [|Paragraphe centré|] Aligner à droite : [/Paragraphe aligné à droite/] Encadrer : [( Paragraphe à encadrer)] Texte : Mise en évidence : [*texte en évidence*] Mise en évidence (variante) : [**texte en évidence (autre couleur)*] Mise en exposant : <sup>texte en exposant</sup> Petites capitales : <sc> texte en petite capitales</sc> Biffé : <del>texte biffé</del> Bulle d’aide : [GPL|Gnu Public Licence] Et aussi sur les entrées de glossaire [?GPL|Gnu Public Licence] Lien avec bulle d’aide [texte du lien|Le site officiel de SPIP-> http://www.spip.net/] Ancre et retour à l’ancre [definition_ancre<-] et [retour à l’ancre-> #definition_ancre]
Quelques autres raccourcis Gestion des tableaux La création et la modification des tableaux est devenue très simple. On peut fusionner des cellules. Gestion des documents On peut gérer plus globalement les documents des articles, rubriques… Chercher / Remplacer On peut chercher/remplacer du texte dans le texte de la page.
Un exemple très utile : la gestion des tableaux La première ligne regroupe les entêtes Titre du tableau Bouton Tableaux Fusion de deux cellules de deux ligne (existe aussi pour les colonnes) Ajout d’une colonne ou d’une ligne Suppression d’une colonne ou d’une ligne
Documentation de la barre typo Cliquer sur le nom pour dérouler l’aide sur le plugin Nom du plugin, état et répertoire d’installation dans le répertoire /plugins Documentation du plugin
Documentation des enluminures On retrouve les éléments communs aux autres plugins plus la documentations pécifique
Installation et configuration Copier le plugin et le valider dans la fenêtre « Gestion des plugins » Cliquer sur l’icône CFG (dans la fenêtre Configuration) Les plugins installés et configurables avec CGF apparaissent :
Configuration Barre typo « Oui, envoyez la sauce ! » : affiche les formatages spéciaux (cadre, insertion de code…) : ça ne vaut pas le coup de s’en priver ! Le bouton OK est sous le texte…
Configuration enluminures typos Permet de Remplacer les puces Améliorer les titres Insérer les feuilles de style de façon automatique Un peu plus délicat mais on n’y touche plus une fois que c’est fait ! Configuration : Traitement des puces : « Remplacement » Titraille Mettre h2 pour {{{…}}} Insertion automatique « Insertion automatique »
Vue de la fenêtre de configuration
La barre typo généralisée Elle permet d’étendre l’ensemble des raccourcis typographiques à d’autres fenêtres que le texte : Descriptif des articles Chapeau des articles Post-scriptum des articles Texte explicatif des rubriques Présentation des auteurs …
Aspect barre typo généralisée La barre de raccourcis n’est plus limitée au seul texte
Configuration barre typo généralisée
L’essayer c’est l’adopter Le couteau suisse L’essayer c’est l’adopter
Qu’est-ce que le couteau suisse ? Ce plugin propose d’introduire facilement de simples fonctionnalités supplémentaires à SPIP et qui s’avèrent rapidement indispensables. Par exemple : des filtres supplémentaires, des balises pratiques, des facilités typographiques, le contrôle de certaines variables « cachées », etc.
Particularités Bien que stable, compatible avec SPIP 1.9x et prêt pour SPIP 2.0, il reste encore des évolutions à venir. La nouvelle interface de configuration ainsi que quelques outils du plugin requièrent la librairie jQuery. Cette librairie de fonctions Javascript a été complètement intégrée dans SPIP à partir de la version 1.9.2. Il s’installe comme n’importe quel autre plugin.
Affichage de la page du couteau
Listes des outils Couteau suisse 1.7.20.04
Documentation Dans la colonne de gauche une liste des liens (actifs) de la documentation en ligne.
Choix des outils à installer Permute les outils en gras Dans la colonne de gauche cliquer sur la lame (l’outil) que l’on veut ouvrir. On désinstalle de la même façon. Réinitialise la sélection Outil(s) à ouvrir
Configuration de l’outil Rouge : outil non activé Vert : outil activé Boutons d’activation En bas de la page s’ouvre la fenêtre de configuration de l’outil
Exemple 1 : gestion des guillemets Guillemets typographiques Remplace les guillements ‘’…’’ par « … » pour le 1er niveau et ‘’…’’ au 2ème niveau (imbrication de guillemets)
Exemple 2 : format des URL Comment remplacer spip.php?article4 par mon_titre ou mon_titre.html ? Attention à bien renommer htaccess.txt en .htaccess sous la racine. Les objets sont identifiés
Exemple 3 : cryptage des courriels Mailscript Code les adresses de courriel en clair TITLE codé Action par onclick et script Masquage du @
Quelques explications Les mailto et autres @ sont convertis, l’arobase est affiché sous forme de dessin. Si javascript est activé, Jquery remplace l’arobase dessin par un « vrai » arobase. Lorsque le visiteur clique sur le lien, c’est le script lancerlien qui est exécuté et reconstitue le lien. Pas mal d’explications dans http://www.spip-contrib.net/Les-liens-hypertexte
Quelques autres exemples Bouton « Visiter » Remplace l’image du bouton standard « Visiter » (en haut à droite sur cette page) par le logo du site, s’il existe. Site en travaux Permet d’afficher un message personnalisable pendant une phase de maintenance sur tout le site public. Visiteurs connectés Permet de voir le nombre de visiteurs connectés (nécessite de rajouter une ligne de code)
Des choses simples pour une utilisation simple Conclusion Des choses simples pour une utilisation simple
Synthèse rapide Il y a beaucoup de fonctions peu connues, donc peu utilisées. Le développement des plugins permettent de choisir des fonctions intéressantes. Attention à la compatibilité des plugins ! On peut éventuellement avoir des incompatibilités. Ne pas hésiter à utiliser l’aide en ligne. Le Forum : SPIP-Forum http://forum.spip.org/ La liste : SPIP-Users http://listes.rezo.net/mailman/listinfo/spip Le site : SPIP-Contrib http://www.spip-contrib.net/ Et bien sur les listes d’Eklesia.net !
Le mot de la fin Allez parmi tous les sites et faites-y des disciples… (D’après Mt 19, 1 Traduction : Bayard, La Bible Nouvelle Traduction)