www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/superfish/README.txt

   1 Superfish module
   2
   3 About
   4 -----
   5 This module allows for integration of jQuery Superfish plug-in with Drupal CMS.
   6
   7
   8 Requirement
   9 -----------
  10 - Superfish library.
  11   Link: https://github.com/mehrpadin/Superfish-for-Drupal/
  12
  13
  14 Installation instructions (composer)
  15 ------------------------------------
  16 0. You can skip this step if you use the popular
  17    https://github.com/drupal-composer/drupal-project.
  18    Otherwise check that your composer.json file has directives to install
  19    libraries in the libraries directory like this:
  20
  21     "require": {
  22       "composer/installers": "^1.0",
  23     },
  24     "extra": {
  25         "installer-paths": {
  26             "web/libraries/{$name}": ["type:drupal-library"]
  27         }
  28     }
  29
  30     This assumes that your drupal root resides in the "web" direectory.
  31     If it is in another directory (e.g. "docroot"), change accordingly.
  32
  33 1. Require the module
  34
  35     $ composer require drupal/superfish
  36
  37    Composer will then put the module *and* its library into the right places.
  38
  39 2. Go to "Administer" -> "Modules" and enable the module.
  40
  41 3. Go to "Administer" -> "Structure" -> "Block layout" -> click a "Place block"
  42    button to add a Superfish block to a region.
  43
  44
  45 Installation instructions (manual)
  46 ----------------------------------
  47 1. Download and extract the Superfish library into the libraries directory
  48    (usually "DRUPAL_ROOT/libraries").
  49    Link: https://github.com/mehrpadin/Superfish-for-Drupal/zipball/2.x
  50
  51 2. Download and extract the Superfish module into the modules directory
  52    (usually "DRUPAL_ROOT/modules").
  53    Link: http://drupal.org/project/superfish
  54
  55 3. Go to "Administer" -> "Modules" and enable the module.
  56
  57 4. Go to "Administer" -> "Structure" -> "Block layout" -> click a "Place block"
  58    button to add a Superfish block to a region.
  59
  60
  61 How to style
  62 ------------
  63
  64 Here are some tips and tricks:
  65
  66 A) Utilise the "Default" style as reference.
  67
  68 B) Always use a DOM inspector utility (such as Firebug).
  69
  70 C) Set the "Menu delay" option in the block configuration to a very high number
  71    such as 99999999 while creating your own CSS. This will give you enough time
  72    to work with sub-menus.
  73
  74 C) If your theme supports the Superfish module, set the "Style" option in the
  75    block configuration to "None".
  76
  77
  78 Support requests
  79 ----------------
  80 You can request support here: http://drupal.org/project/issues/superfish