You are here

README.txt in Special menu items 7.2

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 7 README.txt
Special Menu Items Module
------------------------
Written by Tamir Al Zoubi and Karim Djelid - Servit Open Source Solutions
- www.servit.ch


Description
-----------
Special Menu Items is module that enables placeholder and separator menu items.
Placeholder is a menu item which is
actually not a link. Something like this is useful with drop down menus where we
want to have a parent link which
is actually not linking to a page but which is just acting as a parent grouping
some children below it.
A separator menu item is something like "-------" which is also not linking
anywhere but merely a mean to structure menus.

This module depends on the Menu module. It is recommended that the SimpleMenu
module or another drop down menu module
is used, or you will not be able to acess children of nolink menu items.

Features
--------
  - User can create a new menu item and place either "<nolink>" or "<separator>"
    in the Path field, without quotes.
  - When the menu is rendered the "nolink" item will be rendered similar to a
    normal menu link item, but there will
    be no link, just the title. Since version 1.3 you can change HTML tag used
    for menu item.
  - When the menu is rendered the "separator" item will be rendered as an item
    which has no link,and the default title will be "-------". Since version 1.3 it is possible to 
    change both the HTML tag and title.
  - Breadcrumb of "<nolink>" will be rendered same as "<nolink>" menu item.
  - CSS class "nolink" is added to "<nolink>" menu item.
  - CSS class "seperator" is added to "<seperator>" menu item.
  - Compatible with the Sitemap module.

Installation
------------
1. Copy the special_menu_items folder to your sites/all/modules directory.
2. At Administer -> Site building -> Modules (admin/modules) enable the module.
3. Configure the module settings at Administer -> Site configuration ->
Special Menu Items (admin/config/system/special_menu_items).

Upgrading
---------
Just overwrite (or replace) the older special_menu_items folder with the newer
version.

Performance Implications
------------------------
Special Menu Items implements THEME_link() to change the rendering of links. For link heavy pages, this may 
result in reduced performance. The THEME_link() function can be disabled with a variable in settings.php, but 
you will then need to implement the markup changes yourself.

See the notes on the l() function and theme_link() explanation on api.drupal.org.

https://api.drupal.org/api/drupal/includes!common.inc/function/l/7
https://api.drupal.org/api/drupal/includes!theme.inc/function/theme_link/7

Contact
-------
This module is developed by Servit Open Source Solutions - http://servit.ch
and maintained by Khaled Zaidan - zaidan@servit.ch

File

README.txt
View source
  1. Special Menu Items Module
  2. ------------------------
  3. Written by Tamir Al Zoubi and Karim Djelid - Servit Open Source Solutions
  4. - www.servit.ch
  5. Description
  6. -----------
  7. Special Menu Items is module that enables placeholder and separator menu items.
  8. Placeholder is a menu item which is
  9. actually not a link. Something like this is useful with drop down menus where we
  10. want to have a parent link which
  11. is actually not linking to a page but which is just acting as a parent grouping
  12. some children below it.
  13. A separator menu item is something like "-------" which is also not linking
  14. anywhere but merely a mean to structure menus.
  15. This module depends on the Menu module. It is recommended that the SimpleMenu
  16. module or another drop down menu module
  17. is used, or you will not be able to acess children of nolink menu items.
  18. Features
  19. --------
  20. - User can create a new menu item and place either "" or ""
  21. in the Path field, without quotes.
  22. - When the menu is rendered the "nolink" item will be rendered similar to a
  23. normal menu link item, but there will
  24. be no link, just the title. Since version 1.3 you can change HTML tag used
  25. for menu item.
  26. - When the menu is rendered the "separator" item will be rendered as an item
  27. which has no link,and the default title will be "-------". Since version 1.3 it is possible to
  28. change both the HTML tag and title.
  29. - Breadcrumb of "" will be rendered same as "" menu item.
  30. - CSS class "nolink" is added to "" menu item.
  31. - CSS class "seperator" is added to "" menu item.
  32. - Compatible with the Sitemap module.
  33. Installation
  34. ------------
  35. 1. Copy the special_menu_items folder to your sites/all/modules directory.
  36. 2. At Administer -> Site building -> Modules (admin/modules) enable the module.
  37. 3. Configure the module settings at Administer -> Site configuration ->
  38. Special Menu Items (admin/config/system/special_menu_items).
  39. Upgrading
  40. ---------
  41. Just overwrite (or replace) the older special_menu_items folder with the newer
  42. version.
  43. Performance Implications
  44. ------------------------
  45. Special Menu Items implements THEME_link() to change the rendering of links. For link heavy pages, this may
  46. result in reduced performance. The THEME_link() function can be disabled with a variable in settings.php, but
  47. you will then need to implement the markup changes yourself.
  48. See the notes on the l() function and theme_link() explanation on api.drupal.org.
  49. https://api.drupal.org/api/drupal/includes!common.inc/function/l/7
  50. https://api.drupal.org/api/drupal/includes!theme.inc/function/theme_link/7
  51. Contact
  52. -------
  53. This module is developed by Servit Open Source Solutions - http://servit.ch
  54. and maintained by Khaled Zaidan - zaidan@servit.ch