The tsw_help_display plugin is a simple plugin to display the help contents of a specified plugin that is installed in your Textpattern system.

tsw_help_display is aimed at plugin developers who want to display their plugin help contents on their web site without the hassle of having to keep both the web site and the actual plugin help in synch. tsw_help_display allows you to display the actual plugin help contents on your web site. Now, if you make updates to your plugin and it's help contents, just install the updated plugin to your Textpattern system and voilà, the description page you keep for your plugin is automatically updated too.

Attributes:

plugin

Name of the plugin for which the help contents will be displayed.

Default: ''
Example: plugin='myplugin'

wraptag (optional)

HTML tag used to wrap around the plugin's help contents.

Default: ''
Example: wraptag='div'

wrapclass (optional)

class attribute to be added to the wraptag.

Default: ''
Example: wrapclass='plughelp'

Usage examples

Using the tag to display the help contents of 'myplugin'.

<txp:tsw_help_display plugin='myplugin' />

Using the tag to display the help contents of 'myplugin' and wrapping the help contents in a 'div' tag with a class attribute of 'plughelp'.

<txp:tsw_help_display wraptag='div' wrapclass='plughelp' />

File Download

File: tsw_help_display_v0.1.txt [4.45KB]

Downloads: 600