modules/nice_menus/README.txt

// $Id: README.txt,v 1.16 2009/03/24 16:22:28 add1sun Exp $

NICE MENUS MODULE
-----------------

Currently maintained by: Addison Berry (add1sun)

Orginally created by: Jake Gordon (jakeg) http://drupal.org/user/15674/contact and http://www.jakeg.co.uk/

This module makes it easy to add dropdown and flyout menus, using the Superfish jQuery plugin (http://users.tpg.com.au/j_birch/plugins/superfish), and falling back to CSS-only functionality when JS is disabled.

Please report any bugs, feature requests, etc. at: http://drupal.org/project/issues/nice_menus.


Installation
------------
1. Copy nice_modules folder to your sites/all/modules directory.
2. At Administer -> Site building -> Modules (admin/build/modules) enable the module.
3. Configure the module settings at Administer -> Site configuration -> Nice Menus (admin/settings/nice_menus).
4. Configure the Nice Menus block(s) at Administer -> Site building -> Blocks (admin/build/block), setting the source menu and menu style, etc.
5. Return to the blocks page and enable the Nice menus block(s), e.g. 'Nice Menu 1 (Nice Menu)' by putting it in a region.
6. See below sections on Customization and Advanced Theming as well as the handbook page (http://drupal.org/node/185543) for more tips.

Upgrading
---------
For upgrades between versions, read the UPGRADE.txt file included with the module.

Issues
------
You can track known issues at http://drupal.org/project/issues/nice_menus.

Customization
-------------
The module includes a default CSS layout file (nice_menus_default.css) which is loaded for all pages.  If you don't like the default layout, it is suggested that you create a separate customized CSS file, and replace the default CSS file at Administer -> Themes -> Configure -> Global settings -> "Path to custom nice menus CSS file". This ensures smooth future upgrades as no editing of the module files is necessary. NOTE: you should not edit the regular nice_menus.css file since this contains the "logic" that makes Nice menus work.

A good starting point for your custom file is to make a copy of the default file, then edit it to taste. Here are some common customization examples for your own stylesheet:

Make hovered links white with a black background:

  ul.nice-menu li a:hover { 
    color: white; 
    background: black;
  }

Make the link to the current page that you're on black with yellow text:

  ul.nice-menu li a.active { 
    color: yellow; 
    background: black;
  }

Get rid of all borders:

  ul.nice-menu,
  ul.nice-menu ul,
  ul.nice-menu li {
    border: 0;
  }

Get rid of the borders and background colour for all top-level menu items:

  ul.nice-menu,
  ul.nice-menu ul,
  ul.nice-menu li {
    border: 0;
    background: none;
  }

  ul.nice-menu-right li.menuparent,
  ul.nice-menu-right li li.menuparent { 
    background: url('arrow-right.png') right center no-repeat; 
  }

  li.menuparent li, li.menuparent ul {
    background: #eee;
  }

Have a nice menu stick right at the top of the page e.g. for an admin menu:

  #block-nice_menus-1 {
    position: absolute;
    top: 0;
    left: 0;
  }

In Firefox, as above but where the menu doesn't move as you scroll down the page:

  #block-nice_menus-1 {
    position: fixed;
    top: 0;
    left: 0;
  }

That should get you started.  Really this is just about knowing your CSS and styling it the way you want it.

Advanced theming
----------------
If you're creating or modifying your own theme, you can integrate Nice menus more deeply by making use of these functions:
theme_nice_menus() -- themes any menu tree as a Nice menu.
theme_nice_menus_primary_links() -- themes your primary links as a Nice menu.
theme_nice_menus_secondary_links() -- themes your secondary links as a Nice menu.

