Changeset 11214

Timestamp:

08/30/2021 11:47:57 PM (3 years ago)

Author:

Ipstenu

Message:

Update example readme foe plugins:

• clarity about trunk (no longer recommended)
• Formatting examples
• cleaning up line breaks
• removing duped language

Fixes 5876

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/readme.txt (modified) (5 diffs)

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

@@ -2 +2 @@
 Contributors: (this should be a list of wordpress.org userid's)
 Donate link: https://example.com/
-Tags: comments, spam
+Tags: tag1, tag2
 Requires at least: 4.7
 Tested up to: 5.4
@@ -21 +21 @@
 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 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.
+* "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 you've *successfully used to test the plugin*
+* Stable tag must indicate the Subversion "tag" of the latest stable version
 
-    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.
+Note that the `readme.txt` value of stable tag is the one that is the defining one for the plugin.  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.
 
-    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.
+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, your users may not get the correct version of your code.
 
 == Frequently Asked Questions ==
@@ -51 +45 @@
 == Screenshots ==
 
-1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is stored in the /assets directory.
+1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Screenshots are stored in the /assets directory.
 2. This is the second screen shot
 
@@ -73 +67 @@
 == A brief Markdown Example ==
 
+Markdown is what the parser uses to process much of the readme file.
+
+[markdown syntax]: https://daringfireball.net/projects/markdown/syntax
+
 Ordered list:
 
@@ -85 +83 @@
 * third thing
 
-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.
+Links require brackets and parenthesis:
 
-[markdown syntax]: https://daringfireball.net/projects/markdown/syntax
-            "Markdown is what the parser uses to process much of the readme file"
+Here's a link to [WordPress](https://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax]. Link titles are optional, naturally.
 
-Markdown uses email style notation for blockquotes and I've been told:
+Blockquotes are email style:
+
 > Asterisks for *emphasis*. Double it up  for **strong**.
 
-`<?php code(); // goes in backticks ?>`
+And Backticks for code:
+
+`<?php code(); ?>`