Additional Shortcode Parameters

exclude

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 contributors, donate, tags, requires, license, license uri, tested or stable.

For example...

[readme exclude="Meta,Changelog"]WP README Parser[/readme]

This will display the entire README with the exception of the Changelog and the Plugin meta.

include

The opposite of exclude this allows you to specify ONLY the section that you wish to appear. So, using the example from above...

[readme include="Meta,Changelog"]WP README Parser[/readme]

This will ONLY show the Meta and Changelog sections of the README file.

The only difference to the exclude command is that you can't include just specific sections of the meta. If you believe that this option is required then please get in touch via the forum.

ignore

Different from exclude 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...

[readme ignore="this line,,and this line"]WP README Parser[/readme]

target

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]

nofollow

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]

cache

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]

version

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]

mirror

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]

links

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]

name

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]

ext

The extension that your screenshots are stored as - i.e. PNG or JPG.

assets

Storing your screenshots in your assets folder? Then set this to 'yes' for them to be read from there. For example...

[readme assets="yes"]WP README Parser[/readme]