Pophelp in plugins?

jakob · Yesterday 06:00:04

EDIT: Bringing this over from another thread but under a new topic heading:

Bloke wrote #298945:

OK, pophelp first. Register a callback on the admin_help event with a ‘step’ of the language string and your plugin will get called:

register_callback('abc_pophelp', 'admin_help', 'some_language_string_key');

While looking for a way to include pophelp in a plugin using your example above, the info on admin_help in the docs, and dissecting the pophelp function, I’ve managed to get something working but is there a better way of doing this? Adding the data-item and passing it back to pophelp resulted in a loop.

register_callback('abc_pophelp', 'admin_help', 'help_item_name');

function abc_pophelp($evt, $stp, $ui, $atts) {
	$atts['data-item'] = gTxt('pophelp_' . $atts['help_var']);
	return sp.href(span(gTxt('help'), array('class' => 'ui-icon ui-icon-help')), '#', $atts);
}

and then:

pophelp_help_item_name => My help text goes here

in the plugin’s textpack.

Non-essential but out of interest: Can I also influence the title of the pophelp box using this method? The regular pophelp provides that in the title attribute the XML entry, but the textpack format is different here.

Bloke · Yesterday 07:18:45

Hmm, that is a conundrum. I never really fathomed a way to let pophelp files be loaded from anywhere other than core’s /lang directory, and we don’t really want people adding their own strings in there, or dumping their own files in.

Ideally, a plugin should read its own lang/{lang}_pophelp.xml file from its own directory and merge it with core’s ones, just like the textpack strings are read from anything with the plugin name in the txp_lang table and merged with core strings.

The ini format of the pophelp files isn’t ideally suited for this. The good news is that once it’s read into memory using parse_ini_file() there’s no reason we can’t load a second one in and then do some creative array merging to combine them. Would have to try something out. Putting pophelp in the lang table feels wrong and, as you say, doesn’t allow you to alter the headings.

I’ll give this some thought later or tomorrow. Thanks for the nudge.

jakob · Yesterday 11:22:15

No worries. It works for now and I imagine a file-based solution entails changing the plugin folder and compression routines (and perhaps plugins that do that too). To be honest, I’m not aware of any plugins with pophelp in them.

I was initially just asking if I had gone about it using the callback right way, by excerpting only the line from the function that shows inline pophelp rather than adding the inline help string and passing it to pophelp.

Textpattern CMS

Textpattern CMS support forum

#1 Yesterday 06:00:04

Pophelp in plugins?

Bloke wrote #298945:

#2 Yesterday 07:18:45

Re: Pophelp in plugins?

#3 Yesterday 11:22:15

Re: Pophelp in plugins?

Board footer