prefix_plugin_name
A brief summary of what the plugin does.
Table of contents
- List of features
- Plugin requirements
- Installation
- Uninstallation
- Tags
- Exposed functions
- Global variables
- Plugin events
- Examples
- Support
- License
List of features
- Feature 1
- Feature 2
- Feature 3
Plugin requirements
my_plugin_name’s minimum requirements:
- Textpattern 4.x
- Plugin dependency 1
- Plugin dependency 2
Installation
Any special installation instructions (when differs from standard installation procedure).
Uninstallation
Any special uninstallation instructions (when differs from standard uninstallation procedure).
Tags
prefix_tag_name1
Description of the plugin tag and how it is intended to be used.
attribute_name
value_type
Description of the attribute usage.
attribute_name
value_type
Description of the attribute usage.
prefix_tag_name2
Description of the plugin tag and how it is intended to be used.
attribute_name
value_type
Description of the attribute usage.
attribute_name
value_type
Description of the attribute usage.
Exposed functions
my_plugin_func
This function will do foo or bar.
Return Value
return_value_type
Description of the function return value.
arg_name
arg_value_type
Argument description.
Global variables
$my_plugin_global
This array is set during blah and is false on failure.
Plugin events
my_plugin.event
This event is called when blah happens.
Examples
Example 1
A large example that puts it all together or examples to go with each tag (in which case it is probably better to include it with the tag above).
Example code
Example 2
A large example that puts it all together or examples to go with each tag (in which case it is probably better to include it with the tag above).
Example code
Support
Optional direct contact details for the plugin author.
Licence
State any special licence information here.