Le fichier Readme pour ses plugins

Le fichier Readme pour ses plugins

Une étape obligatoire pour mettre son plugin wordpress en ligne, est d’y inclure un fichier de description détaillé appelé readme.txt.

Le modèle

Voici le modèle proposé par wordrepss.org sur lequel il faut se baser

=== Plugin Name ===
Contributors: (this should be a list of wordpress.org userid's)
Donate link: http://example.com/
Tags: comments, spam
Requires at least: 3.0.1
Tested up to: 3.4
Stable tag: 4.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Here is a short description of the plugin.  This should be no more than 150 characters.  No markup here.

== Description ==

This is the long description.  No limit, and you can use Markdown (as well as in the following sections).

For backwards compatibility, if this section is missing, the full length of the short description will be used, and
Markdown parsed.

A few notes about the sections above:

*   "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames
*   "Tags" is a comma separated list of tags that apply to the plugin
*   "Requires at least" is the lowest version that the plugin will work on
*   "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on
higher versions... this is just the highest one you've verified.
*   Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for
stable.

    Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so
if the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used
for displaying information about the plugin.  In this situation, the only thing considered from the trunk `readme.txt`
is the stable tag pointer.  Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in
your in-development version, without having that information incorrectly disclosed about the current stable version
that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.

    If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where
you put the stable version, in order to eliminate any doubt.

== Installation ==

This section describes how to install the plugin and get it working.

e.g.

1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Place `<?php do_action('plugin_name_hook'); ?>` in your templates

== Frequently Asked Questions ==

= A question that someone might have =

An answer to that question.

= What about foo bar? =

Answer to foo bar dilemma.

== Screenshots ==

1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets 
directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png` 
(or jpg, jpeg, gif).
2. This is the second screen shot

== Changelog ==

= 1.0 =
* A change since the previous version.
* Another change.

= 0.5 =
* List versions from most recent at top to oldest at bottom.

== Upgrade Notice ==

= 1.0 =
Upgrade notices describe the reason a user should upgrade.  No more than 300 characters.

= 0.5 =
This version fixes a security related bug.  Upgrade immediately.

== Arbitrary section ==

You may provide arbitrary sections, in the same format as the ones above.  This may be of use for extremely complicated
plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or
"installation."  Arbitrary sections will be shown below the built-in sections outlined above.

== A brief Markdown Example ==

Ordered list:

1. Some feature
1. Another feature
1. Something else about the plugin

Unordered list:

* something
* something else
* third thing

Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax].
Titles are optional, naturally.

[markdown syntax]: http://daringfireball.net/projects/markdown/syntax
            "Markdown is what the parser uses to process much of the readme file"

Markdown uses email style notation for blockquotes and I've been told:
> Asterisks for *emphasis*. Double it up  for **strong**.

`<?php code(); // goes in backticks ?>`

Il y a la dedans de nombreuses rubriques non obligatoires, mais c’est la base.

Les générateurs

On peut aussi faire appel à des générateurs :
http://sudarmuthu.com/wordpress/wp-readme/

Un exemple concret :

je vous mets ici un fichier que j’ai utilisé pour un plugin, qui a été validé et comporte donc les éléments obligatoires:

=== SiteMap Widget===
Contributors: Matthieu Solente
Tags: plugin, widget, customize, sitemap, page,posts, categories.
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=43XMASQSUE4YE
Requires at least: 3.5
Tested up to: 4.1
Stable tag: 1.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Easily lets you add a siteMap dropdown menu widget on your dashboard

== Description ==
WordPress SiteMap Widget is a plugin that easily lets you add a sitemap widget on your dashboard screen. SiteMap Widget allows you to:
* Display a sitemap widget(categories, pages and posts are listed in a dynamic dropdown menu)
* Choose to display one of the three item, or all together


== Installation ==
1. Download archive and unzip in wp-content/plugins or install via Plugins / Add New.
2. Activate the plugin through the Plugins menu in WordPress.
3. Check your settings in "Settings/SiteMapWidget.

= Translators =
* French (fr_FR) - Matthieu Solente

== Changelog ==
For more information, see [Releases](http://copier-coller.com/sitemap-widget-plugin-wordpress/).

= 1.0 =
* Initial release.

== Upgrade Notice ==
To have information on new release, follow http://copier-coller.com/sitemap-widget-plugin-wordpress/

== Frequently Asked Questions ==
Do you have questions or issues with siteMapWidget? Use these support channels appropriately.
1. [Docs](http://copier-coller.com/sitemap-widget-plugin-wordpress/)
1. [Support Forum](http://wordpress.org/support/plugin/sitemap-widget)

== Screenshots ==
1. Sitemap Widget
2. sitemap option

La validation:

Une fois terminé, il faut le faire valider, sur: https://wordpress.org/plugins/about/validator/

Quelques explications :

== Frequently Asked Questions ==

il faut placer la des questions réponses type que vous pensez pertinentes pour l’utilisation de votre plugin

== Screenshots ==

il faut placer là sous forme de liste, des descriptions qui se rattacheront automatiquement aux images « screenshot– » de votre dossier « assets« .

1-(…) se rattachera à screenshot-1.png

2-(…) se rattachera a screenshot-2.png etc..

Donc ne mettez pas screenshot-1  screenshot-2 ici, mais les descriptions des images, et dans l’ordre.

== Description ==

C’est tout ce qu’on verra sur la page d’accueil de votre plugin sur le site wordpress.org. Vous pouvez donc y aller et fournir du contenu.

== Upgrade Notice == ou == Changelog ==

il faut donner ici des explications sur les évolutions des versions de votre plugin.

La meilleure manière est de regarder comment sont fait les autres fichiers readme dans les plugins que vous utilisez tous les jours.

Avec toutes ce infos, vous devriez y arriver!!
Tant que ce fichier n’est pas validé, vous ne pourrez pas poser votre plugin sur le repository..

Voici pour terminer un lien et des conseils pour améliorer le contenu ce fichier.

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.