search

Automattic / super-cool-ad-inserter-plugin

Insert ads, newsletter signup widgets, and calls to action in the middle of your posts!
https://wordpress.org/plugins/super-cool-ad-inserter/#description
32 stars 4 forks source link

scaip_how_to_shortcode_callback should have an action for theme-defined options to be added. #15

Closed benlk closed 8 years ago

benlk commented 8 years ago

Somewhere about here: https://github.com/INN/super-cool-ad-inserter-plugin/blob/master/inc/scaip-metaboxes.php#L19

The plugin should run a scaip_additional_docs action so that theme devs can document additional shortcode options in a user-facing way.

rnagle commented 8 years ago

I really think the meta box should be pretty spare. By default it should show only the checkbox used to prevent ads from being inserted.

Instead of placing docs inline, we should conveniently place, in the meta box, a link to the readme on Github or the appropriate page on RTD. We might even add a filter to said link so that a theme dev can add stuff if they really want to.

Think of it this way -- if there were inline docs for all available shortcodes (or any obfuscated post editor functionality for that matter) the dashboard would be a terrifying, confusing place.

benlk commented 8 years ago

That makes sense, you've convinced me.