Changeset 9807

Timestamp:

05/01/2020 06:37:57 AM (4 years ago)

Author:

dd32

Message:

Plugin Directory: Update the readme example to not mention putting screenshots in the plugin folder.

This also updates the default metadata for the readme.txt, and combines the two different readme's by consistently removing the Installation and Arbitrary sections since they're rarely if ever properly used.

See #5175.

Location:

sites/trunk/wordpress.org/public_html/wp-content

Files:

• plugins/plugin-directory/readme/readme.txt (modified) (4 diffs)
• themes/pub/wporg-plugins/readme.txt (modified) (3 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/readme.txt

@@ -3 +3 @@
 Donate link: https://example.com/
 Tags: comments, spam
-Requires at least: 4.6
-Tested up to: 4.7
+Requires at least: 4.7
+Tested up to: 5.4
 Stable tag: 4.3
-Requires PHP: 5.2.4
+Requires PHP: 7.0
 License: GPLv2 or later
 License URI: https://www.gnu.org/licenses/gpl-2.0.html
@@ -39 +39 @@
 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 the plugin files to the `/wp-content/plugins/plugin-name` directory, or install the plugin through the WordPress plugins screen directly.
-1. Activate the plugin through the 'Plugins' screen in WordPress
-1. Use the Settings->Plugin Name screen to configure the plugin
-1. (Make your instructions match the desired user flow for activating and installing your plugin. Include any steps that might be needed for explanatory purposes)
-
-
 == Frequently Asked Questions ==
 
@@ -63 +51 @@
 == 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).
+1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is stored in the /assets directory.
 2. This is the second screen shot
 
@@ -85 +70 @@
 = 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 ==

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/readme.txt

@@ -1 +1 @@
 === Plugin Name ===
 Contributors: (this should be a list of wordpress.org userid's)
-Donate link: http://example.com/
-Requires at least: 3.0.1
-Tested up to: 3.4
+Donate link: https://example.com/
+Tags: comments, spam
+Requires at least: 4.7
+Tested up to: 5.4
 Stable tag: 4.3
+Requires PHP: 7.0
 License: GPLv2 or later
-License URI: http://www.gnu.org/licenses/gpl-2.0.html
+License URI: https://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.
@@ -49 +51 @@
 == 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).
+1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is stored in the /assets directory.
 2. This is the second screen shot
 
@@ -86 +85 @@
 * third thing
 
-Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax].
+Here's a link to [WordPress](https://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 syntax]: https://daringfireball.net/projects/markdown/syntax
             "Markdown is what the parser uses to process much of the readme file"