Tipsy

From IThemes Codex
(Difference between revisions)
Jump to: navigation, search
(Shortcode)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{#ev:vimeo|30376241|400|right}}
+
__NOTOC__
  
Tipsy is available as a [http://pluginbuddy.com/purchase/tipsy/ stand-alone plugin] or as part of the [http://pluginbuddy.com/purchase/displaybuddy/ DisplayBuddy series]. [http://demos.ithemes.com/tipsy/ See a demo here] or [http://trials.ithemes.com/tipsy/ try it out in WordPress live!]
+
[[File:Tipsy300.png|Tipsy300.png|300px|link=|right]]
  
 
==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.
 
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==
+
Tipsy is available as a [http://ithemes.com/purchase/tipsy/ stand-alone plugin] or as part of the [http://ithemes.com/purchase/displaybuddy/ DisplayBuddy series]. [http://demos.ithemes.com/tipsy/ See a demo here] or [http://trials.ithemes.com/tipsy/ try it out in WordPress live!]
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==
+
<br />
6 different tooltip layouts to choose from.
+
  
Tipsy uses oembed for embedding media within the tooltip. See a list of what media oembed supports [http://oembed.com/ here ]
+
{{#ev:vimeo|30376241|400|right}}
 
+
 
+
==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 <code>[tipsy content="tip content goes here" use_oembed='false' group="0"]content that the tip applies to[/tipsy]</code>
+
 
+
===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)
+
 
+
==Template Tag==
+
You can manually call Tipsy if you know the Group ID.
+
 
+
<pre class="brush:php">
+
<?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 */
+
?>
+
</pre>
+
<pre class="brush:php">
+
<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
+
 
+
) ); ?>
+
</pre>
+
 
+
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.
+
<div class="exchange-home-list">
 +
==Tipsy Basics== __NOEDITSECTION__
 +
*[[Tipsy_Groups|Groups]]
 +
**[[Tipsy_Group_Settings|Group Settings]]
 +
*[[Tipsy_Feature_Overview|Feature Overview]]
 +
*[[Displaying_Tipsy_on_Your_Site|Displaying Tipsy on Your Site]]
 +
*[[Displaying_Videos_Inside_Tipsy_Shortcode|Displaying Videos Inside Tipsy Shortcode]]
 +
*[[Displaying_Images_Inside_Tipsy_Shortcode|Displaying Images Inside Tipsy Shortcode]]
 +
*[[Displaying_iFrames_Inside_Tipsy_Shortcode|Displaying iFrames Inside Tipsy Shortcode]]
 +
</div>
  
'''Tip Content''' - Default content that goes inside the tooltip itself.
+
<div class="exchange-home-list">
 +
==Tipsy Advanced== __NOEDITSECTION__
 +
*[[Special_Characters|Special Characters]]
 +
*[[New_Lines|New Lines]]
 +
*[[HTML_Code|HTML Code]]
 +
*[[Template_Tags|Template Tags]]
 +
*[[Displaying_Images_Inside_Tipsy_Shortcode|Displaying Images Inside Tipsy Shortcode]]
 +
*[[Displaying_iFrames_Inside_Tipsy_Shortcode|Displaying iFrames Inside Tipsy Shortcode]]
 +
</div>
  
 +
<div class="exchange-home-list">
 +
==Customize Tipsy== __NOEDITSECTION__
 +
*[http://ithemes.com/codex/page/Extra_Customizations Official policy and details on any Extra Customizations]
 +
*[[Edit_and/or_Create_More_Layouts|Edit and/or Create More Layouts]]
 +
*[[Change_Color_of_the_Arrow_in_Default_Layout|Change Color of the Arrow in Default Layout]]
 +
*[[Change_Position_of_the_Tipsy_Box|Change Position of the Tipsy Box]]
 +
</div>
  
==Additional Resources==
+
<div class="exchange-home-list">
# [http://pluginbuddy.com/free-wordpress-plugins/ Free Plugins by PluginBuddy]
+
==Additional Resources== __NOEDITSECTION__
# [http://pluginbuddy.com/tutorials/ PluginBuddy Tutorials]
+
*[http://ithemes.com/purchase/backupbuddy/ Purchase BackupBuddy]
# [http://pluginbuddy.com/ PluginBuddy.com]
+
*[http://ithemes.com/tutorials/ iThemes Tutorials]
# [http://pluginbuddy.com/support/ Support Forums]
+
*[http://ithemes.com/ iThemes.com]
 +
*[http://ithemes.com/forum/ Support Forums]
 +
</div>
  
[[Category:PluginBuddy]]
+
<br />
 +
[[:Plugins|← Back to Plugin Codex Home]]

Latest revision as of 15:30, July 19, 2013


Tipsy300.png

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.

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!




← Back to Plugin Codex Home

Personal tools
Namespaces
Variants
Actions
iThemes Codex
Codex Navigation
Toolbox