libs/oik-sc-help.php

<?php // (C) Copyright Bobbing Wide 2012-2024
if ( !defined( "OIK_SC_HELP_INCLUDED" ) ) {
define( "OIK_SC_HELP_INCLUDED", "3.5.0" );


/**
 * Shortcode help 
 * 
 * Library: oik-sc-help
 * Provides: oik-sc-help
 * Depends: on the oik plugin, class-BW-, bobbfunc  @TODO complete this
 * Deferred dependencies: oik_plugins, class-dependencies-cache
 *
 * Implements low level functions for displaying shortcode help.
 * This includes the help functions for some base shortcodes.
 * Parts of this library file is now deprecated in favour of "class-oik-sc-help"
 *
 */

/* function bw_form_sc_get_first_parm_name() – Get first parm name */

/* function bw_form_sc_parm_help() – Return link to shortcode parameter help */

/* function bw_form_sc_syntax() – Format the shortcode syntax for returning in HTML */

/* function bw_load_shortcode_suffix() – Attempt to find the function that will handle the additional processing for the shortcode */

/* function bw_lazy_sc_help() – Display shortcode help */

/* function _bw_lazy_sc_help() – Return shortcode help */

/* function bw_lazy_sc_example() – Display a shortcode example */

/* function _bw_lazy_sc_syntax() – Return shortcode syntax */

/* function bw_lazy_sc_syntax() – Display shortcode syntax */

/* function bw_save_scripts() – Save original dependencies */


/* function bw_report_scripts() – Report queued scripts */

/* function _sc__snippet() – Produce the HTML snippet of the shortcode output */

/* function bw_lazy_sc_snippet() – Display the HTML snippet for a shortcode example */

/* function _sc__help() – Returns the help for a shortcode */

/* function _sc__syntax() – Return default syntax for this shortcode */


/* function _sc__example() – Produces default example for this shortcode */

/* function _sc_classes() – Helper functions for shortcodes that support these atts */

 
/* function _sc_posts() – Helper function for shortcodes that use bw_get_posts() */

/* function _sc_thumbnail() – Helper function for shortcodes that display images */


/* function caption__help() – */

/* function caption__example() – Example hook for caption shortcode */

/* function wp_caption__help() – */

/* function caption__syntax() – */

/* function wp_caption__syntax() – */

/* function gallery__help() – */

/* function gallery__syntax() – Syntax help for the gallery shortcode */

/* function embed__help() – Help for the embed shortcode */

/* function embed__example() – Example for the embed shortcode */

/* function embed__syntax() – Syntax for embed shortcode */

/* function audio__syntax() – Syntax for [audio] shortcode */

/* function video__syntax() – Syntax for [video] shortcode */

/* function bw_skv() – Return the default, values and notes for a shortcode parameter */

/* function bw_format_skv() – Return the choices and notes for a keywords values */

/* function bw_invoke_shortcode() – Calls a shortcode for a simple example */

/* function playlist__syntax() – Syntax for [playlist] shortcode */

/* function bw_expand_shortcode() – Expand the shortcode */

} /* end !defined */