modules/menutrails/README.TXT

/* $Id$ */

-- SUMMARY --

Menu Trails implements primary/secondary links which keep the current menu trail
"active" or highlighted.  The module provides a means of broadly categorizing
nodes (by type or taxonomy) as falling "under" a known menu item.  These nodes
are not added to the menu tree (keeping the menu admin system sane) but they
will trigger the functionality above -- preserving navigation state for the user
-- when being viewed.

For a full description of the module, visit the project page:
  http://drupal.org/project/menutrails

To submit bug reports and feature suggestions, or to track changes:
  http://drupal.org/project/issues/menutrails


-- REQUIREMENTS --

None.


-- INSTALLATION --

* Install as usual, see http://drupal.org/node/70151 for further information.


-- CONFIGURATION --

* Classify nodes in Administer >> Site building >> Menus >> Trails.


-- TROUBLESHOOTING --

Menu Trails contains a built-in override for theme_links(), which is necessary
to add the "active" class to the containing <li> for each menu item.  If your
theme already includes an override, this may cause a PHP error, and you will
need to work out the differences between the two theme overrides yourself.

The 5.x version of the module required you to manually override theme_links() in
your theme's template.php file.

Note that if your theme already overrides the theme_links() function in
template.php file, then you need to manually reconcile the differences between
your THEMENAME_links() and Menu Trails' phptemplate_links() function.  The final
result should live in THEMENAME_links() in your template.php file.

Feel free to suggest better alternatives or other ways to tackle the issue if
you have them.


-- CONTACT --

Current maintainers:
* Daniel F. Kudwien (sun) - http://drupal.org/user/54136
* Stefan M. Kudwien (smk-ka) - http://drupal.org/user/48898


1	/* $Id$ */
2
3	-- SUMMARY --
4
5	Menu Trails implements primary/secondary links which keep the current menu trail
6	"active" or highlighted. The module provides a means of broadly categorizing
7	nodes (by type or taxonomy) as falling "under" a known menu item. These nodes
8	are not added to the menu tree (keeping the menu admin system sane) but they
9	will trigger the functionality above -- preserving navigation state for the user
10	-- when being viewed.
11
12	For a full description of the module, visit the project page:
13	http://drupal.org/project/menutrails
14
15	To submit bug reports and feature suggestions, or to track changes:
16	http://drupal.org/project/issues/menutrails
17
18
19	-- REQUIREMENTS --
20
21	None.
22
23
24	-- INSTALLATION --
25
26	* Install as usual, see http://drupal.org/node/70151 for further information.
27
28
29	-- CONFIGURATION --
30
31	* Classify nodes in Administer >> Site building >> Menus >> Trails.
32
33
34	-- TROUBLESHOOTING --
35
36	Menu Trails contains a built-in override for theme_links(), which is necessary
37	to add the "active" class to the containing <li> for each menu item. If your
38	theme already includes an override, this may cause a PHP error, and you will
39	need to work out the differences between the two theme overrides yourself.
40
41	The 5.x version of the module required you to manually override theme_links() in
42	your theme's template.php file.
43
44	Note that if your theme already overrides the theme_links() function in
45	template.php file, then you need to manually reconcile the differences between
46	your THEMENAME_links() and Menu Trails' phptemplate_links() function. The final
47	result should live in THEMENAME_links() in your template.php file.
48
49	Feel free to suggest better alternatives or other ways to tackle the issue if
50	you have them.
51
52
53	-- CONTACT --
54
55	Current maintainers:
56	* Daniel F. Kudwien (sun) - http://drupal.org/user/54136
57	* Stefan M. Kudwien (smk-ka) - http://drupal.org/user/48898
58
59