Artiss README Parser (formerly WP README Parser) will display a WordPress plugin's README file in XHTML format, for embedding on a post or page.
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.
Before the first section (usually "Description") is a number of pieces of "meta data" 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 "meta". 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 "head". If you wish to just remove a particular bit of meta data then specify
[readme exclude="Meta,Changelog"]WP README Parser[/readme]
This will display the entire README with the exception of the Changelog and the Plugin meta.
exclude this allows to ignore specific lines of the README. Multiple lines should be seperated by double commas (to allow single commas to be be used in the actual line to be ignored). For example...
[readme ignore="this line,,and this line"]WP README Parser[/readme]
Any links will have a target of
_blank. If you wish this to be anything else then change it with this parameter. For example...
[readme target="_self"]WP README Parser[/readme]
If you wish a link to have a nofollow option (i.e. the tag of
rel="nofollow") then specify this as "Yes". By default it won't. For example...
[readme nofollow="Yes"]WP README Parser[/readme]
This allows you to specify how long output should be cached for, in minutes. By default caching does not occur. For example, to cache for 1 hour...
[readme cache=60]WP README Parser[/readme]
If you wish to display a specific version of the README, use this parameter to request it. For example...
[readme version=1.0]WP README Parser[/readme]
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...
[readme mirror="http://www.example1.com,,http://www.example2.com"]WP README Parser[/readme]
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'd put...
[readme links="description"]WP README Parser[/readme]
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've renamed your plugin (as is the case for this plugin). You can therefore use the
name parameter to override this.
[readme name="WP README Parser"]http://plugins.svn.wordpress.org/wp-readme-parser/trunk/readme.txt[/readme]
If you also have the plugin Artiss Content Reveal installed, then each section of the README will be collapsable - that is, you can click on the section heading to hide the section content.
By default, all sections of the output will be revealed.
You may now use 3 further parameters when using the
Use this parameter to hide sections automatically - simply click on them to reveal them again.
[readme hide="Changelog"]WP README Parser[/readme]
If you wish to supply your own hide/reveal images then you can specify your own folder here.
The two images (one for when the content is hidden, another for when it's shown) must be named image1 and image2. They can either by GIF or PNG images (see the next parameter).
[readme scr_url="http://www.artiss.co.uk"]WP README Parser[/readme]
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.
[readme scr_url="http://www.artiss.co.uk" scr_ext="png"]WP README Parser[/readme]
If you wish to code a direct PHP call to the plugin, you can do. The function is named
readme_parser 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.
echo 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' );
This may be of particular use to plugin developers as they can then display the README for their plugins within their administration screens.
Some plugins have banners assigned to them. The shortcode
[readme_banner] can be used to output them (responsively too). Between the opening and closing shortcode you must specify a plugin name (a URL can't be used) and that's it. For example...
If no banner image exists then nothing will be output.
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.
Use the shortcode
[readme_info] to return one of a number of different pieces of information. Use the required parameter
data to specify what you need - this can b...
In the cases of the links you must specify text between the opening and closing shortcodes to link to.
There are 4 additional parameters...
Yesthen this will be a
nofollowlink. By default it won't be
Noto switch off caching entirely
An example of usage may be...
`[readme_info name="YouTube Embed" data="download"]Download Artiss YouTube Embed[/readme_info]'
This WordPress plugin is licensed under the GPLv2 (or later).
All of my plugins are supported via my website.
Please feel free to visit the site for plugin updates and development news - either visit the site regularly or follow me on Twitter (@artiss_tech).
This plugin, and all support, is supplied for free, but donations are always welcome.
WPCandy - WP README Parser Plugin converts Plugin's readme into blog-ready XHTML
Artiss README Parser uses PHP Markdown Extra by Michel Fortin.