You are here

README.txt in Superfish 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
Superfish module

About
-----
This module allows for integration of jQuery Superfish plug-in with Drupal CMS.


Requirements
-----------
- Superfish library 1.x
  https://github.com/mehrpadin/Superfish-for-Drupal/archive/1.x.zip
- JQuery 1.6.1 or higher, if you are going to use the jQuery Easing plugin.
  https://www.drupal.org/project/jquery_update


Installation instructions
-------------------------
1. Download and extract the Superfish library into the libraries directory
   (usually "sites/all/libraries").
   Link: https://github.com/mehrpadin/Superfish-for-Drupal/zipball/1.x.zip

2. Download and extract the Superfish module into the modules directory (usually
   "sites/all/modules").
   Link: http://drupal.org/project/superfish
   Drush users can use the command "drush superfish-plugin".

3. Go to "Administer" -> "Modules" and enable the module.

Note: Though no longer required, using Libraries API is still recommended.
      Link: http://drupal.org/project/libraries


Upgrade instructions
--------------------
Did you change any part of the module or the library?

- If you did not change the module or the library; download the latest versions
  of the module and the library and upload them (replacing the old files).

- If you did change the module or the library; use a visual comparison tool
  (such as Winmerge or Kompare, so on) in order to compare your current copy
  with its original one (http://drupal.org/node/711944/release) find out what
  was changed and do the same to the version you are upgrading to.
  WARNING: This is for experts only!

- Please note that if you are upgrading from version 1.6 running update.php will
  cause error messages to appear. To resolve this go to
  "Administer" -> "Structure" -> "Blocks", click the "Configure" link for each
  Superfish block and click "Save block" button.


Configuring the module
----------------------
- For block-specific settings go to "Administer" -> "Structure" -> "Blocks" and
  click the "Configure" link of the Superfish block.

- For module settings go to
  "Administer" -> "Configuration" -> "User Interface" -> "Superfish".

- Detailed instructions can be found at http://drupal.org/node/1125896


How to style
------------
If you know CSS, even basics of it, designing won't be a big challenge.

Here are some tips and tricks:

A) Always use a DOM inspector utility (such as Firebug).

B) Set the "Menu delay" option to a very high number such as 99999999.
   This will give you enough time to work with sub-menus.

C) If you are not using the built-in styles, set the "Style" option to "None".

D) Utilise the "Simple" style as reference; add the newly-created CSS file
   either to your theme CSS or as a new CSS file under the styles directory in
   the Superfish library (probably "sites/all/libraries/superfish/style");
   putting it in the styles folder will automatically add it to the styles list
   in the block configuration.

- More information in Superfish documentation at http://drupal.org/node/1125896


Support requests
----------------
You can request support here: http://drupal.org/project/issues/superfish


How to help?
------------
Glad you asked that :)

- Help find bugs!
- Suggest new features!
- Test the beta versions!
- Translate the UI into your language!

File

README.txt
View source
  1. Superfish module
  2. About
  3. -----
  4. This module allows for integration of jQuery Superfish plug-in with Drupal CMS.
  5. Requirements
  6. -----------
  7. - Superfish library 1.x
  8. https://github.com/mehrpadin/Superfish-for-Drupal/archive/1.x.zip
  9. - JQuery 1.6.1 or higher, if you are going to use the jQuery Easing plugin.
  10. https://www.drupal.org/project/jquery_update
  11. Installation instructions
  12. -------------------------
  13. 1. Download and extract the Superfish library into the libraries directory
  14. (usually "sites/all/libraries").
  15. Link: https://github.com/mehrpadin/Superfish-for-Drupal/zipball/1.x.zip
  16. 2. Download and extract the Superfish module into the modules directory (usually
  17. "sites/all/modules").
  18. Link: http://drupal.org/project/superfish
  19. Drush users can use the command "drush superfish-plugin".
  20. 3. Go to "Administer" -> "Modules" and enable the module.
  21. Note: Though no longer required, using Libraries API is still recommended.
  22. Link: http://drupal.org/project/libraries
  23. Upgrade instructions
  24. --------------------
  25. Did you change any part of the module or the library?
  26. - If you did not change the module or the library; download the latest versions
  27. of the module and the library and upload them (replacing the old files).
  28. - If you did change the module or the library; use a visual comparison tool
  29. (such as Winmerge or Kompare, so on) in order to compare your current copy
  30. with its original one (http://drupal.org/node/711944/release) find out what
  31. was changed and do the same to the version you are upgrading to.
  32. WARNING: This is for experts only!
  33. - Please note that if you are upgrading from version 1.6 running update.php will
  34. cause error messages to appear. To resolve this go to
  35. "Administer" -> "Structure" -> "Blocks", click the "Configure" link for each
  36. Superfish block and click "Save block" button.
  37. Configuring the module
  38. ----------------------
  39. - For block-specific settings go to "Administer" -> "Structure" -> "Blocks" and
  40. click the "Configure" link of the Superfish block.
  41. - For module settings go to
  42. "Administer" -> "Configuration" -> "User Interface" -> "Superfish".
  43. - Detailed instructions can be found at http://drupal.org/node/1125896
  44. How to style
  45. ------------
  46. If you know CSS, even basics of it, designing won't be a big challenge.
  47. Here are some tips and tricks:
  48. A) Always use a DOM inspector utility (such as Firebug).
  49. B) Set the "Menu delay" option to a very high number such as 99999999.
  50. This will give you enough time to work with sub-menus.
  51. C) If you are not using the built-in styles, set the "Style" option to "None".
  52. D) Utilise the "Simple" style as reference; add the newly-created CSS file
  53. either to your theme CSS or as a new CSS file under the styles directory in
  54. the Superfish library (probably "sites/all/libraries/superfish/style");
  55. putting it in the styles folder will automatically add it to the styles list
  56. in the block configuration.
  57. - More information in Superfish documentation at http://drupal.org/node/1125896
  58. Support requests
  59. ----------------
  60. You can request support here: http://drupal.org/project/issues/superfish
  61. How to help?
  62. ------------
  63. Glad you asked that :)
  64. - Help find bugs!
  65. - Suggest new features!
  66. - Test the beta versions!
  67. - Translate the UI into your language!