Rich Tabor, le chef de produit principal de l’expérience WordPress chez GoDaddy, a tweeté qu’il avait une idée pour un nouveau bloc à la fin de la semaine dernière. Peu de temps après, le plugin Markdown Comment Block est apparu sur WordPress.org.
Le plugin est un bloc unique. Il permet aux utilisateurs de saisir des notes directement dans l’éditeur de publication qui n’apparaîtront pas sur le front-end du site. Tabor a déclaré qu’il avait eu l’idée en travaillant sur un article pour créer des plugins monobloc.
Il y a peu de choses que j’aime plus que de simples plugins avec un focus précis, remplissant une seule fonction. Le bloc de commentaires Markdown atterrit dans cette catégorie.
Le plugin crée un nouveau bloc qui fonctionne presque de la même manière qu’un bloc Paragraph typique :
Ajouter des commentaires en ligne à une publication.
Les utilisateurs peuvent modifier la couleur du texte, mais ils n’auront pas accès aux contrôles de texte enrichi typiques. Ceux-ci devraient être inutiles de toute façon.
En tant que personne qui écrit presque exclusivement dans Markdown, l’utilisation par le bloc de la syntaxe du double signe de pourcentage pour les commentaires m’a intrigué. Techniquement, la spécification Markdown ne prend en charge aucune sorte de caractères spéciaux pour eux. Il gère les commentaires HTML. Cependant, ceux-ci apparaissent dans le code source sur le front-end lorsque le document est rendu. Je n’ai vu que la marque %% pour indiquer les commentaires dans l’application Inspire Writer pour Windows. Tabor a dit qu’il avait vu la même chose dans Ulysse. La fonctionnalité existe également dans l’éditeur Iceberg pour WordPress, que Tabor a créé aux côtés de Jeffrey Carandang.
Le plugin introduit également le raccourci clavier %%. Le taper directement dans l’éditeur créera un nouveau bloc de commentaire Markdown.
Mon cas d’utilisation principal du plugin serait de laisser des notes pour moi-même plus tard. Cependant, cela pourrait également être utile dans les flux de publication des utilisateurs. Le bloc ajoute un bouton « Résoudre » à la barre d’outils. Cliquer dessus supprime le commentaire.
Cliquer sur le bouton « Résoudre » supprimera le bloc.
Ces notes apparaissent sur l’écran de post-gestion, permettant aux autres membres de l’équipe de savoir quand vérifier un article. Cependant, il peut être difficile de fournir le contexte complet des problèmes à résoudre avant la publication. Markdown Comment Block ajoute un système de commentaires en ligne, permettant aux membres de l’équipe de passer des notes dans le texte.
Les développeurs de thèmes doivent comprendre que le bloc utilise également des propriétés personnalisées CSS, ce qui facilite l’écrasement de ses règles de style par défaut. En quelques instants, j’ai pu le faire correspondre à mon thème :
Styles de couleur, de police et de hauteur de ligne personnalisés.
Les variables –markdown-comment-font-size, –markdown-comment-line-height et –markdown-comment-color sont disponibles pour les développeurs de thèmes qui souhaitent ajouter un support.
La seule plainte que j’ai eue à propos du bloc est son titre : « Commentaire ». Il est facile de le confondre avec les six autres blocs liés aux commentaires déjà présents dans la liste de blocage WordPress. Et, il n’y en aura que plus dans les versions à venir. Lui donner le titre de « Commentaire Markdown » permettrait de mieux le distinguer des autres.
Comme ça :
J’aime le chargement.