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 wordpress.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 youve successfully used to test the plugin. Note that it might work on
higher versions this is just the highest one youve 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 is4.3
, then it is/tags/4.3/readme.txt
thatll be used
for displaying information about the plugin. In this situation, the only thing considered from the trunkreadme.txt
is the stable tag pointer. Thus, if you develop in trunk, you can update the trunkreadme.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 trunksreadme.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 thats where
you put the stable version, in order to eliminate any doubt.
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 doesnt 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:
- Some feature
- Another feature
- Something else about the plugin
Unordered list:
- something
- something else
- third thing
Heres a link to WordPress and one to Markdowns Syntax Documentation.
Titles are optional, naturally.
Markdown uses email style notation for blockquotes and Ive been told:
Asterisks for emphasis. Double it up for strong.
Installation
This section describes how to install the plugin and get it working.
e.g.
- Upload the plugin files to the
/wp-content/plugins/plugin-name
directory, or install the plugin through the WordPress plugins screen directly. - Activate the plugin through the Plugins screen in WordPress
- Use the Settings->Plugin Name screen to configure the plugin
- (Make your instructions match the desired user flow for activating and installing your plugin. Include any steps that might be needed for explanatory purposes)
FAQ
-
An answer to that question.
-
Answer to foo bar dilemma.