Afficher les commentaires HTML

Ce plugin permet d’afficher dans l’espace privé les commentaires HTML saisis dans le texte des objets éditoriaux (les articles par exemple). Un bouton est également ajouté au porte-plume pour faciliter l’insertion des commentaires.

Fonctionnement

Ce plugin ajoute au porte-plume un bouton

pour faciliter l’insertion de commentaires HTML de la forme <!-- texte du commentaire -->.

De plus, lorsque le présent plugin est actif, les commentaires HTML sont affichés en vert dans l’espace privé.

Ainsi, si le texte de votre article contient :

Ceci est un exemple de {{commentaire HTML}}.
<!-- Ceci est le texte de mon commentaire. -->

alors dans l’espace privé sera affiché :

Ceci est un exemple de commentaire HTML.
<!— Ceci est le texte de mon commentaire. —>

Avertissement

Bien que non affichés dans l’espace public, les commentaires HTML seront indexés dans le moteur de recherche interne. Le moteur de recherche remontera donc les articles pour lesquels le mot recherché est présent dans les commentaires HTML.

Les commentaires HTML saisis dans un objet éditorial sont également filtrés par le présent plugin sur les pages publiques du site. Ils n’apparaîtront pas dans le code source des pages.

Si vous désactivez le plugin, les commentaires ne seront plus filtrés. Bien que non affichés par le navigateur (par définition), ils resteront néanmoins accessibles dans le code source des pages.

Il se peut que le filtrage des commentaires HTML dans l’espace public puisse interférer avec le fonctionnement d’un autre plugin si ce dernier ajoute des commentaires. Aucune interférence n’a été identifiée à ce jour, mais si vous constatez qu’un autre plugin ne fonctionne pas si et seulement si le présent plugin est actif, n’hésitez pas à le signaler dans le forum de discussion.

Usages

Les commentaires HTML peuvent être utilisés pour laisser des indications aux autres rédacteurs du site. En particulier, ils peuvent être combinées au plugin Gabarits pour indiquer dans le gabarit les modifications attendues. Ou pour garder en mémoire certaines informations relatives à la rédaction d’un passage donné.

En programmation, le bon usage des commentaires fait souvent débat (voir par exemple : Un commentaire, à quoi ça sert ?).

À chacun d’adapter son usage des commentaires en fonction de ses besoins. Il importe néanmoins de ne pas oublier de ne pas mettre d’information sensible dans les commentaires au cas où le plugin serait désactivé.

updated on 2 October 2019

Discussion

Aucune discussion

Comment on this article

Who are you?
  • [Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom