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

  • Bonjour ! Bravo pour cette application. Je ne trouve cependant pas le moyen de désactiver l’édition lors du double clique sur un élément. Je souhaite seulement que le petit crayon s’affiche au survole de la souris, et que l’utilisateur clique dessus pour éditer l’élément. Est-ce possible ? Merci.

    Répondre à ce message

  • Testé avec succès sur un Spip 4.2.2 en ayant activé la compatibilité 4.1

    Répondre à ce message

  • Bonjour,
    J’utilise ce plugin sur une version 4.0 de SPIP et cela fonctionne très bien :)
    Le souci c’est que nous cherchons à mettre en oeuvre une CSP et que l’utilisation du plugin me contraint d’utiliser la directive ’unsafe-inline’ dans script-src, ce qui n’est pas l’idéal... Y a-t-il une solution pour continuer à permettre à mes utilisateurs d’éditer leurs contenus depuis le front sans passer par l’espace privé, tout en garantissant un bon niveau de sécurité pour mon site ?
    Merci d’avance pour votre aide !

    Répondre à ce message

  • Bonjour,

    J’aimerai personaliser un champs cree par le plugin, en lui ajoutant un attribut specifique. Pour ce faire, je comptais utiliser le pipeline « crayons_determine_input_mode_type_ » et retourner un tableau.

    J’ai determine comment faire cela en lisant attentivement le code. Malheureusement, une ligne plus loin dans le code m’empeche de faire cela avec la limitation suivante (dans crayons_html.php, ligne 200) :

    $user_inmode = $f($type, $champ, $sqltype);
    if (in_array($user_inmode, ['ligne', 'texte'])) {
    	$inmode = $user_inmode;
    }

    Donc bien que l’on ait un pipeline sophistique pour pouvoir personaliser nos inputs avec des attributs supplementaires, ce filtre ne nous permet que de choisir entre « ligne » et « texte ».

    Est-ce possible de laisser passer les tableaux, en plus de « ligne » et « texte » ?

    Répondre à ce message

  • Bonjour,

    J’ai une erreur javascript qui apparaît lorsque l’on effectue un appel AJAX dans la page.

    Est-ce que vous auriez une solution s’il vous plaît ?

    Merci

    Répondre à ce message

  • 1

    Bonjour,
    les crayons s’affichent sur les champs ayant un contenu, et c’est magique, merci !
    Y a-t-il un moyen de les activer également sur les champs (texte) vides ?

    • Bon, en fait il suffit que la balise appelante s’affiche en ayant du contenu (par exemple un label) pour que le crayon se déclenche, même qi le champ était vide ; mon problème ne venait pas des crayons, désolé.

    Répondre à ce message

  • 7

    Bonjour,
    Il semble qu’il y ait un petit bug sous SPIP 3.1.1 avec la dernière version du plugin (1.25.0) : la barre typographique pour ne s’affiche pas lorsque cette option est cochée dans les paramètres du plugin...

    • Je ne reproduis pas le bug chez moi, une erreur javascript dans ta page ?

    • Bonsoir b_b,
      J’ai désactivé tous les javascripts « 6. Vos scripts » dans le head, désactivé tous les plugins, vidé le cache, désactivé le cache, et je confirme (pour ma part) l’impossibilité d’afficher la barre typographique. Si tu as des recommandations de tests plus avant, je prends...

    • Bonjour b_b,
      Tu avais raison au sujet du JavaScript : dans squelettes, j’avais créé le dossier « js » dans lequel j’avais jquery-1.12.0.min.js
      C’est ce javascript qui entravait le bon fonctionnement de Crayons...

    • Cool, content que tu aies trouvé la solution ;)

    • grâce à toi ;-) merci encore !

    • Bonjour b_b,
      Je reviens sur ce sujet... quand on se sert de SPIP comme d’un framework, on a parfois besoin de conserver un JQuery dans le squelette. C’est alors que la barre typographique dans l’espace public ne s’affiche plus.
      Elle est pourtant bien pratique ! Une idée de résolution ?

    • Je suis dans le même cas que beno et pour les mêmes raisons. Mais c’est embêtant…

    Répondre à ce message

  • 1
    scremfx

    bonjour
    je utilise le plugin crayon pour modifier des articles en publique mais en me connectant avec mon compte utilisateur
    est ce possible d’utiliser le crayon sans être connecter de laissé des visiteurs modifier les contenus ?
    merci

    Répondre à ce message

  • 1
    b.poiraud

    Bonjour, j’utilise Crayons depuis très longtemps et notamment la possibilité de corriger directement sur la page publique du site internet. Mais cela ne fonctionne plus du tout. Je suis en spip 3.1.6 [23598] et j’ai mis la dernière version de Crayons.

    La seule chose que je vois est : Activer la barre typographique dans les crayons ?
    Un autre plugin interdit l’usage du porte-plume dans l’espace public.

    mais cela ne semble pas avoir de rapport ? Pouvez-vous m’aider ? Merci

    • Bonjour, je ne suis pas sûr de bien répondre à la question, mais le message « Un autre plugin interdit l’usage du porte-plume dans l’espace public » apparaît quand dans « Fonctions avancées, Configurer les barres d’outils » on n’a pas coché la case « Charger les scripts de barre d’outils sur l’espace public ».

    Répondre à ce message

  • 1

    A propos de l’édition de métas / configurations de vos plugins il est possible d’utiliser la syntaxe :

    #EDIT{meta-prefixe/mavaleur}

    il est donc possible d’accéder a des valeur stockées dans des tableaux, comme le propose la balise #CONFIG.

    Merci SPIP ❤️

    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