If you really know what you're doing, you can probably even customize the menu tree in creative ways, as those functions allow you to pass in a custom menu tree.
1	// $Id: README.txt,v 1.16 2009/03/24 16:22:28 add1sun Exp $
2
3	NICE MENUS MODULE
4	-----------------
5
6	Currently maintained by: Addison Berry (add1sun)
7
8	Orginally created by: Jake Gordon (jakeg) http://drupal.org/user/15674/contact and http://www.jakeg.co.uk/
9
10	This module makes it easy to add dropdown and flyout menus, using the Superfish jQuery plugin (http://users.tpg.com.au/j_birch/plugins/superfish), and falling back to CSS-only functionality when JS is disabled.
11
12	Please report any bugs, feature requests, etc. at: http://drupal.org/project/issues/nice_menus.
13
14
15	Installation
16	------------
17	1. Copy nice_modules folder to your sites/all/modules directory.
18	2. At Administer -> Site building -> Modules (admin/build/modules) enable the module.
19	3. Configure the module settings at Administer -> Site configuration -> Nice Menus (admin/settings/nice_menus).
20	4. Configure the Nice Menus block(s) at Administer -> Site building -> Blocks (admin/build/block), setting the source menu and menu style, etc.
21	5. Return to the blocks page and enable the Nice menus block(s), e.g. 'Nice Menu 1 (Nice Menu)' by putting it in a region.
22	6. See below sections on Customization and Advanced Theming as well as the handbook page (http://drupal.org/node/185543) for more tips.
23
24	Upgrading
25	---------
26	For upgrades between versions, read the UPGRADE.txt file included with the module.
27
28	Issues
29	------
30	You can track known issues at http://drupal.org/project/issues/nice_menus.
31
32	Customization
33	-------------
34	The module includes a default CSS layout file (nice_menus_default.css) which is loaded for all pages. If you don't like the default layout, it is suggested that you create a separate customized CSS file, and replace the default CSS file at Administer -> Themes -> Configure -> Global settings -> "Path to custom nice menus CSS file". This ensures smooth future upgrades as no editing of the module files is necessary. NOTE: you should not edit the regular nice_menus.css file since this contains the "logic" that makes Nice menus work.
35
36	A good starting point for your custom file is to make a copy of the default file, then edit it to taste. Here are some common customization examples for your own stylesheet:
37
38	Make hovered links white with a black background:
39
40	ul.nice-menu li a:hover {
41	color: white;
42	background: black;
43	}
44
45	Make the link to the current page that you're on black with yellow text:
46
47	ul.nice-menu li a.active {
48	color: yellow;
49	background: black;
50	}
51
52	Get rid of all borders:
53
54	ul.nice-menu,
55	ul.nice-menu ul,
56	ul.nice-menu li {
57	border: 0;
58	}
59
60	Get rid of the borders and background colour for all top-level menu items:
61
62	ul.nice-menu,
63	ul.nice-menu ul,
64	ul.nice-menu li {
65	border: 0;
66	background: none;
67	}
68
69	ul.nice-menu-right li.menuparent,
70	ul.nice-menu-right li li.menuparent {
71	background: url('arrow-right.png') right center no-repeat;
72	}
73
74	li.menuparent li, li.menuparent ul {
75	background: #eee;
76	}
77
78	Have a nice menu stick right at the top of the page e.g. for an admin menu:
79
80	#block-nice_menus-1 {
81	position: absolute;
82	top: 0;
83	left: 0;
84	}
85
86	In Firefox, as above but where the menu doesn't move as you scroll down the page:
87
88	#block-nice_menus-1 {
89	position: fixed;
90	top: 0;
91	left: 0;
92	}
93
94	That should get you started. Really this is just about knowing your CSS and styling it the way you want it.
95
96	Advanced theming
97	----------------
98	If you're creating or modifying your own theme, you can integrate Nice menus more deeply by making use of these functions:
99	theme_nice_menus() -- themes any menu tree as a Nice menu.
100	theme_nice_menus_primary_links() -- themes your primary links as a Nice menu.
101	theme_nice_menus_secondary_links() -- themes your secondary links as a Nice menu.
102
103	If you really know what you're doing, you can probably even customize the menu tree in creative ways, as those functions allow you to pass in a custom menu tree.