Documentation for shortcode usage

Resolved Steve Kimpton
(@stevekimpton)

11 years ago

I wonder how I should document a shortcode?

I wrote my first experimental short codes a little while ago and recently wanted to use one of them in a real site but couldn’t remember how it should be formatted. It was of the form:

[create_link_to_supplier id=nnnnnn, tag=xxxxx, user=’yyyyy’];

The only way I can see is via a plugin so that some text can appear on the plugins section of the dashboard. Is there a neater solution?

Viewing 4 replies - 1 through 4 (of 4 total)

Moderator t-p
(@t-p)

11 years ago

see if info in these WP codex helps:

http://codex.wordpress.org/Shortcode_API
http://codex.wordpress.org/Shortcode

Thread Starter Steve Kimpton
(@stevekimpton)

11 years ago

Thanks for the links.

They explain how to create and use shortcodes but not how to document a specific shortcode.

In the example I gave, I needed to remember the name of the plugin (create_link_to_supplier), and the name of the attributes (id, tag, user).

I’d hoped that there would be some standard way of doing shortcode documentation – as there is with a plugin – but couldn’t find it. Maybe that’s just the way it is 🙂
Moderator keesiemeijer
(@keesiemeijer)

11 years ago
You can add text to the help tab. This next example will add some text to the help tab when you create or edit posts:
```
add_action( 'load-post.php', 'add_shortcode_help_tab' );
add_action( 'load-post-new.php', 'add_shortcode_help_tab' );

function add_shortcode_help_tab() {
	$screen = get_current_screen();
	if ( $screen->id == 'post' ) {
		// documentation for shortcode
		$content = '<p>';
		$content .= __( "this is documentation text for my shortcode", 'text-domain' );
		$content .= '</p>';

		$screen->add_help_tab( array(
			'id'      => 'shortcode_overview',
			'title'   => __( 'My Shortcode' ),
			'content' => $content,
			)
		);
	}
}
```
Put it in your theme’s functions file.
http://codex.wordpress.org/Function_Reference/add_help_tab
http://codex.wordpress.org/Adding_Contextual_Help_to_Administration_Menus

Or try it with a plugin:
http://wordpress.org/extend/plugins/wp-help/
Thread Starter Steve Kimpton
(@stevekimpton)

11 years ago

Brilliant! – Thank you

Viewing 4 replies - 1 through 4 (of 4 total)

The topic ‘Documentation for shortcode usage’ is closed to new replies.

Documentation for shortcode usage

Topics

Topics with no replies

Non-support topics

Resolved topics

Unresolved topics

All topics