WordPress.org

Making WordPress.org

Changeset 9807


Ignore:
Timestamp:
05/01/2020 06:37:57 AM (21 months 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:
2 edited

Legend:

Unmodified
Added
Removed
  • sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/readme.txt

    r8440 r9807  
    33Donate link: https://example.com/
    44Tags: comments, spam
    5 Requires at least: 4.6
    6 Tested up to: 4.7
     5Requires at least: 4.7
     6Tested up to: 5.4
    77Stable tag: 4.3
    8 Requires PHP: 5.2.4
     8Requires PHP: 7.0
    99License: GPLv2 or later
    1010License URI: https://www.gnu.org/licenses/gpl-2.0.html
     
    3939you put the stable version, in order to eliminate any doubt.
    4040
    41 == Installation ==
    42 
    43 This section describes how to install the plugin and get it working.
    44 
    45 e.g.
    46 
    47 1. Upload the plugin files to the `/wp-content/plugins/plugin-name` directory, or install the plugin through the WordPress plugins screen directly.
    48 1. Activate the plugin through the 'Plugins' screen in WordPress
    49 1. Use the Settings->Plugin Name screen to configure the plugin
    50 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)
    51 
    52 
    5341== Frequently Asked Questions ==
    5442
     
    6351== Screenshots ==
    6452
    65 1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
    66 the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets
    67 directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png`
    68 (or jpg, jpeg, gif).
     531. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is stored in the /assets directory.
    69542. This is the second screen shot
    7055
     
    8570= 0.5 =
    8671This version fixes a security related bug.  Upgrade immediately.
    87 
    88 == Arbitrary section ==
    89 
    90 You may provide arbitrary sections, in the same format as the ones above.  This may be of use for extremely complicated
    91 plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or
    92 "installation."  Arbitrary sections will be shown below the built-in sections outlined above.
    9372
    9473== A brief Markdown Example ==
  • sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/readme.txt

    r6391 r9807  
    11=== Plugin Name ===
    22Contributors: (this should be a list of wordpress.org userid's)
    3 Donate link: http://example.com/
    4 Requires at least: 3.0.1
    5 Tested up to: 3.4
     3Donate link: https://example.com/
     4Tags: comments, spam
     5Requires at least: 4.7
     6Tested up to: 5.4
    67Stable tag: 4.3
     8Requires PHP: 7.0
    79License: GPLv2 or later
    8 License URI: http://www.gnu.org/licenses/gpl-2.0.html
     10License URI: https://www.gnu.org/licenses/gpl-2.0.html
    911
    1012Here is a short description of the plugin.  This should be no more than 150 characters.  No markup here.
     
    4951== Screenshots ==
    5052
    51 1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
    52 the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets
    53 directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png`
    54 (or jpg, jpeg, gif).
     531. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is stored in the /assets directory.
    55542. This is the second screen shot
    5655
     
    8685* third thing
    8786
    88 Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax].
     87Here's a link to [WordPress](https://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax].
    8988Titles are optional, naturally.
    9089
    91 [markdown syntax]: http://daringfireball.net/projects/markdown/syntax
     90[markdown syntax]: https://daringfireball.net/projects/markdown/syntax
    9291            "Markdown is what the parser uses to process much of the readme file"
    9392
Note: See TracChangeset for help on using the changeset viewer.