Les crayons

Un plugin pour une édition directe sur le site public

Ce plugin permet d’éditer les contenus sur les pages publiques du site, sans passer par l’espace privé de SPIP.

Le paramétrage côté squelettes est des plus simples : il repose sur la classe #EDIT{...} adjointe aux éléments qu’on veut rendre modifiables.

Résumé

Après l’activation du plugin, les contenus peuvent être directement édités « en place » sur les pages publiques du site, par les personnes autorisées.

Cela demande de préparer vos squelettes pour les rendre compatibles avec ce plugin (à noter : c’est le cas de la plupart des squelettes distribués sur SPIP-Contrib). Le principe est simple : un bloc est éditable s’il contient la classe crayon objet-champ-id. Une balise #EDIT{} facilite encore l’écriture. En fait, pour permettre d’éditer le titre d’un article, il suffit de remplacer dans le squelette de la page article.html, la ligne (par exemple) :

<h1>#TITRE</h1>

par :

<h1 class="crayon article-titre-#ID_ARTICLE">#TITRE</h1>

ou encore, plus simplement :

<h1 class="#EDIT{titre}">#TITRE</h1>

Autre exemple, pour rendre « crayonnable » le texte d’un article, transformer :

[<div class="texte">(#TEXTE|image_reduire{520,0})</div>]

en :

[<div class="#EDIT{texte} texte">(#TEXTE|image_reduire{520,0})</div>]

Les pages concernées doivent obligatoirement comporter une balise </head>, écrit précisément de cette façon (lettres minuscules).

Fonctionnement

Fabrication de la page côté serveur

Lors du chargement d’une page, le plugin agit dans le pipeline affichage_final.

Il vérifie alors :

  • si l’utilisateur est identifié
  • si la page contient au moins une chaîne de caractères “crayon xxxx­-yyyy-nn”,
  • et si l’utilisateur possède des droits sur au moins un des éléments ainsi marqués

Le cas échéant, il insère dans le <head> de la page le script externe crayons.js ainsi que des données de configuration ; le script s’exécute à la fin du chargement de la page, et vérifie à intervalles réguliers si de nouveaux crayons sont disponibles, de façon à les activer en cas de besoin.


Chargement par le navigateur

Lorsque la page finit de se charger (et si le visiteur a des droits d’édition sur les crayons présents dans la page), le script crayons.js sélectionne tous les éléments possédant la classe crayon type­-champ-id, et si ils sont autorisés pour l’utilisateur inscrit, leur adjoint une image clicable (un crayon) et leur ajoute la classe crayon-autorise pour indiquer qu’ils sont « éditables ».

Un clic sur cette image, mais aussi un double-clic sur l’élément lui-même, provoquent l’activation du formulaire d’édition.


Activation du crayon

Un click sur le « crayon » (ou un double-clic sur l’élément) déclenche une requête vers le serveur, qui renvoie le formulaire de modification qui va « remplacer » l’élément affiché.

La requête spécifie au serveur le « type », le « champ » et l’« id » pour lesquels le formulaire est demandé.

Après vérification de l’existence des données et des droits sur celles-ci, le serveur renvoie le formulaire (sous forme de données javascript, au format JSON). Le type et les dimensions du champs sont déterminés d’après sa nature et la place réservée à l’élément. Il contient le source brut du texte, comme lorsque on édite depuis l’espace privé ; la police, la taille et la couleur des caractères sont préservées.

crayon.js associe ce formulaire à l’élément puis "cache" ce dernier.

L’utilisateur peut maintenant modifier les données.

Attention : l’affichage final ne peut être réalisé que par le serveur, un click en dehors de la zone d’entrée après des modifications affichera à nouveau le contenu originel.
Dans ce cas, une roue dentée vous signale que vous avez introduit une modification. Click sur le bouton ou double-click sur l’élément vous y ramène, elles ne sont pas perdues.
Si vous abandonnez cependant la page, un dernier rappel vous propose de sauvegarder.


Sauvegarde

Le formulaire possède une série de boutons/touches associées :

  • OK (ainsi que la touche Entrée [1]) permet de sauvegarder,
  • Annuler (ainsi que la touche Escape) abandonne toute mise à jour,
  • Un clic en dehors des zones de saisie cache ces zones et revient à l’affichage initial.

Il contient aussi des identificateurs et des clés associés aux données.

Le formulaire est soumis en POST par ajaxForm donc asynchrone. Sur réception, le serveur :

  • analyse les données soumises, leur cohérence et leur actualité (afin d’annuler l’envoi si les données ont été entre-temps modifiées par ailleurs).
  • vérifie une nouvelle fois les droits d’édition.
  • appelle les procédures internes de SPIP pour mettre à jour les données.
  • renvoie une vue des données modifiées, et déclenche les comportements javascript précisés par la fonction onAjaxLoad de SPIP.

Le système alimente notamment l’historique des modifications, de la même façon que l’espace privé.

Configuration

Le plugin propose plusieurs options, activables via le plugin CFG ; notamment :
-  un message si on confirme OK mais que rien n’est changé ;
-  une alerte permettant de sauvegarder les modifications si on abandonne la page alors qu’un texte est en cours d’édition ;
-  l’activation de la barre typographique ;
-  des couleurs permettant de mieux repérer les zones modifiables.

À noter : si le plugin est absent ou désactivé, la balise #EDIT{...} renvoie une chaîne vide ; cela permet donc de « crayonner » des squelettes même si l’on décide finalement de ne pas utiliser le plugin

Utilisation étendue

Toutes les tables standard de SPIP (articles, brèves, rubriques, etc.) sont gérées, y compris les forums et les signatures de pétition (mais, pour ces deux dernières, il faut utiliser le plugin Autorité pour permettre des modifications) ; pour chacune de ces tables, tous les champs de type « ligne » (titre, soustitre etc), ou « texte » (texte, chapo, descriptif...) sont crayonnables.

On peut également éditer les logos avec le crayon #EDIT{logo} ; un réglage permet de redimensionner ces logos à la volée lors de l’upload.

Les documents sont modifiables avec le crayon #EDIT{fichier} : le nouveau document vient remplacer l’ancien et sa taille, hauteur et largeur sont mises à jour. (NB : pas encore compatible documents distants).

Enfin, à partir de spip 2, on peut éditer les champs extra.

À noter :

  • Les crayons fonctionnent avec n’importe quelle table — à condition que cette table possède une clé primaire (numérique) qui s’appelle id_xxx, où le nom de la table est spip_xxxs.
  • pour la table spip_meta qui ne propose pas ce type d’index numérique, il faut utiliser la balise #EDIT d’une manière un peu différente en préfixant le champs à éditer par meta-, par exemple [2] :
    #EDIT{meta-descriptif_site}
    
  • pour éditer une valeur de configuration de plugin, on utilise la même syntaxe en ajoutant « meta » ; Par exemple pour éditer un champs de configuration adresse pour un plugin dont le préfixe est croque :
    [<div class="inner #EDIT{meta-croque/adresse}">(#CONFIG{croque/adresse})</div>]
    
  • Si un texte « crayonnable » est un champ MySQL MEDIUMTEXT ou plus long, les crayons affichent un TEXTAREA, et sinon, un INPUT.
  • Seuls les admins complets peuvent ainsi crayonner des textes provenant d’une table non-SPIP.

Editions simultanées de plusieurs champs

L’obtention du formulaire d’édition (« contrôleurs ») ainsi que la vue obtenue en retour sont surchargeables, par de simples squelettes (voir les exemples dans les répertoires controleurs/ et vues/ du plugin).

Ces formulaires peuvent travailler en parallèle sur plusieurs champs d’un enregistrement (article), voire plusieurs enregistrements d’une même table ou de tables différentes [3] : il y a là de quoi faire des interfaces d’édition spécialisées et très efficaces.

Comme toujours, contributrices et contributeurs sont bienvenus !

Notes

[1Ainsi que, sur Mac, la touche ctrl-S, et sur PC les touches alt-S ou F8, ou encore la combinaison MAJ-entrée.

[2Ceci est valable depuis la version 1.6.1 du plugin. Pour les versions précédentes la syntaxe est différente. Il faut insérer manuellement la class dans le code suivant la syntaxe meta-valeur-XXX où XXX représente le nom de la propriété à modifier. Par exemple pour modifier le nom du site (propriété : nom_site) on pourrait faire :

<h1 class="crayon meta-valeur-nom_site">#NOM_SITE_SPIP</h1>

[3Par exemple pour ouvrir en édition l’ensemble des champs descriptifs d’une adresse postale.

Debug : Les crayons ont un mode de débug activable en mettant dans mes_options.php la ligne suivante :

define('_DEBUG_CRAYONS', true);

Ce code ralentit un peu le fonctionnement, puisque le script est rechargé à chaque fois, mais facilite le repérage de bugs et le développement de nouvelles fonctionnalités.

Voir aussi : Doc complémentaire

Discussion

303 discussions

  • Hello,

    Pourrait-on rendre le plugin crayon compatible avec les logos d’évènements du plugin agenda en ajoutant ligne 18 du fichier « vues/logo.html » :

    |sinon{[(#ID_EVENEMENT|?{#LOGO_EVENEMENT_NORMAL})]}

    Cela permettrait au logo d’évènements d’apparaître lorsque l’on vient de le téléverser. Etant donné la fréquente utilisation du plugin agenda, ça serait vraiment pratique d’avoir cette fonctionnalité par défaut dans le plugin crayon .

    Répondre à ce message

  • Bonjour
    Comment désactiver l’effet Crayons sur les légendes d’images alors qu’il n’y a pas de #EDIT devant l’appel d’un champ (contenant des images légendées) ?
    J’ai ceci :

    <div style="display: inline-block">
    [(#PHOTO|antispam|image_reduire{400,x})&nbsp;]
    [(#LIEU|antispam|image_reduire{400,x})&nbsp;]
    </div>   

    et la div ne s’applique pas bien à cause de Crayons sur la légende.
    Merci

    Répondre à ce message

  • J’ai régulièrement un problème d’affichage suivant : Suivant le contexte, le champs input n’apparait pas, comme sur la photo en annexe.

    La syntaxe #EDIT est correctement mise en œuvre.

    Doit-on passer par un nouveau contrôleur ?

    FDM

    Répondre à ce message

  • 5

    Bonjour,

    dans la doc il est précisé « Si un texte « crayonnable » est un champ MySQL MEDIUMTEXT ou plus long, les crayons affichent un TEXTAREA, et sinon, un INPUT. »

    Dans une boucle AUTEURS, j’utilise Crayons sur le champ BIO (de type TEXT)

    <div class="#EDIT{bio}">#BIO</div>

    …mais à l’activation, j’ai toujours un input alors qu’il me semble que je devrais avoir un textarea ?

    Ais-je oublié qqc ?

    • On dirait bien qu’il s’agit d’un bug dans la fonction colonne_table(), qui renvoie chez moi « nocase » au lieu de « text » pour la valeur « type ».

      Du coup le test dans crayons_html ne marche pas.

      Tu es en SQLite ou MySQL ?

    • Bonjour Fil,

      je suis sur MySQL

    • Reuh,

      petite précision : MySQL v 5.5.42

      Par ailleurs (rien à voir avec mon post précédent), pour les champs Extras, il n’est plus nécessaire de mettre le suffixe « meta- » (testé avec SPIP 3.1.1 et Extras v. 3.7.1).

      cheers
      P

    • Malheureusement je ne vais pas avoir le temps de faire ce fix tout de suite, car ce n’est pas évident de savoir dans quelles conditions la fonction colonne_table() bug.

      Une solution à l’arrache est toujours possible en regardant ce que tu obtiens dans crayons_html à l’endroit que j’ai indiqué, et en rajoutant ce cas (chez moi ça indique « nocase », qui est clairement erroné, donc ce n’est pas la bonne manière de réparer).

    • Ok. Pas de soucis. Je regarde également de mon côté également et je te tiens au courant.

      Pour info, j’ai trouvé une solution un peu plus lourde à mettre en place mais qui marche bien : j’ai créé un contrôleur controleurs/auteur_bio.html où je force le textarea,…et zou.

      P

    Répondre à ce message

  • 5
    kristoff23

    Est-il possible d’envisager un fonctionnement du plugin crayon : édition d’article , modification de documents pour un visiteur NON CONNECTÉ ?

    • C’est déjà le cas, comme par exemple sur le « carnet de spip-contrib » ; c’est essentiellement une question d’autorisations.

    • une méthode simple pour gérer ces autorisations est d’utiliser Le plugin « Autorité »,

    • kristoff23

      Merci de t réponse mais je ne comprends pas ...

      Qu’entends-tu par autorisations , je n’ai rien vu de tel dans :
      Configuration —> Interactivité ...

    • kristoff23

      OK merci Maieul et Fil .

      je connais ce plugin et je vais essayer ...

    • kristoff23

      Génial : j’ai fait ça avec « autorité » : ça a l’air de marcher au poil , on va voir ce qu’en pensent les visiteurs ...

      Merci à vous deux ...

    Répondre à ce message

  • Bug sur les images gérées par une autre Bdd lors du recalcul après modification ?

    Lorsqu’un site A interroge une base de donnée "externe : ex un autre site SPIP appelons-le SPIP B)et affiche le contenu d’un article venant de B, les crayons marchent bien, pas de souci, mais, lors du « recalcul » qui est fait lorsqu’on valide une modification, ce ne sont pas les bonnes images qui apparaissent :
    Ex : l’article du site B contient <imgxx>, le recalcul des crayons va chercher le document local (=du site A) d’id = xx et non pas le document id = xx dus site B. Un recalcul « général » (via le bouton d’admin) rétablit les choses mais, bon, c’est un peu perturbant au départ

    Répondre à ce message

  • Bonjour,
    juste pour signaler qu’il semble que sous SPIP 3.1, Crayons n’affiche plus la barre typo.

    Répondre à ce message

  • Bonjour,

    Dans le même genre que Bruno, je viens de m’arracher les cheveux plusieurs jours à cause des boutons « annulation » et « enregistrement » qui étaient devenus inopérants sur le plugin. (sous Spip 3.0 et 3.1). J’ai désactivé tous les plugins, cela ne venait pas de cela.

    Il s’agissait en fait de l’appel Dojo fait dans le HEAD qui perturbait complètement le comportement des boutons de Crayons. J’ai essayé de déplacer l’appel Dojo, mais rien n’y fait : s’il y a appel Dojo, Crayons cesse de fonctionner.

    <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/dojo/1.10.4/dojo/dojo.js"></script>

    Est-ce normal ?
    Y a-t-il une solution ?

    Répondre à ce message

  • 13

    Dernière mise à jour 1.25 : la cata !

    J’ai eu la mauvaise idée de lancer la maj vers la 1.25.

    Je suis en mutualisé et tous mes sites ont planté. Cela m’a pris plusieurs heures pour tout faire repartir.
    Pire, le crayon ne fonctionne plus : j’ai bien le textarea d’édition, mais quand je sauvegarde, j’obtiens une « erreur de communication ».

    Est-ce un problème connu de cette version ?
    D’autres rencontrent-ils la même difficulté ?

    • Plus de précisions :
      Le CRAYON fonctionne sur certains champs, par exemple, c’est OK avec descriptif_site.

      Avec certains autres chamsp, j’arrive à obtenir une boite d’édition, mais j’ai une « erreur de communication » sur enregistrer.
      Exemple : titre d’article.

      Et sur d’autres champs, j’ai une « erreur de communication : unexpected token » dés que je clique sur le crayon. Je n’ai même pas de boite d’édition.
      exemple : article intro

      Et le CRAYON fonctionne totalement sur quelques rares sites.

      Je suspecte un conflit avec un autre plugin.

    • En comparant les plugins installés sur les sites sur lesquels le CRAYON fonctionne, et ceux sur lesquels le CRAYON plante, et en désactivant progressivement, j’ai trouvé le plugin fautif.
      Il s’agit d’une version modifiée de SPIPDF.
      Le truc bizarre, c’est que SPIPDF n’a, en théorie, aucun effet sur le code généré en partie public.

      Bon j’ai une piste...

    • Finalement, il y a un gros problème avec cette 1.25

      Maintenant, cela plante dans l’espace privé. La plupart des liens tel que « Ajouter auteur » sont inopérants.
      Quand j’édite, j’ai bien la boite d’édition mais impossible d’éditer quoi que ce soit.

      et cela même en désactivant SPIPDF.

    • Bon je galère trop avec cette 1.25.

      Comment puis-je récupérer une ancienne version ?

    • c’est étonnant : je n’ai aucun souci avec cette version du plugin. Il fonctionne bien côté public comme côté privé.

      Je me demande si tu n’aurais pas des soucis de js emmelé. Essaie voir en vidant le fichier local/cache-js puis en recalculant la page.

    • Bonsoir Maïeul

      Je suspecte aussi un bug de JS. Peut-être avec JQUERY ?

      J’ai supprimé local/cache-js, puis recalculer la page => Pas mieux.

    • bizarre. bon il faudrait vérifier sur une install sans aucun autre plugin...

    • C’est clair qu’il s’agit d’un conflit avec un ou plusieurs plugins.

      Je pensais avoir trouvé que cela venait de SPIPDF. Mais non, ce matin, j’avais le souk dans l’espace privé alors que SPIPDF était désactivé.

    • Juste pour confirmer : Je n’ai pas de soucis non plus, je viens juste de le mettre a jour sur un site qui est en production, je n’ai pas eut de retour de la part des rédacteur (sur ce sujet ^^).

      Sinon en local (mode serveur, pas mamp), mes sites sont mutualisés, et je ne rencontre pas de problèmes non plus, avec Crayons.

      Voila ça résoud rien, mais ça oriente vers la ou chercher... bon courrage

    • C’est vraiment très très bizarre.

      Je n’arrive pas à cerner avec quel plugin CRAYON rentre en conflit.
      Je désactive un plugin lambda, le problème disparait sur le site A.
      Je vais sur le site B, je désactive lambda, mais le problème persiste. Et c’est la désactivation du plugin beta qui résout l’anomalie.

      Parfois, le bug a disparu, puis il revient peu après.

    • effectivement c’est bizarre, y’a pas un cache serveur ?ça viens pas de spip ou crayon pour le coup, la je pencherais plutot pour quelquechose dans ce genre : un module apache ou autre qui compress les js, ... voir ce qu’il y’a dans le .htaccess ou dans la config apache …

      c’est un serveur dédié, une virtualisation ?

    • et bien les amis, j’ai passé mes dernières heures dans la 4e dimension. %-)

      Mais j’ai trouvé d’où venait le bug :
      il s’agissait d’un problème d’encodage sur un seul fichier d’un plugin perso : xxx_fonctions.php qui était encodé UTF-8 avec BOM. C’est quoi ça, BOM ?
      Je l’ai encodé en UTF-8 sans BOM, et plus de problème. :-))

      Pour info, j’ai ré-essayé une ancienne version de CRAYON et le problème persistait.
      Donc cela n’est pas la 1.25 qui était en cause, ni sa mise à jour qui a révélé un problème dans mes autres plugins.
      Je ne sais pas pourquoi c’est apparu subitement ?

      C’est quand même bizarre, non ?

      En tous cas, MERCI pour votre aide.

    • bom, bom quand votre moteur fait bom.

      plus sérieusement le caractère bom est un caractère qui dit si on doit lire les octets unicode de gauche à droite ou de droite à gauche. Mais normalement en utf8 on n’a pas besoin de cela, car utf8 est neutre sur cette question (utf16, utf32 ne le sont pas). Cependant si on met une information bom dans un fichier utf8 il peut être mal interprété -> et paf tout cela fait planter le zbin.

      Voir https://fr.wikipedia.org/wiki/Indicateur_d%27ordre_des_octets

    Répondre à ce message

  • 1

    Bonjour,
    J’utilise ce plugin depuis longtemps, et je le trouve très utile.
    Cependant, je n’arrive pas à l’installer chez SFR, il provoque une erreur 500, aussi bien avec une version des crayons du début de cette année que de la version de dec 2015.
    En local avec le même spip 3.021 et le même squelettes, tout fonctionne parfaitement.
    Il semble donc que le serveur soit en cause.
    Existe t il une manière de l’obliger à prendre les crayons en compte ?
    Merci en tout cas, il m’est bien utile sur d’autres sites.
    Bonne journée.

    • Bonjour,
      un petit complément d’info, même résultat aujourd’hui, et aprés avoir supprimé les crayons, le message suivant s’affiche en page d’accueil de la partie privée :

      Erreur dans les plugins : /var/www/xxxxxxxx.perso.neuf.fr/public_html/plugins/crayons/crayons_fonctions.php

      Si quelqu’un a une idée.
      Bonne année 2016

    Répondre à ce message

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom