shortcodes/oik-codes.php

<?php
/*

    Copyright 2012-2017 Bobbing Wide (email : herb@bobbingwide.com )

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 2,
    as published by the Free Software Foundation.

    You may NOT assume that you can use any other version of the GPL.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    The license for this software can likely be found here:
    http://www.gnu.org/licenses/gpl-2.0.html

*/
oik_require( "includes/oik-sc-help.php" );

/* function bw_code_link() – Create a link to the shortcode if in admin pages */

/* function bw_get_shortcode_callback() – Return the shortcode’s callback function */

/* function bw_get_shortcode_function() – Return the function to invoke for the shortcode */

/* function bw_get_shortcode_expands_in_titles() – Return Yes / No to indicate if a shortcode expands in titles */

/* function bw_get_shortcode_syntax_link() – Display the shortcode, syntax and link */

/* function bw_sc_link() – Display a link to "external" shortcode help */

/* function bw_help_table() – Table header for bw_codes */

/* function bw_help_etable() – table footer for bw_codes */

/* function bw_shortcode_list() – Return an associative array of shortcodes and their one line descriptions (help) */

/* function bw_list_shortcodes() – Produce a table of shortcodes */

/* function bw_codes() – Display a table of active shortcodes */

/* function bw_code() – Display information about a specific shortcode */


/* function bw_code_example_link() – Create a nicely formatted link to the definition of the shortcode */

 
/* This is NOT part of the docblock! 
 *
 * Decisions are:
 * Value | Meaning
 * ----- | --------------
 * blank | not yet decided
 * n | shortcode will not be registered to shortcake, shortcake will not attempt to expand it
 * y | shortcode will be registered to shortcake, shortcake will attempt to expand it
 * 0 | shortcode will not work properly if written using positional parameters - but we'll let it pass for the time being
 *
 *
 * We'll err towards y even though the shortcode may produce a lot of output
 * diy-oik shortcodes should implement their own filter.
 * In this list diy-oik shortcodes had a ? - as I was using the wrong version of diy-oik
 * Shortcodes which used to have a ? may now show the implementing function
 *
 * Decision | shortcode | description
 * -------- | --------- | --------------------------
 y |   OIK | Spells out the <span class="bw_oik"><abbr  title="OIK Information Kit">oik</abbr></span> backronym
 y |   api | Simple API link
 y |   apiref | ?
 y |  apis | Link to API definitions
 y |   archives | ?
 y |  artisteer | Styled form of Artisteer
   |  audio | Displays uploaded audio file as an audio player
   |  bandcamp | ?
   |  bbboing | Obfuscate some text but leave it readable, apparently
   |  blip.tv | ?
 y |   bp | Styled form of BuddyPress
 y |  bw | Expand to the logo for Bobbing Wide
 y  | bw_abbr | Format an abbreviation
   | bw_accordion | Display posts in an accordion
 y | bw_acronym | Format an acronym
   | bw_action | ?
 y  | bw_address | Display the address
 y | bw_admin | Display the Admin contact name
 y  | bw_alt_slogan | Alternative slogan
 y | bw_api | Dynamic API syntax help
   | bw_attachments | List attachments with links
   | bw_autop | Dynamically re-enable/disable automatic paragraph generation
   | bw_background | Use attached image as the background
   | bw_block | Format an Artisteer block
   | bw_blockquote | Format a blockquote
   | bw_blog | Select blog to process
   | bw_blogs | List blogs using bw_pages style display
   | bw_bookmarks | List bookmarks
   | bw_business | Display your Business name
   | bw_button | Show a link as a button
   | bw_cite | Cite a blockquote
  n | bw_code | Display the help and syntax for a shortcode
  n | bw_codes | Display the currently available shortcodes