Tipsy

(Difference between revisions)
Jump to: navigation, search
(Fixed Videos and Images Shortcode syntax - Shortcode)
(Added HTML Mode info, new - SAMPLE Shortcode Text File: section, and updated media links in shortcodes)
Line 20: Line 20:
  
 
==Shortcode==
 
==Shortcode==
Display your Tipsy in style by using the shortcode <code>[tipsy content="tip content goes here" use_oembed='false' group="0"]content that the tip applies to[/tipsy]</code>
+
Display your Tipsy in style by using the shortcode <code>[tipsy content="tip content goes here" use_oembed='false' group="0"]content that the tip applies to[/tipsy]</code>. We recommend doing this in the HTML Mode editor.
  
 
===Shortcode Parameters===
 
===Shortcode Parameters===
Line 29: Line 29:
 
===Display Videos inside Tipsy Shortcode===
 
===Display Videos inside Tipsy Shortcode===
  
Use the following format to show YouTube videos inside the Tipsy tooltip. Change the video link to any YouTube link you wish:
+
Use the following format to show YouTube videos inside the Tipsy tooltip in the HTML Mode editor. Change the video link to any YouTube link you wish:
  
<code>[tipsy content="http://www.youtube.com/watch?v=wf_IIbT8HGk" use_oembed='true' group="0"]content that the tip applies to[/tipsy]</code>
+
<code>[tipsy content="http://www.youtube.com/watch?v=FDHNequGw4k" use_oembed='true' group="0"]content that the tip applies to[/tipsy]</code>
  
 
===Display Images inside Tipsy Shortcode===
 
===Display Images inside Tipsy Shortcode===
  
Use the following format to show images inside the Tipsy tooltip. Change the image link to any image link online:
+
Use the following format to show images inside the Tipsy tooltip in the HTML Mode editor. Change the image link to any image link online:
  
<code>[tipsy content='<img src="http://www.googlestore.com/images/googlestore_large.gif">' group="0" ]content that the tip applies to[/tipsy]</code>
+
<code>[tipsy content='<img src="http://pluginbuddy.com/files/2011/10/Tipsy-copy-150x150.png">' group="0" ]content that the tip applies to[/tipsy]</code>
 +
 
 +
===SAMPLE Shortcode Text File===
 +
 
 +
If you are having trouble copy pasting the above code OR not getting it to work, here is a sample TEXT file that you can copy paste from. Simply copy paste the contents into your Page or Post editor, in HTML Mode, test that it works, and then change the links accordingly.
  
 
==Template Tag==
 
==Template Tag==

Revision as of 20:41, October 12, 2011


Tipsy is available as a stand-alone plugin or as part of the DisplayBuddy series. See a demo here or try it out in WordPress live!


Contents

Description

The Tipsy plugin adds the ability to create tooltips for placement in posts or pages. Tooltips are displayed when hovering or clicking on specified content. This allows you to provide additional information to visitors.

Groups

The first step in adding Tipsy tooltips to your site is to create a group in the Tipsy settings. Tipsy allows you to create multiple groups with unique settings, styles, and even default tip content.

Feature Overview

6 different tooltip layouts to choose from.

Tipsy uses oembed for embedding media within the tooltip. See a list of what media oembed supports here


Displaying on your site

To add a Tooltip you will need to first be editing a page or post. Highlight the text/content that you would like to be hovered or clicked to display the tooltip. Then click the Tipsy icon in the WYSIWYG editor. Select the Tipsy group you would like to use and provide the test/content you would like to display within the Tipsy tip. This can be test or other HTML elements, even video.

Shortcode

Display your Tipsy in style by using the shortcode [tipsy content="tip content goes here" use_oembed='false' group="0"]content that the tip applies to[/tipsy]. We recommend doing this in the HTML Mode editor.

Shortcode Parameters

content · Content that goes inside of the tooltip.
group · group number for the tooltip group that you want to display.
use_oembed . true or false - Whether to embed videos or not (uses oEmbed)

Display Videos inside Tipsy Shortcode

Use the following format to show YouTube videos inside the Tipsy tooltip in the HTML Mode editor. Change the video link to any YouTube link you wish:

[tipsy content="http://www.youtube.com/watch?v=FDHNequGw4k" use_oembed='true' group="0"]content that the tip applies to[/tipsy]

Display Images inside Tipsy Shortcode

Use the following format to show images inside the Tipsy tooltip in the HTML Mode editor. Change the image link to any image link online:

[tipsy content='<img src="http://pluginbuddy.com/files/2011/10/Tipsy-copy-150x150.png">' group="0" ]content that the tip applies to[/tipsy]

SAMPLE Shortcode Text File

If you are having trouble copy pasting the above code OR not getting it to work, here is a sample TEXT file that you can copy paste from. Simply copy paste the contents into your Page or Post editor, in HTML Mode, test that it works, and then change the links accordingly.

Template Tag

You can manually call Tipsy if you know the Group ID.

<?php
/*
* pb_tipsy()
* Insert a Tipsy tooltip
*
*
* 		The defaults for the parameter $args are:
*		content - Default is an empty string - The content to show in the tooltip
*		group - Default is 0 - The Group ID (you can get this from the Tipsy settings)
*		filler - Default is an empty string - The text that people hover/click on to view the tooltip
*		use_oembed - Default is false - Whether you intend to use oembed to embed a video
*
*
* @param array $args Elements that make up a voting group to insert.
* @return Tip HTML on success */
?>
<td id="accordion" align="left">
<?php echo pb_tipsy( array(
	'content' => 'http://www.youtube.com/watch?v=NfBsRc0R3Ps&hd=1',
	'filler' => 'Admin Dashboard',
	'group' => 1,
        'use_oembed' => true

) ); ?>

To see a live example of this template tag in use, please download our Tipsy Page Template (should be able to drop into any theme to test it): File:Tipsy.php.zip

Group Settings

Here is a list of all of the Tipsy settings and a description of what each setting controls.

Group Title - This setting will allow you to change the title of the group at any time.

Tip activation - Method upon which the tooltip is activated. Can be set on hover, focus, or click.

Tip Position - Default orientation tooltip should show up as. You can set it to: "top", "bottom", "left" or "right".

Auto hide - When set to true the tooltip will only fadeout when you hover over the actual tooltip and then hover off of it.

Max width - CSS max-width property for the Tipsy element.

Edge offset - Distances the Tipsy popup from the element with tooltip applied to it by the number of pixels specified.

Display delay - Number of milliseconds to delay before showing the Tipsy popup after you mouseover an element with tooltip applied to it.

Fade in speed - Speed at which the Tipsy popup will fade into view.

Fade out speed - Speed at which the Tipsy popup will fade out of view.

Tip Content - Default content that goes inside the tooltip itself.


Additional Resources

  1. Free Plugins by PluginBuddy
  2. PluginBuddy Tutorials
  3. PluginBuddy.com
  4. Support Forums
Personal tools
Namespaces
Variants
Actions
iThemes Codex
Codex Navigation
Toolbox