Textpattern CMS support forum

You are not logged in. Register | Login | Help

#1 2006-05-18 11:32:07

net-carver
Member
From: UK
Registered: 2006-03-08
Posts: 1,648

[plugin] [ORPHAN] sed_plugin_help_viewer

sed plugin help viewer

Current version: v0.2 (updated)
Get it from the plugin help viewer homepage

Summary

This one is for all the TXP plugin devs.

It allows you to cut through the normal TXP work-flow for viewing your plugins’ help sections. Now you can edit and test your plugin help section as easily as your plugin code.

It simply lists all the plugins it finds in the cache directory and allows you to show the help file from whichever plugin you choose—it will even run it through textile if you are using zem’s template for your plugin!

Bugfix

May 26th, 2006: Just uploaded a re-compiled v0.2 that fixes a problem in it’s own help section (can you believe it!) If you are using this plugin and find that all the hyperlinks in the admin interface get recoloured when you look at its own help section then the new upload fixes it.

Credits

This plugin has been helped along 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!

Rigel reported an undefined variable bug when the cache directory is empty. Found and fixed in v0.2. Thanks Rigel!

Last edited by net-carver (2006-05-26 02:01:06)


Steve
Textile | My plugins on GitHub | @netcarver

Offline

#2 2006-05-19 15:06:32

Rigel
Member
From: España
Registered: 2005-09-02
Posts: 99
Website

Re: [plugin] [ORPHAN] sed_plugin_help_viewer

Hi net-carver,

textpattern show the following error:

Warning: Invalid argument supplied for foreach() in /textpattern/lib/txplib_misc.php(459) : eval()’d code on line 132

Thanks!

Offline

#3 2006-05-19 15:32:57

net-carver
Member
From: UK
Registered: 2006-03-08
Posts: 1,648

Re: [plugin] [ORPHAN] sed_plugin_help_viewer

Thanks for that Rigel, fixed and v0.2 uploaded to the website.

v0.1 still works fine for the case of a non-empty plugin cache directory.

Thanks again! Please report any more problems here.


Steve
Textile | My plugins on GitHub | @netcarver

Offline

#4 2007-03-31 04:36:52

Mary
Sock Enthusiast
Registered: 2004-06-27
Posts: 6,236

Re: [plugin] [ORPHAN] sed_plugin_help_viewer

Very handy, makes things much easier. Would it be possible to detect and account for a plugin’s allow_html_help setting?

Offline

#5 2007-03-31 08:38:59

net-carver
Member
From: UK
Registered: 2006-03-08
Posts: 1,648

Re: [plugin] [ORPHAN] sed_plugin_help_viewer

Mary

can you clear up something for me first as I didn’t closely follow the discussion of the new plugin settings; does that setting mark the help section as being straight HTML rather than textile – or does it work in a more mysterious way?


Steve
Textile | My plugins on GitHub | @netcarver

Offline

#6 2007-04-01 03:14:38

Mary
Sock Enthusiast
Registered: 2004-06-27
Posts: 6,236

Re: [plugin] [ORPHAN] sed_plugin_help_viewer

…does that setting mark the help section as being straight HTML rather than textile…?

Yep. If the value for allow_html_help is 1 then it is (X)HTML. If the value is 0 or not set at all, then it is Textile.

Edit: I neglected to mention that when it is (X)HTML, $plugin['help_raw'] is used, rather than $plugin['help'].

Last edited by Mary (2007-04-02 17:39:25)

Offline

#7 2007-04-01 18:50:16

net-carver
Member
From: UK
Registered: 2006-03-08
Posts: 1,648

Re: [plugin] [ORPHAN] sed_plugin_help_viewer

Mary

you should have something by email.


Steve
Textile | My plugins on GitHub | @netcarver

Offline

#8 2008-03-20 04:26:41

jm
Plugin Author
From: Missoula, MT
Registered: 2005-11-27
Posts: 1,746
Website

Re: [plugin] [ORPHAN] sed_plugin_help_viewer

Hey Steve – just wanted to say thanks! This is a lot easier than pasting the help into a new article!

Offline

#9 2017-03-14 18:58:57

jsoo
Plugin Author
From: NC, USA
Registered: 2004-11-15
Posts: 1,781
Website

Re: [plugin] [ORPHAN] sed_plugin_help_viewer

With many thanks to Steve for his most excellent plugin, which I’ve relied on for years, I recently changed to a new plugin template and compiler, and so I needed a new version of the help viewer. Anyone still using the default plugin template, who is tired of having the help text in the same file as the code, can read about my modification of Steve’s plugin here.


Code is topiary

Offline

Board footer

Powered by FluxBB