Stripping CVS keywords
[project/qtip.git] / README.txt
1 -- SUMMARY --
2 qTip is another tooltip module for Drupal. By using a simple input filter in your
3 code you can have a stylish tooltip in just seconds.
4
5
6 -- REQUIREMENTS --
7 You must download and install the qTip library from
8 http://craigsworks.com/projects/qtip/download/
9 This library is licensed under MIT and therefore is not allowed to be on drupal.org
10
11 Make sure that you select the 'Production' option. You may download the development
12 option as well if you would like to check out the code, but this module depends
13 on the compressed 'Production' version of the library.
14
15 Place the extracted contents of the library into /path/to/qtip/library
16
17
18 -- INSTALLATION --
19
20 * Install as usual (see dependency above), see http://drupal.org/node/70151 for further information.
21
22
23 -- CONFIGURATION --
24
25 * Once installed, go to admin/settings/qtip
26     * Select how you would like your qTips to display. Save.
27 * Go to admin/settings/filters
28     * Click 'configure' on the input filter that you would like to add qTip to
29       NOTE: For input filters that have 'HTML filter' enabled (like Filtered HTML), qTip MUST be weighted heavier than HTML filter
30         This should be default, but it would be a good idea to check.
31     * Save and repeat for as many input filters as you would like.
32 * On a node page enter the filter with the following format:
33   [qtip:Name of link (target) text|Text to appear in tooltip]
34     The filter MUST start with '[qtip:' (no quotes)
35     The visible text that will always show on the node page and will be used as a link to
36       the tooltip comes next, followed by | (pipe)
37     Finally, the text you would like to appear in the tooltip is last, followed by ']' (no quotes)
38
39
40 -- MAINTAINERS --
41 Current maintainers:
42 * Jacob Neher (bocaj) - http://drupal.org/user/582042
43
44
45 -- SPECIAL THANKS --
46 To Craig Thompson, creator of the qTip jQuery plugin!
47 http://craigsworks.com