| 1 | === Plugin Name === |
|---|
| 2 | Contributors: (this should be a list of wordpress.org userid's) |
|---|
| 3 | Donate link: http://example.com/ |
|---|
| 4 | Tags: comments, spam |
|---|
| 5 | Requires at least: 3.0.1 |
|---|
| 6 | Tested up to: 3.4 |
|---|
| 7 | Stable tag: 4.3 |
|---|
| 8 | License: GPLv2 or later |
|---|
| 9 | License URI: http://www.gnu.org/licenses/gpl-2.0.html |
|---|
| 10 | |
|---|
| 11 | Here is a short description of the plugin. This should be no more than 150 characters. No markup here. |
|---|
| 12 | |
|---|
| 13 | == Description == |
|---|
| 14 | |
|---|
| 15 | This is the long description. No limit, and you can use Markdown (as well as in the following sections). |
|---|
| 16 | |
|---|
| 17 | ` |
|---|
| 18 | #sample-css { color: red; } |
|---|
| 19 | ` |
|---|
| 20 | |
|---|
| 21 | = This will not be visible = |
|---|
| 22 | |
|---|
| 23 | For backwards compatibility, if this section is missing, the full length of the short description will be used, and |
|---|
| 24 | Markdown parsed. |
|---|
| 25 | |
|---|
| 26 | A few notes about the sections above: |
|---|
| 27 | |
|---|
| 28 | * "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames |
|---|
| 29 | * "Tags" is a comma separated list of tags that apply to the plugin |
|---|
| 30 | * "Requires at least" is the lowest version that the plugin will work on |
|---|
| 31 | * "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on |
|---|
| 32 | higher versions... this is just the highest one you've verified. |
|---|
| 33 | * Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for |
|---|
| 34 | stable. |
|---|
| 35 | |
|---|
| 36 | Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so |
|---|
| 37 | 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 |
|---|
| 38 | for displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt` |
|---|
| 39 | is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in |
|---|
| 40 | your in-development version, without having that information incorrectly disclosed about the current stable version |
|---|
| 41 | that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag. |
|---|
| 42 | |
|---|
| 43 | If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where |
|---|
| 44 | you put the stable version, in order to eliminate any doubt. |
|---|
| 45 | |
|---|
| 46 | == Installation == |
|---|
| 47 | |
|---|
| 48 | This section describes how to install the plugin and get it working. |
|---|
| 49 | |
|---|
| 50 | e.g. |
|---|
| 51 | |
|---|
| 52 | 1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory |
|---|
| 53 | 1. Activate the plugin through the 'Plugins' menu in WordPress |
|---|
| 54 | 1. Place `<?php do_action('plugin_name_hook'); ?>` in your templates |
|---|
| 55 | |
|---|
| 56 | == Frequently Asked Questions == |
|---|
| 57 | |
|---|
| 58 | = A question that someone might have = |
|---|
| 59 | |
|---|
| 60 | An answer to that question. |
|---|
| 61 | |
|---|
| 62 | = What about foo bar? = |
|---|
| 63 | |
|---|
| 64 | Answer to foo bar dilemma. |
|---|
| 65 | |
|---|
| 66 | == Screenshots == |
|---|
| 67 | |
|---|
| 68 | 1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from |
|---|
| 69 | the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets |
|---|
| 70 | directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png` |
|---|
| 71 | (or jpg, jpeg, gif). |
|---|
| 72 | 2. This is the second screen shot |
|---|
| 73 | |
|---|
| 74 | == Changelog == |
|---|
| 75 | |
|---|
| 76 | = 1.0 = |
|---|
| 77 | * A change since the previous version. |
|---|
| 78 | * Another change. |
|---|
| 79 | |
|---|
| 80 | = 0.5 = |
|---|
| 81 | * List versions from most recent at top to oldest at bottom. |
|---|
| 82 | |
|---|
| 83 | == Upgrade Notice == |
|---|
| 84 | |
|---|
| 85 | = 1.0 = |
|---|
| 86 | Upgrade notices describe the reason a user should upgrade. No more than 300 characters. |
|---|
| 87 | |
|---|
| 88 | = 0.5 = |
|---|
| 89 | This version fixes a security related bug. Upgrade immediately. |
|---|
| 90 | |
|---|
| 91 | == Arbitrary section == |
|---|
| 92 | |
|---|
| 93 | You may provide arbitrary sections, in the same format as the ones above. This may be of use for extremely complicated |
|---|
| 94 | plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or |
|---|
| 95 | "installation." Arbitrary sections will be shown below the built-in sections outlined above. |
|---|
| 96 | |
|---|
| 97 | == A brief Markdown Example == |
|---|
| 98 | |
|---|
| 99 | Ordered list: |
|---|
| 100 | |
|---|
| 101 | 1. Some feature |
|---|
| 102 | 1. Another feature |
|---|
| 103 | 1. Something else about the plugin |
|---|
| 104 | |
|---|
| 105 | Unordered list: |
|---|
| 106 | |
|---|
| 107 | * something |
|---|
| 108 | * something else |
|---|
| 109 | * third thing |
|---|
| 110 | |
|---|
| 111 | Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax]. |
|---|
| 112 | Titles are optional, naturally. |
|---|
| 113 | |
|---|
| 114 | [markdown syntax]: http://daringfireball.net/projects/markdown/syntax |
|---|
| 115 | "Markdown is what the parser uses to process much of the readme file" |
|---|
| 116 | |
|---|
| 117 | Markdown uses email style notation for blockquotes and I've been told: |
|---|
| 118 | > Asterisks for *emphasis*. Double it up for **strong**. |
|---|
| 119 | |
|---|
| 120 | `<?php code(); // goes in backticks ?>` |
|---|