S’il vous arrive de vous lancer dans la création de plugins WordPress, ou que c’est quelque chose que vous aimeriez faire, voici des petits outils bien pensés qui vous feront gagner du temps dans le formatage de votre fichier readme.txt.
Pourquoi un fichier readme.txt ?
C’est très courant – voire indispensable – dans le monde de l’informatique, je ne vous apprends rien. Ce type de fichier sert à expliquer l’utilité de l’outil associé, son utilisation et en général son installation et d’y préciser le changelog (les évolutions et corrections apportées). Celui de WordPress a en plus un rôle prépondérant car c’est depuis ce fichier que sont extraites les données affichées sur les pages de plugins sur le dépôt wordpress.org. Ce fichier, qui répond à des normes (le Markdown) a donc un rôle essentiel et doit impérativement être validé avant d’être mis en ligne avec votre plugin. Un readme non valide sera de toute façon refusé après soumission (ça c’est arrivé, je ne sais pas si c’est systématique).
Que doit contenir mon fichier ?
Je ne vais pas vous détailler ici la liste des informations obligatoire, mais vais plutôt vous renvoyer sur la documentation officielle sur developer.wordpress.org
Pour synthétiser, l’entête du fichier doit contenir la version du plugin, la version de WordPress jusqu’à laquelle il a été testé, le nom (identifiant) du ou des contributeurs et la version PHP minimale requise. Vous devez également avoir les sections suivantes : Description, Installation, Frequently Asked Questions, Screenshots (optionnel), Changelog.
Je vous conseille d’ajouter la date et si possible le type de mise à jour (fix ou enhancement) dans les versions de votre changelog. Cela permettra a vous utilisateurs de mieux comprendre ce que vous avez et quand.
Voici un « canvas » que je me suis fait et que j’utilise régulièrement (tous les 5 ans environ 🙂 )
=== My Plugin Name === Contributors: wp_user_id Donate link: https://give.me/money Tags: fancy, awesome, cool, kickass Requires at least: 0.1 Tested up to: 5.3 Requires PHP: 5.5.12 Stable tag: x.x License: GPLv2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html == Description == **The intro on list page** == Installation == 1. Upload and activate the plugin (or install it through the WP admin console) 2. That's it, it is ready to use! == Frequently Asked Questions == = Is it cool = Yes. = Are you sure? = Yes, sure. == Screenshots == 1. Screenshot description 2. Screenshot description == Changelog == = 0.1 - 11/15/2019 = * Tested on WP 5.3 with success! * readme.txt update == Upgrade Notice == = 0.1 = * First release.
Des outils pour vous aider
Il existe des outils pour vous aider à valider votre readme, et quand je parle de validation, , je ne parle pas que de respect des standards, mais aussi « visuellement ». En effet, même si vous avez bien respecté le markdown, il est important que votre présentation – qui est en quelque sorte votre documentation et vitrine sur wp.org – soit efficace et lisible.
