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

  • 2

    Bonjour,

    j’ai les crayons en version 1.16.6 et ceux-ci ne fonctionnent pas : j’ai l’erreur javascript suivante (avec Firebug en mode console javascript)

    SyntaxError: missing ) after argument list
    http://www.parcsaintpaul.fr/spip.php?page=crayons.js&callback=startCrayons
    Line 4617
    
    iframeDoc.write("<!doctype><html><body><script type="text/javascript">

    Il semble effectivement qu’il y ait un problème de guillemet ...

    • (re)-Bonjour,

      après vérfication, c’est le plugin switcher (toujours en test...) qui créait un conflit !

      Après désactivation du plugin switcher et vidage du cache du navigateur, les crayons sont de retour !

      Youpi !

    • Christophe Noisette

      Suite à la lecture patiente et méthodique de ce forum, j’ai trouvé la réponse à ma question...
      Chez moi aussi le crayon n’apparaissait pas... et sur une contrib’, quelqu’un a parlé d’une vérif via la dist... Or comme le crayon n’apparaissait pas sur la dist... j’ai compris que le problème ne venait pas de ma programmation, mais du contexte général de mon site (jquery ou autres)...
      Et là... en lisant cette réponse, comme j’avais aussi switcher qui était installé, je me suis dit : « testons sans ce plugin », et youpi, le crayon est revenu.
      Version utilisée :
      Spip : 3.0.20
      Crayon : 1.21.0
      Switcher : 0.2.4

      Merci aux contributeurs, à toute cette belle communauté de spipien-ne-s
      Amitiés
      Christophe

    Répondre à ce message

  • 1

    Bonjour !
    Je tente de faire s’appliquer le plugin « crayon » à un élément html « a », il s’applique bien, seulement, lorsque je veux cliquer sur le « crayon » ça redirige sur le lien cible du tag « a » ... Impossible donc de changer le contenu de cette balise car la page change.

    Je me demandais si il y avait une solution quelconque ? Je ne trouve rien correspondant à ma question en ligne :)
    Merci !

    Répondre à ce message

  • Salut à tous

    Je plussoi ! :-)
    Permettre de désactiver le double clic dans la config ? Ou le désactiver pour les utilisateurs de tablettes et téléphone en tout genre ?

    Merci en tout cas !

    Répondre à ce message

  • Bonjour,

    Je cherchais à surcharger les images (et notamment les icônes de modification visibles sur le site public), mais ça ne fonctionne pas correctement (semble-t-il), et il faut écraser les fichiers directement dans le plugin... pourtant ce serait bien, surtout quand le site public a pour fond de texte une couleur bleu ;-)

    Répondre à ce message

  • 4

    Petit bug : quand on édite un titre qui est affecté d’un numéro (type « 01. TITRE DE L’ARTICLE »), le numéro de l’article s’affiche après la sauvegarde de la correction faite par le champ crayons.

    • Oui on peut plutôt appeler ça dysfonctionnement, comme le dit RealET juste un Cancel et ça repart. J’ai cherché un moment aussi pour savoir d’où ça venait sur mon petit blog.
      J’ai pas trouvé où l’on doit répertorier tous les petites choses avec des fonctionnements bizarres ... pour la version 1.6.2 pour la prochaine version de mon site

    • Bonjour Mbro,
      Merci pour ta réponse, pour autant si ce dysfonctionnement est un peu dérangeant, il n’est pas grave... avec un peu de patience, il disparaitra certainement prochainement ;-)

    • Ce n’est pas un dysfonctionnement, c’est voulu : ça donne un retour qui permet de bien visualiser ce qu’on en envoyé au serveur. Seul l’utilisateurice du crayon a ce feedback visuel, car dès que la page est calculée de manière normale, les filtres s’appliquent, et si le filtre supprimer_numero est présent (c’est vrai par défaut), il s’applique aussi.

    • Bon, alors tout est normal... il faut juste savoir que c’est normal ;-)

    Répondre à ce message

  • 1

    Hello,
    je viens de relever un comportement inattendu dans un cas particulier, avec une boucle CONDITION entre la boucle sur l’objet et le champ à crayonner.

    <BOUCLE_article1(ARTICLES){id_article}>
    <BOUCLE_test(CONDITION){si #TITRE=="^00\."}>
    <div class="#EDIT{titre}">#TITRE</div>
    </BOUCLE_test>
    </BOUCLE_article1>

    Le squelette génère une erreur « Pas de clé primaire ! » sur la boucle _test.
    J’imagine que c’est une dû à une perte d’une partie du contexte (id_article), mais le message d’erreur n’est pas très explicite.

    Dans ce cas il faut utiliser la syntaxe complète :

    <div class="crayon article-titre-#ID_ARTICLE">#TITRE</div>
    • Comme tu l’as compris le crayon s’applique à la boucle qui est immédiatement là, donc ce n’est pas une boucle d’objet et ça zappe. Ta solution est pas mal, une autre pourrait être d’appeler #_article1:EDIT{titre} (à tester).

    Répondre à ce message

  • 1

    Crayon sur champ #STATUT n’affiche pas de champ de formulaire, juste cancel et OK

    • À la lecture du code du plugin, c’est normal : il y a un contrôleur spécial pour les statuts, mais écrit pour SPIP<3 : il ne prend en compte que les articles.
      Or, moi, j’ai eu le problème sur un autre objet qu’articles.

    Répondre à ce message

  • Jaseurboreal

    Bonjour,

    Le rédacteur d’un article publié, me signale qu’en partie publique le crayon ne lui est pas apparent, et qu’il ne peut donc pas modifier son article.

    Dans quel endroit faut-il chercher la solution ?

    Merci de votre réponse.

    Répondre à ce message

  • La mise-à-jour du plugin 90287 n’est pas sur la zone ? :-)

    Répondre à ce message

  • Bonjour,
    Je cherche à installer le plugin ’’crayons’’ - que j’utilise déjà sur de nombreux sites (très pratique !) mais cette fois le fichier jquery.js ne se télécharge qu’à moitié sur le site distant. J’ai fait de nombreux essais. Je suis en version 3.0.19 installée il y a quelques jours. Une incompatibilité ?

    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