[spip-dev] fonctionnalité éventuelle ?

Bonjour,

Dans le cours du suivi du développement d'un site spip par ses contributeurs, il m'arrive de butter sur l'impossibilité d'écrire des commentaires dans les contenus rédactionnels mêmes des articles.

En effet si #REM permet de documenter le cours du codage des squelettes, il n'existe pas à ma connaissance en dehors du classique <!-- --> des commentaires html de raccourci qui permettrait d'insérer des contenus non visibles dans un article à vocation d'exemple interne.

Dans l'idéal d'autre part toute expression <!-- --> n'étant pas visible dans la partie privée si l'utilisateur n'entre pas dans le formulaire de modification, si jamais l'idée d'introduire un raccourci de "commentaires aux éditeurs" était développée pour spip, il faudrait que ceux-ci soient à la fois visuellement différenciés par rapport aux autres contenus dans l'interface privée, et bien entendu absolument invisibles dans les parties publiques...

Une telle fonctionnalité a-t-elle déjà fait l'objet de demande voire d'étude parmi les développeuses et développeurs de spip ?
Intéresserait-elle d'autres personnes ?

Pour ma part elle me semblerait utile par exemple quand on fournit des tableaux types ou d'autres expressions devant servir de modèle dans des contenus qui puissent se reprendre, voire pourrait très bien également constituer une autre forme d'indication interne pour les débutants, notamment en s'utilisant comme support d'explication directe incrits directement dans les champs actuellement vides par défaut des différents formulaires...

à vous de dire si l'idée vaut la peine...moi j'aimerais bien voir ça un jour dans spip...

Bonne continuation.

Philippe

Cette fonctionnalité me serait utile.
L’utilisation de CSS permet de l’obtenir la fonctionnalité mais cela m’apparaît comme un palliatif au raccourci proposé.

A suivre ?

Bien à vous : JPG

"commentaires aux éditeurs"

(...)

Intéresserait-elle d'autres personnes ?

Ce serait utile pour moi - surtout pour alerter les traducteurs aux phrases/paragraphes qui
- ne doivent pas être traduites, ou
- qui doivent être traduites mais en adaptant le contenu pour leur langue/pays.

Paolo

Bonjour,

Dans le cours du suivi du développement d'un site spip par ses contributeurs, il m'arrive de butter sur l'impossibilité
d'écrire des commentaires dans les contenus rédactionnels mêmes des articles.

Je n'ai pas compris ton besoin au juste mais peut etre pour info connais tu le plugin de relecture, actuellement développé par Eric ? Il permet apparament plein de choses autour du commentaire et de la mise au point d'articles. Mais il est encore à l'état de développement. cf zone.spip.org/trac/spip-zone/browser/_plugins_/relecture

JLuc

La doc http://blog.smellup.net/spip.php?article53
mentionne notamment
"une interface d’insertion de commentaire en un point précis du texte de l’article. Le texte du commentaire est affiché en regard du point d’insertion et repère son auteur par son nom et sa date de création."

JL

Bonjour,

Une idée toute bête qui m'est venue hier c'est qu'il serait peut-être le plus simple de permettre une interprêtation particulière des simples commentaire html <!-- --> quand ils sont interprêtés dans le corps des contenus dans l'interface privée. Je verrais bien du texte en vert. Il suffirait éventuellement d'y ajouter un chtit bouton "transformer en commentaire éditorial" pour compléter le confort d'utilisation - mais serait-ce vraiment utile ?

L'ennui de cette solution serait cependant de contraindre spip à calculer les-dits commentaires alors qu'ils sont inutiles en partie publique, évidemment. Celà dit s'agissant de contenus destinés à servir de modèles aux rédacteurs, un tel inconvénient aurait peu de chance d'impacter de façon trop conséquente...

@+

Philippe

Une solution simple et bidouille comme on les aime :slight_smile:

Soit un modèle déposé dans squelettes/modeles/commentaire.html :

[(#REM|test_espace_prive|oui)
#ENV{texte}]

Bonjour,
il est aussi bien compréhensible de faire un article dédié aux exemples de rédaction, mais qui ne sera pas publié. Et ce n’est que reprendre l’aide en ligne, finalement, qui existe déjà… mais je comprends qu’on ait besoin de la personnaliser

comme on les adore…

Pour documenter les règles éditoriales d’un site web, il y a déjà http://www.spip-contrib.net/Manuel-de-redaction-du-site
Par contre, les commentaires ont tout leur sens quand on fournit des modèles d’articles, via le plugin Gabarits par exemple (http://www.spip-contrib.net/Gabarits)

Que pourrais donc faire un petit plugin pour gérer les commentaires (reste à trouver le bon nom car le terme commentaires peut correspondre à plusieurs choses).
Supposons deux cas de figures implémentées dans un petit plugin pour bien afficher les commentaires. Et vérifions ce qui se passe si on le désactive.

Cas 1 : commentaire de la forme

On utilise simplement la syntaxe HTML classique. Au moins ce n’est pas quelque chose de nouveau pour les rédacteurs connaissant le HTML. Ce qu’implémenterait le petit plugin commentaire :

  • un bouton dans le porte-plume pour passer un texte en commentaire

  • une fonction via le pipeline pre_prope qui teste si on est ou non dans l’espace privé. Si oui, on recherche les , on transforme < en < et > en > et on encadre le tout avec un pour bien afficher les commentaires dans l’espace privé. Si on est côté public, on peut éventuellement supprimer carrément les commentaires, car ils n’ont pas vraiment vocation à être dans le source de la page HTML finale.
    Si on désactive le plugin :

  • les commentaires ne sont plus visibles dans les pages du privé mais restent présent dans le source de l’article

  • côté public ils sont dans le source HTML mais bien en tant que commentaires et donc non affichés

Gros avantage : pas de dépendance au plugin. S’il n’est plus là, les commentaires sont bien toujours masqués ==> pérennité sur le long terme. De plus, c’est une syntaxe usuelle du HTML, donc pas de nouvelle syntaxe à apprendre.

Cas 2 : passage par un modèle <com|t=texte du commentaire>

J’ai un poil raccourci le nom du modèle histoire d’avoir une syntaxe plus courte mais ça ne change rien à l’affaire. On pourrait même utiliser <rem|t=xxx> histoire d’être cohérent avec #REM.

Ce qu’implémente le plugin :

  • le petit modèle proposé par Bruno. Éventuellement, on peut ajouter un pour une meilleur lisibilité.
  • éventuellement une déclaration pour insérer modèles afin de saisir facilement un commentaire

Ce qui se passe quand on désactive le plugin :

  • côté espace privé, quand un modèle n’est pas connu, SPIP affiche simplement l’appel du modèle (vérifié avec 2.1 et 3.0).
  • côté public, si sous SPIP 2.1 les modèles non connus ne renvoient simplement rien (le commentaire est donc bien masqué), sous SPIP 3, l’appel du modèle est affiché ==> les commentaires deviennent visibles dans l’espace public.

Il y a donc ici dépendance au plugin. Certes, c’est un mini plugin qui sera facilement upgradable et maintenable. Mais par principe ce n’est quand même pas l’idéal.

Ma préférence va donc clairement à une solution basée sur :

  • pas de dépendance au plugin. On peut le désactiver, les commentaires restent masqués. Le plugin ne gère donc qu’une amélioration de l’interface.
  • conceptuellement, un commentaire est différent d’un contenu à afficher donc d’un modèle, même si la solution proposée via un modèle est une belle astuce.

Cordialement à tous

Joseph

Si quelqu’un a une bonne idée de nom (commentaires visibles, jolis commentaires, …), je peux faire un proto assez vite ce soir.

Cordialement

Joseph

Plus tôt tu disais le mot "commentaire" ambigu, peut-être que
"annotation" ou quelque chose comme ça conviendrait mieux ?

Si quelqu'un a une bonne idée de nom (/commentaires visibles/, /jolis commentaires/, ...), je peux faire un proto assez
vite ce soir.

le titre pourrait utilement indiquer que ces commentaires apparaissent dans le privé
/prive annotations/ ou /prive commentaires/ ...

JLuc

Annotations privées ?

Je pense qu’on peut garder le mot commentaires puisque c’est bien de cela qu’il s’agit. Simplement ‘commentaire’ seul est ambigu.

‘Commentaires HTML’ est ce qui correspond le mieux à ce que c’est.

Est-ce que afficher_commentaires_html (prefixe) / Afficher Commentaires HTML (nom) / Affiche les commentaires HTML des objets éditoriaux dans l’espace privé (slogan) est explicite ? C’est n’est certes pas très inventif. Mais tant qu’on s’y retrouve.

Joseph

2012/6/26 Beurt <beurt@spip.org>

Allez on se lance.

Au fait, est-ce que ça ne serait pas à ranger dans plugins/porte_plume_extras/ ?

Joseph

Tu pourrais peut etre limiter le préfixe non ?
du style comhtml par exemple.
Sinon on va avoir des fonctions ou on ne sera plus ou est le préfixe du reste :p.

Je dirais que « NDLR » collerait parfaitement à l’usage et éviterait toute ambiguïté.

Attention aussi à ne pas afficher tous les commentaires html en NDLR car il y a d’autres usages des commentaires html dans le texte rédactionnel (tous discutables, mais c’est un fait avec lequel il faut faire)

Cédric

Bonjour,
C'est typiquement une fonctionnalité que le Couteau Suisse pourrait proposer, c'est vrai que parfois c'est fort utile, j'ai déjà eu ce besoin par le passé.
Pat

Pour me compléter, voici la solution que j'avais retenue :

  - Passer par la lame "Décoration"
  - Programmer les raccourcis suivants :
    auto.non = display:none;
    off = non
  - Et utiliser <non> mon commentaire invisible </non>
    ou : <off> mon commentaire invisible </off>

Bien sûr, ce n'est qu'une solution CSS. Rien "en dur".
Pat