Plugin Help Viewer

Here is a plugin for plugin developers!

Use this plugin to slash this work-flow…

• Edit in your code editor.
• Compile the plugin.
• Copy and paste the compiled file to the plugins upload textarea and hit ‘upload’.
• Scroll to the bottom of the page and hit install.
• Locate your plugin in the plugin list and click on the ‘help’ link.
• View your textile formatted help file.

to this…

• Edit in your code editor.
• Hit refresh to view your textile formatted help file.

That’s quite a reduction!

This plugin also knows how to extract the straight HTML help section from ied_plugin_composer formatted plugins.

All of the above assumes you are developing your plugins in the plugin cache directory.

Downloads

The latest version is available here—as are any prior versions.

• Plugin Help Viewer v0.2.zip [13.35KB]
  v0.2 of the Plugin help viewer. : 589 download(s)
  
  
• Plugin Help Viewer.zip [13.07KB]
  v0.1 of the Plugin help viewer. : 474 download(s)
  
  

Installation & Use

Goes like this…

1. Install and activate the plugin.
2. Look for ‘Plugin Help Viewer’ under the ‘extensions’ tab.
3. Choose the help link next to the plugin you are working on & there you have it. Keep this page open so you only have to hit refresh to see the changes you are making in your external editor.

Enhancements

I look forward to Yura (a.k.a. Inspired) working the help viewing features into ied_plugin_composer.

Version History

v0.2 Fixes undefined variable errors when the plugin cache directory is empty.

v0.1 Initial release supporting Zem and Yura style templates.

Credits

This plugin has been helped along by the fact that Zem’s great work on the plugin template and the plugin compiler—and to the fact that it is under the GPL.

Yura has kindly allowed me to use some of the code from plugin composer in this plugin.

Thank you both!