WordPress README files are formatted using a version of the Markdown language. This plugin can be used to convert these to XHTML and display on a post or page of your site.<\/p>\n
It\u2019s ideal for plugin developers who wish to add instructions to their own site without having to duplicate effort.<\/p>\n
Key features include\u2026<\/p>\n
Iconography is courtesy of Flatart<\/a> \u2665\ufe0f<\/p>\n \ud83d\udc49 Please visit the Github page<\/a> for the latest code development, planned enhancements and known issues \ud83d\udc48<\/p>\n To use, simply add the This would fetch and display the README for this plugin. You can also specify a filename instead.<\/p>\n The first heading, which is the name of the plugin, will be automatically suppressed as it is assumed that you have already added this to your post\/page or are using it as the title.<\/p>\n exclude<\/strong><\/p>\n Each README is divided into a number of sections. If you wish to exclude any from the output then use this parameter to list them.<\/p>\n Before the first section (usually \u201cDescription\u201d) is a number of pieces of \u201cmeta data\u201d about the plugin, including tags, etc. Links are automatically added to these. If, however, you wish to just exclude this data then you should use the section name of \u201cmeta\u201d. Underneath this data is a short description which will remain in this case. If you want to remove this description and the meta data then use the section name of \u201chead\u201d. If you wish to just remove a particular bit of meta data then specify For example\u2026<\/p>\n This will display the entire README with the exception of the Changelog and the Plugin meta.<\/p>\n include<\/strong><\/p>\n The opposite of This will ONLY show the Meta and Changelog sections of the README file.<\/p>\n The only difference to the exclude command is that you can\u2019t include just specific sections of the meta. If you believe that this option is required then please get in touch via the forum.<\/p>\n ignore<\/strong><\/p>\n Different from target<\/strong><\/p>\n Any links will have a target of nofollow<\/strong><\/p>\n If you wish a link to have a nofollow option (i.e. the tag of cache<\/strong><\/p>\n This allows you to specify how long output should be cached for, in minutes. By default caching is set to 60 minutes. For example, to cache for 24 hours\u2026<\/p>\n version<\/strong><\/p>\n If you wish to display a specific version of the README, use this parameter to request it. For example\u2026<\/p>\n mirror<\/strong><\/p>\n If your plugin is hosted at a number of other locations then you can use this to specify alternative download URLs other than the WordPress repository. Simply seperate multiple URLs with double commas (i.e. ,,). For example\u2026<\/p>\n links<\/strong><\/p>\n By default download and other links will be added to the bottom of the README output. By specifying a section name via this parameter, however, then the links will appear before that section. For example, to appear before the description you\u2019d put\u2026<\/p>\n name<\/strong><\/p>\n If you specify a README filename instead a name then it will be assumed that the plugin name at the top of the README is the correct one. This may not be the case, however, if you\u2019ve renamed your plugin (as is the case for this plugin). You can therefore use the ext<\/strong><\/p>\n The extension that your screenshots are stored as \u2013 i.e. PNG or JPG.<\/p>\n assets<\/strong><\/p>\n Storing your screenshots in your assets folder? Then set this to \u2018yes\u2019 for them to be read from there. For example\u2026<\/p>\n If you also have the plugin Content Reveal<\/a> installed, then each section of the README will be collapsable \u2013 that is, you can click on the section heading to hide the section content.<\/p>\n By default, all sections of the output will be revealed.<\/p>\n You may now use 3 further parameters when using the hide<\/strong><\/p>\n Use this parameter to hide sections automatically \u2013 simply click on them to reveal them again.<\/p>\n For example\u2026<\/p>\n scr_url<\/strong><\/p>\n If you wish to supply your own hide\/reveal images then you can specify your own folder here.<\/p>\n The two images (one for when the content is hidden, another for when it\u2019s shown) must be named image1 and image2. They can either by GIF or PNG images (see the next parameter).<\/p>\n For example\u2026<\/p>\n scr_ext<\/strong><\/p>\n Use this specify whether you wish to use PNG or GIF images for your own hide\/reveal images. If you do not specify it, GIF will be used.<\/p>\n For example\u2026<\/p>\n If you wish to code a direct PHP call to the plugin, you can do. The function is named For example\u2026<\/p>\n This may be of particular use to plugin developers as they can then display the README for their plugins within their administration screens.<\/p>\n Some plugins have banners assigned to them. The shortcode If no banner image exists then nothing will be output.<\/p>\n You may wish to add your own section to the output to provide download links, etc. In which case you can suppress this section and then use an additional shortcode to retrieve the information that you need.<\/p>\n Use the shortcode In the cases of the links you must specify text between the opening and closing shortcodes to link to.<\/p>\n There are 4 additional parameters\u2026<\/p>\n An example of usage may be\u2026<\/p>\n `[readme_info name=\u201dYouTube Embed\u201d data=\u201ddownload\u201d]Download YouTube Embed[\/readme_info]\u2019<\/p>\nGetting Started<\/h3>\n
[readme]<\/code> shortcode to any post or page. An example of use would be\u2026<\/p>\n[readme]WP README Parser[\/readme]\n<\/code><\/pre>\nAdditional Shortcode Parameters<\/h3>\n
contributors<\/code>, donate<\/code>, tags<\/code>, requires<\/code>, license<\/code>, license uri<\/code>, tested<\/code> or stable<\/code>.<\/p>\n[readme exclude=\"Meta,Changelog\"]WP README Parser[\/readme]\n<\/code><\/pre>\nexclude<\/code> this allows you to specify ONLY the section that you wish to appear. So, using the example from above\u2026<\/p>\n[readme include=\"Meta,Changelog\"]WP README Parser[\/readme]\n<\/code><\/pre>\nexclude<\/code> this allows to ignore specific lines of the README. Multiple lines should be separated by double commas (to allow single commas to be be used in the actual line to be ignored). For example\u2026<\/p>\n[readme ignore=\"this line,,and this line\"]WP README Parser[\/readme]\n<\/code><\/pre>\n_blank<\/code>. If you wish this to be anything else then change it with this parameter. For example\u2026<\/p>\n[readme target=\"_self\"]WP README Parser[\/readme]\n<\/code><\/pre>\nrel=\"nofollow\"<\/code>) then specify this as \u201cYes\u201d. By default it won\u2019t. For example\u2026<\/p>\n[readme nofollow=\"Yes\"]WP README Parser[\/readme]\n<\/code><\/pre>\n[readme cache=1440]WP README Parser[\/readme]\n<\/code><\/pre>\n[readme version=1.0]WP README Parser[\/readme]\n<\/code><\/pre>\n[readme mirror=\"http:\/\/www.example1.com,,http:\/\/www.example2.com\"]WP README Parser[\/readme]\n<\/code><\/pre>\n[readme links=\"description\"]WP README Parser[\/readme]\n<\/code><\/pre>\nname<\/code> parameter to override this.<\/p>\n[readme name=\"WP README Parser\"]https:\/\/plugins.svn.wordpress.org\/wp-readme-parser\/trunk\/readme.txt[\/readme]\n<\/code><\/pre>\n[readme assets=\"yes\"]WP README Parser[\/readme]Using Content Reveal<\/h3>\n<\/code><\/pre>\n
[readme]<\/code> shortcode\u2026<\/p>\n[readme hide=\"Changelog\"]WP README Parser[\/readme]\n<\/code><\/pre>\n[readme scr_url=\"https:\/\/artiss.blog\u201d]WP README Parser[\/readme]\n<\/code><\/pre>\n[readme scr_url=\"https:\/\/artiss.blog\" scr_ext=\"png\"]WP README Parser[\/readme]Using a Function Call<\/h3>\n<\/code><\/pre>\n
readme_parser<\/code> and accepts 2 parameters. The first is an array of all the options, the same as the shortcode. The second parameter is the README name or filename.<\/p>\necho readme_parser( array( 'exclude' => 'meta,upgrade notice,screenshots,support,changelog,links,installation,licence', 'ignore' => 'For help with this plugin,,for more information and advanced options ' ), 'YouTube Embed' );\n<\/code><\/pre>\nDisplaying the plugin banner<\/h3>\n
[readme_banner]<\/code> can be used to output them (responsively too). Between the opening and closing shortcode you must specify a plugin name (a URL can\u2019t be used) and that\u2019s it. For example\u2026<\/p>\n[readme_banner]YouTube Embed[\/readme_banner]\n<\/code><\/pre>\nDisplay specific README information<\/h3>\n
[readme_info]<\/code> to return one of a number of different pieces of information. Use the required parameter data<\/code> to specify what you need \u2013 this can b\u2026<\/p>\n\n
\n
Yes<\/code> then this will be a nofollow<\/code> link. By default it won\u2019t be<\/li>\nNo<\/code> to switch off caching entirely<\/li>\n<\/ul>\nReviews & Mentions<\/h3>\n