Changeset 1659276
- Timestamp:
- 05/17/2017 10:55:27 AM (9 years ago)
- File:
-
- 1 edited
-
mark-it-down-wp/trunk/readme.txt (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
mark-it-down-wp/trunk/readme.txt
r1659272 r1659276 1 1 === Plugin Name === 2 Contributors: (this should be a list of wordpress.org userid's)3 Donate link: http ://example.com/4 Tags: comments, spam5 Requires at least: 3.0.16 Tested up to: 3.47 Stable tag: 4.32 Contributors: Wasseem Khayrattee (7php) 3 Donate link: https://www.paypal.me/khayrattee 4 Tags: markdown, markup 5 Requires at least: 4.7.0 6 Tested up to: 4.7.5 7 Stable tag: 2.0.1 8 8 License: GPLv2 or later 9 9 License URI: http://www.gnu.org/licenses/gpl-2.0.html 10 10 11 He re is a short description of the plugin. This should be no more than 150 characters. No markup here.11 Helping you write posts/pages in plain-text Markdown syntax, while switching-off Visual Editor. It sits on the shoulders of a giant, namely Jetpack. 12 12 13 13 == Description == 14 14 15 This is the long description. No limit, and you can use Markdown (as well as in the following sections).15 This is a simple plugin to help you write posts or pages in plain-text Markdown syntax. And even allowing plaint-text Markdown for comments as well. It will also switch-off the Visual Editor, as you don't need distractions. This plugin sits on top of a giant's shoulder, namely Jetpack. 16 16 17 For backwards compatibility, if this section is missing, the full length of the short description will be used, and18 Markdown parsed.19 20 A few notes about the sections above:21 22 * "Contributors" is a comma separated list of wordpress.org usernames23 * "Tags" is a comma separated list of tags that apply to the plugin24 * "Requires at least" is the lowest version that the plugin will work on25 * "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on26 higher versions... this is just the highest one you've verified.27 * Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for28 stable.29 30 Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so31 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 used32 for displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt`33 is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in34 your in-development version, without having that information incorrectly disclosed about the current stable version35 that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.36 37 If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where38 you put the stable version, in order to eliminate any doubt.39 17 40 18 == Installation == 41 19 42 This section describes how to install the plugin and get it working. 43 44 e.g. 45 46 1. Upload the plugin files to the `/wp-content/plugins/plugin-name` directory, or install the plugin through the WordPress plugins screen directly. 47 1. Activate the plugin through the 'Plugins' screen in WordPress 48 1. Use the Settings->Plugin Name screen to configure the plugin 49 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) 20 1. Upload the plugin files to the `/wp-content/plugins/` directory, or install the plugin through the WordPress plugins screen directly. This plugin is also installable via **Composer**, see [https://github.com/7php/MarkItDownWordpress](https://github.com/7php/MarkItDownWordpress) 21 2. Activate the plugin through the 'Plugins' screen in WordPress 22 3. Enable Markdown for posts & pages, by manually checking the checkbox at: **Settings > Writing > 'Use Markdown for posts and pages'** 23 4. If you want to enable Markdown for comments as well, check the checkbox here also: **Settings > Discussion > 'Use Markdown for comments'** 50 24 51 25 52 26 == Frequently Asked Questions == 53 27 54 = A question that someone might have=28 = Can this plugin be installed if the Jetpack module is also installed = 55 29 56 An answer to that question.30 Yes you can. But you will not be able to use the "Markdown" module from Jetpack. I would advise that if you need Markdown support, and you also need to use Jetpack, then only use Jetpack only and use its Markdown functionality. Else if you are not a Jetpack user, this plugin is what you need for Markdown support. 57 31 58 = Wh at about foo bar?=32 = Why use this plugin instead of Jetpack = 59 33 60 Answer to foo bar dilemma. 34 Jetpack is normally a heavy plugin with lots and lots of functionalities which you might not even be using. So if you just need the "Markdown feature" of Jetpack, use *this* plugin only, that is why "Mark It Down Wordpress" was born for. 35 36 = Will You Supporting This Plugin Actively = 37 38 Yes, I will. I use this plugin in all my blogs and even for some of my clients. So it's in my honest interest to keep this plugin active and supported. If you have any question, shoot me an email at <markitdownwordpress@7php.com> 61 39 62 40 == Screenshots == 63 41 64 1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from 65 the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets 66 directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png` 67 (or jpg, jpeg, gif). 68 2. This is the second screen shot 42 1. This screen shot description corresponds to installation step 3 above, which instructs: Enable Markdown for posts & pages, by manually checking the checkbox at: **Settings > Writing > 'Use Markdown for posts and pages'** 43 2. This screen shot description corresponds to installation step 4 above, which instructs: to enable Markdown for comments as well, check the checkbox here also: **Settings > Discussion > 'Use Markdown for comments'** 69 44 70 45 == Changelog == 71 46 72 = 1.0 = 73 * A change since the previous version. 74 * Another change. 47 = 2.0.1 = 48 * Remove dependencies to class.jetpack-options.php and trigger E_USER_WARNING if Jetpack plugin is also installed (instead of E_USER_ERROR) 49 * Allows user to install this plugin even though Jetpack is enabled. 50 * Not backward compatible to v1.0.0 75 51 76 = 0.5 = 77 * List versions from most recent at top to oldest at bottom. 52 = 1.0.0 = 53 * Initial commit of this plugin 54 78 55 79 56 == Upgrade Notice == 80 57 81 = 1.0 = 82 Upgrade notices describe the reason a user should upgrade. No more than 300 characters. 58 = 2.0.1 = 59 - Removes all dependencies on Jetpack specific classes like class.jetpack-options 60 - Allows user to install this plugin even though Jetpack is enabled. 83 61 84 = 0.5 = 85 This version fixes a security related bug. Upgrade immediately. 62 == Roadmap == 86 63 87 == Arbitrary section == 88 89 You may provide arbitrary sections, in the same format as the ones above. This may be of use for extremely complicated 90 plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or 91 "installation." Arbitrary sections will be shown below the built-in sections outlined above. 92 93 == A brief Markdown Example == 94 95 Ordered list: 96 97 1. Some feature 98 1. Another feature 99 1. Something else about the plugin 100 101 Unordered list: 102 103 * something 104 * something else 105 * third thing 106 107 Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax]. 108 Titles are optional, naturally. 109 110 [markdown syntax]: http://daringfireball.net/projects/markdown/syntax 111 "Markdown is what the parser uses to process much of the readme file" 112 113 Markdown uses email style notation for blockquotes and I've been told: 114 > Asterisks for *emphasis*. Double it up for **strong**. 115 116 `<?php code(); // goes in backticks ?>` 64 - By default, toggle the checkbox to true for Settings > Writing > 'Use Markdown for posts and pages' 65 - By default, toggle the checkbox to true for Settings > Discussion > 'Use Markdown for comments' 66 - In plain-tex editor mode, remove the short-formatting buttons, e.g [b, i, link, b-quote, del].. etc. Make the editor, distraction free. 67 - Make an effort to provide Markdown buttons for the equivalent of [b, i, link, b-quote, del], just like bbcodes.
Note: See TracChangeset
for help on using the changeset viewer.