Skip to content

Docs_reference_shortcodes

beingzoe edited this page · 1 revision

Appliance: Marketing: JIT (Just-in-Time) Sidebar

Widget! Drop this widget in your sidebar above the last couple things in a sidebar and they will magically float with the page once they are scrolled to the top. Perfect for important navigation or “promotional” call to action content.


Usage Summary

$my_theme->load('jit_sidebar');

Then just add the widget to the appropriate sidebar just above the items you wish to “float”.


Usage Notes

Requires jQuery. Does not work in IE6.

The script will not trigger the floating if it detects that the height of the items being floated is taller than the height of the current browser viewport. Otherwise there would be content that would never be reachable.


Roadmap Notes

There are issues in certain layouts where the floating JIT sidebar overlaps the site footer in an unattractive way. This will be improved to prevent that from happening.

Clone this wiki locally

Reference: Shortcodes

The following shortcodes are only available if you are using the appliance or plugin that creates them.


Appliance: mp3player

Found in /lib/functions/mp3player


[mp3player]

Creates a flash mp3 player. See the mp3player appliance wiki page for details about the player.

Usage

[mp3player mp3='path/to/mp3/file.mp3' class='mp3_player' width='300' height='20'] // No closing

Parameters

  • mp3 => ‘/path/or/url/to/mp3/file.mp3’ (required)
  • class => ‘custom_class_for_css’ (optional; defaults to ‘mp3_player’)
  • width => integer (optional; defaults to 300)
  • height => integer (optional; defaults to 20)



Appliance: Slideshow: Malsup Cycle

Found in /lib/functions/jquery/cycle.php

N.B.: All of the cycle slideshow shortcodes work together to create one cycle content area from plain content and images within the post/page editor. While multiple slideshows will be displayed in the Loop you can only add one slideshow directly to any ONE post or page at at time.


[cycle_slide]

Creates one slide for a slide show. At least two slides are required (for obvious reasons).

Usage


[cycle_slide] Any valid html/content [/cycle_slide]
[cycle_slide] Any valid html/content [/cycle_slide]
[cycle_slide] Any valid html/content [/cycle_slide]

Parameters

Accepts no arguments.


[cycle_class]

Adds a custom class name to the parent container if you need multiple sizes and styling for multiple types of slideshows.

N.B.: Include only one of this shortcode per post/page.

Usage

[cycle_class] any_class [/cycle_class]

Parameters

Accepts no arguments.


[cycle_pager]

If this shortcode is included navigation (next/previous) navigation will appear.

N.B.: Include only one of this shortcode per post/page.

Usage

[cycle_nav] 

Parameters

Accepts no arguments OR CONTENT!


[cycle_header]

Any content between the open and close of this shortcode will be displayed as header content.

N.B.: Include only one of this shortcode per post/page.

Usage

[cycle_header] Any valid html/content [cycle_header]

Parameters

Accepts no arguments.


[cycle_footer]

Any content between the open and close of this shortcode will be displayed as footer content.

N.B.: Include only one of this shortcode per post/page.

Usage

[cycle_footer] Any valid html/content [cycle_footer]

Parameters

Accepts no arguments.



Appliance: Slideshow: Tools Scrollable

Found in /lib/functions/jquery/scrollables.php

N.B.: All of the scrollables shortcodes work together to create one scrollable content area from plain content and images within the post/page editor. While multiple slideshows will be displayed in the Loop you can only add one slideshow directly to any ONE post or page at at time.


[scrollable_slide]

Creates one slide for a slide show. At least two slides are required (for obvious reasons).

Usage


[scrollable_slide] Any valid html/content [/scrollable_slide]
[scrollable_slide] Any valid html/content [/scrollable_slide]
[scrollable_slide] Any valid html/content [/scrollable_slide]

Parameters

Accepts no arguments.


[scrollable_class]

Adds a custom class name to the parent container if you need multiple sizes and styling for multiple types of slideshows.

N.B.: Include only one of this shortcode per post/page.

Usage

[scrollable_class] any_class [/scrollable_class]

Parameters

Accepts no arguments.


[scrollable_nav]

If this shortcode is included navigation (next/previous) navigation will appear.

N.B.: Include only one of this shortcode per post/page.

Usage

[scrollable_nav] 

Parameters

Accepts no arguments OR CONTENT!


[scrollable_header]

Any content between the open and close of this shortcode will be displayed as header content.

N.B.: Include only one of this shortcode per post/page.

Usage

[scrollable_header] Any valid html/content [scrollable_header]

Parameters

Accepts no arguments.


[scrollable_footer]

Any content between the open and close of this shortcode will be displayed as footer content.

N.B.: Include only one of this shortcode per post/page.

Usage

[scrollable_footer] Any valid html/content [scrollable_footer]

Parameters

Accepts no arguments.



Appliance: ‘wp_sensible_defaults’

Found in /lib/functions/wp_sensible_defaults

[wp_caption] and [caption]

Used by KST to force common caption formatting in all instances controlled entirely by CSS. These shortcodes take no parameters except $content (between an opening and closing shortcode tags. The output for styling in all cases is:


<div class="wp_caption">
    $content
</div>

Usage

[wp_caption]My caption goes here[caption]



Bundled base development starter themes and demos

Not all shortcodes may exist in every bundled theme.

template_contact.php

[contact_form]

This shortcode is created and added within the template. This allows the blog owner to have more control over the content before and after the contact form since they can place the form. Completely optional but is default in most bundled themes.

Something went wrong with that request. Please try again.