You are here

README.txt in qTip (Stylish jQuery Tooltips) 7

Same filename and directory in other branches
  1. 6.2 README.txt
  2. 6 README.txt
  3. 7.2 README.txt
-- SUMMARY --
qTip is another tooltip module for Drupal. By using a simple input filter in your
code you can have a stylish tooltip in just seconds.


-- REQUIREMENTS --
You must download and install the qTip library from
http://craigsworks.com/projects/qtip/download/
This library is licensed under MIT and therefore is not allowed to be hosted on drupal.org

Make sure that you select the 'Production' option. You may download the development
option as well if you would like to check out the code and select to use it on the
admin settings page (under Advanced options), but it is recommended that you use the
compressed 'Production' version of the library on production (live) sites.

Place the extracted contents of the library into /sites/all/libraries/qtip
NOTE: You may have to create the libraries directory
  You should end up with something like this:
    /sites/all/libraries
      /qtip (You will need to create this directory)
        jquery.qtip-1.0.0-rc3.min.js
        REQUIREMENTS
        INSTALL
        LICENSE


-- INSTALLATION --
* Install as usual (see dependency above), see http://drupal.org/node/70151 for further information.


-- CONFIGURATION --
* Once installed, go to admin/config/user-interface/qtip
    * Select how you would like your qTips to display. Save.
* If you want to use simple tooltips via a filter:
    * Go to admin/settings/filters
        * Click 'configure' on the input filter that you would like to add qTip to
          NOTE: For input filters that have 'HTML filter' enabled (like Filtered HTML), qTip MUST be weighted heavier than HTML filter
            This should be default, but it would be a good idea to check.
    * Save and repeat for as many input filters as you would like.
    * On a node page enter the filter with the following format:
      [qtip:Name of link (target) text|Text to appear in tooltip]
        The filter MUST start with '[qtip:' (no quotes)
        The visible text that will always show on the node page and will be used as a link to
        the tooltip comes next, followed by | (pipe)
        Finally, the text you would like to appear in the tooltip is last, followed by ']' (no quotes)
* To use more advanced (including HTML markup) tooltips:
  NOTE: For input filters that have 'HTML filter' enabled (like Filtered HTML), this option will not work!
    * Use the following structure on a node page
        * <span class="qtip-link">
            <div class="qtip-header">Tooltip Heading (optional)</div>
            <div class="qtip-tooltip">Tooltip content</div>
            Link text to tooltip
          </span>
        * You do not have to specify a heading.
        * The tooltip content area can contain any HTML markup.
* Below is a template of each tooltip HTML structure. Use this for custom CSS styling
    FROM: http://craigsworks.com/projects/qtip/docs/#structure
    <div class="qtip qtip-stylename">
       <div class="qtip-tip" rel="cornerValue"></div>
       <div class="qtip-wrapper">
          <div class="qtip-borderTop"></div> // Only present when using rounded corners
          <div class="qtip-contentWrapper">
             <div class="qtip-title"> // All CSS styles...
                <div class="qtip-button"></div> // ...are usually applied...
             </div>
             <div class="qtip-content"></div> // ...to these three elements!
          </div>
          <div class="qtip-borderBottom"></div> // Only present when using rounded corners
       </div>
    </div>
    NOTE: You may have to use !important with your CSS rules as some of the rules
    are set inline by the qTip library.
    qtip-button is not yet implemented in this module


-- MAINTAINERS --
Current maintainers:
* Jacob Neher (bocaj) - http://drupal.org/user/582042

-- SPECIAL THANKS --
To Craig Thompson, creator of the qTip jQuery plugin!
http://craigsworks.com

File

README.txt
View source
  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. -- REQUIREMENTS --
  5. You must download and install the qTip library from
  6. http://craigsworks.com/projects/qtip/download/
  7. This library is licensed under MIT and therefore is not allowed to be hosted on drupal.org
  8. Make sure that you select the 'Production' option. You may download the development
  9. option as well if you would like to check out the code and select to use it on the
  10. admin settings page (under Advanced options), but it is recommended that you use the
  11. compressed 'Production' version of the library on production (live) sites.
  12. Place the extracted contents of the library into /sites/all/libraries/qtip
  13. NOTE: You may have to create the libraries directory
  14. You should end up with something like this:
  15. /sites/all/libraries
  16. /qtip (You will need to create this directory)
  17. jquery.qtip-1.0.0-rc3.min.js
  18. REQUIREMENTS
  19. INSTALL
  20. LICENSE
  21. -- INSTALLATION --
  22. * Install as usual (see dependency above), see http://drupal.org/node/70151 for further information.
  23. -- CONFIGURATION --
  24. * Once installed, go to admin/config/user-interface/qtip
  25. * Select how you would like your qTips to display. Save.
  26. * If you want to use simple tooltips via a filter:
  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. * To use more advanced (including HTML markup) tooltips:
  39. NOTE: For input filters that have 'HTML filter' enabled (like Filtered HTML), this option will not work!
  40. * Use the following structure on a node page
  41. *
  42. Tooltip Heading (optional)
  43. Tooltip content
  44. Link text to tooltip
  45. * You do not have to specify a heading.
  46. * The tooltip content area can contain any HTML markup.
  47. * Below is a template of each tooltip HTML structure. Use this for custom CSS styling
  48. FROM: http://craigsworks.com/projects/qtip/docs/#structure
  49. // Only present when using rounded corners
  50. // All CSS styles...
  51. // ...are usually applied...
  • // ...to these three elements!
  • // Only present when using rounded corners