src/cm/media/js/lib/tipsy/README
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 0 40c8f766c9b8
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     1
tipsy - Facebook-style tooltip plugin for jQuery
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     2
	(c) 2008 Jason Frame (jason@onehackoranother.com)
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     3
	Released under The MIT License.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     4
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     5
== DESCRIPTION:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     6
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     7
tipsy is a simple jQuery plugin for generating Facebook-style tooltips.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     8
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     9
== HOMEPAGE:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    10
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    11
http://onehackoranother.com/projects/jquery/tipsy
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    12
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    13
== SOURCE:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    14
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    15
Hosted at GitHub; browse at:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    16
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    17
  http://github.com/jaz303/tipsy/tree/master
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    18
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    19
Or clone from:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    20
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    21
  git@github.com:jaz303/tipsy.git
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    22
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    23
== USAGE:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    24
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    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.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    26
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    27
2. Insert the neccesary elements in your document's <head> section, e.g.:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    28
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    29
<script type='text/javascript' src='/javascripts/jquery.tipsy.js'></script>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    30
<link rel="stylesheet" href="/stylesheets/tipsy.css" type="text/css" />
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    31
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    32
Remember to include jquery.tipsy.js *after* including the main jQuery library.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    33
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    34
3. Initialise Tipsy in your document.onload, e.g.:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    35
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    36
<script type='text/javascript'>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    37
	$(function() {
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    38
		$('a[rel=tipsy]').tipsy({fade: true, gravity: 'n'});
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    39
	});
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    40
</script>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    41
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    42
Please refer to the docs directory for more examples and documentation.