src/cm/media/js/lib/tipsy/README
changeset 0 40c8f766c9b8
equal deleted inserted replaced
-1:000000000000 0:40c8f766c9b8
       
     1 tipsy - Facebook-style tooltip plugin for jQuery
       
     2 	(c) 2008 Jason Frame (jason@onehackoranother.com)
       
     3 	Released under The MIT License.
       
     4 
       
     5 == DESCRIPTION:
       
     6 
       
     7 tipsy is a simple jQuery plugin for generating Facebook-style tooltips.
       
     8 
       
     9 == HOMEPAGE:
       
    10 
       
    11 http://onehackoranother.com/projects/jquery/tipsy
       
    12 
       
    13 == SOURCE:
       
    14 
       
    15 Hosted at GitHub; browse at:
       
    16 
       
    17   http://github.com/jaz303/tipsy/tree/master
       
    18 
       
    19 Or clone from:
       
    20 
       
    21   git@github.com:jaz303/tipsy.git
       
    22 
       
    23 == USAGE:
       
    24 
       
    25 1. Copy the contents of src/{images,javascripts,stylesheets} to the corresponding asset directories in your project. If the relative path of your images directory from your stylesheets directory is not "../images", you'll need to adjust tipsy.css appropriately.
       
    26 
       
    27 2. Insert the neccesary elements in your document's <head> section, e.g.:
       
    28 
       
    29 <script type='text/javascript' src='/javascripts/jquery.tipsy.js'></script>
       
    30 <link rel="stylesheet" href="/stylesheets/tipsy.css" type="text/css" />
       
    31 
       
    32 Remember to include jquery.tipsy.js *after* including the main jQuery library.
       
    33 
       
    34 3. Initialise Tipsy in your document.onload, e.g.:
       
    35 
       
    36 <script type='text/javascript'>
       
    37 	$(function() {
       
    38 		$('a[rel=tipsy]').tipsy({fade: true, gravity: 'n'});
       
    39 	});
       
    40 </script>
       
    41 
       
    42 Please refer to the docs directory for more examples and documentation.