Version 1

[yaffs-website] / web / modules / contrib / superfish / README.txt

diff --git a/web/modules/contrib/superfish/README.txt b/web/modules/contrib/superfish/README.txt
new file mode 100644 (file)
index 0000000..e2ba5a4
--- /dev/null
+++ b/web/modules/contrib/superfish/README.txt
@@ -0,0 +1,68 @@
+Superfish module
+
+About
+-----
+This module allows for integration of jQuery Superfish plug-in with Drupal CMS.
+
+
+Requirement
+-----------
+- Superfish library.
+  Link: https://github.com/mehrpadin/Superfish-for-Drupal/
+
+
+Installation instructions (composer)
+------------------------------------
+1. Add the proper repository to your composer.json file
+    {
+      "type": "package",
+      "package": {
+        "name": "drupal-superfish/superfish",
+        "version": "2.0",
+        "type": "drupal-library",
+        "dist": {
+          "url": "https://github.com/mehrpadin/Superfish-for-Drupal/archive/2.x.zip",
+          "type": "zip"
+        }
+      }
+    }
+
+2. Require the library
+   $ composer require drupal-superfish/superfish:2.0
+
+3. Go to "Administer" -> "Modules" and enable the module.
+
+4. Go to "Administer" -> "Structure" -> "Block layout" -> click a "Place block" button to add a Superfish block to a region.
+
+
+Installation instructions (manual)
+----------------------------------
+1. Download and extract the Superfish library into the libraries directory (usually "sites/all/libraries").
+   Link: https://github.com/mehrpadin/Superfish-for-Drupal/zipball/2.x
+
+2. Download and extract the Superfish module into the modules directory (usually "/modules").
+   Link: http://drupal.org/project/superfish
+
+3. Go to "Administer" -> "Modules" and enable the module.
+
+4. Go to "Administer" -> "Structure" -> "Block layout" -> click a "Place block" button to add a Superfish block to a region.
+
+
+How to style
+------------
+
+Here are some tips and tricks:
+
+A) Utilise the "Default" style as reference.
+
+B) Always use a DOM inspector utility (such as Firebug).
+
+C) Set the "Menu delay" option in the block configuration to a very high number
+   such as 99999999 while creating your own CSS. This will give you enough time to work with sub-menus.
+
+C) If your theme supports the Superfish module, set the "Style" option in the block configuration to "None".
+
+
+Support requests
+----------------
+You can request support here: http://drupal.org/project/issues/superfish