modules/taxonomy_menu/README.txt

TAXONOMY MENU
=============

INTRO
=====
This module adds links to taxonomy terms to the global navigation menu.


INSTALLATION
============
1) Place this module directory into your Drupal modules directory.

2) Enable the taxonomy_menu module in Drupal, at:
   administration -> site configuration -> modules (admin/build/modules)

3) Choose which vocabularies to appear in the menu at:
   administration -> content management -> taxonomy
   (admin/content/taxonomy)

4) Edit the vocabulary or create a new one.

CONFIGURATION
=============
All configuration options are on the vocabulary's edit screen 
admin/content/taxonomy/edit/vocabulary/$vid)
Options:
 Menu: Select which menu the vocabulary's terms should appear under
 
 Menu Path Type: Select how the url for the term path should be created. 
  Included are Default, hierarcy and custom. 
  This is extendable using hook_taxonomy_menu_path().
  See developers documentation for more information. (http://drupal.org/node/380652)
 
 Syncronise changes to this vocabulary: If selected, the menu will auto update when you
  change a node or term.  Recommened to always have this selected.
 
 Display Number of Nodes: Displays the number of nodes next to the term in the menu.
 
 Hide Empty Terms: Does not create menu links for terms with no nodes attached to them.
 
 Item for Vocabulary: Create a menu link for the vocabulary.  This will be the parent menu item.
 
 Auto Expand Menu Item: Enables the 'Expand' option when creating the menu links.  
  This is useful if using suckerfish menus in the primary links.
 
 Display Descendants:  Alters the URL to display all of child terms.  <base path>/$tid $tid $tid $tid
  When this is set, the Path Alias is not applied.
 
 Select to rebuild the menu on submit: Deletes all of menu items and relationships between the menu and terms
  and recreates them from the vocabulary's terms.  This will create new mlid's for each item, so be careful
  if using other modules to extend the menu functionality.
 
HIERARCHY PATH
==============
This should only be used if you have custom code or a block that relies on the category/vid/tid/tid/tid.
If you would like the url to be this path, the recomendation is to use PathAuto with 'category/[vocab-raw]/[copath-raw]'.
Use the field "Base Path for Hierarchy Path" to see the base URL that will match the veiw or page callback.
The view or pagecall back MUST be created before the taxonomy menu.

CUSTOM PATH
===========


"Base Path for Hierarchy Path:"
VIEWS
=====
VIEWS WITH MENU PATH TYPE: DEFAULT
 The default view is 'taxonomy_term (default)'. 
 The path of the view is 'taxonomy/term/%', the argument is 'Term ID (with depth)' and 'Depth Modifier' - 
 but only TERM ID will be passed as an argument.
 This view can be changed - but it is recommended to use the option MENU PATH TYPE: CUSTOM for individual views.

VIEWS WITH MENU PATH TYPE: CUSTOM
 You need to have a view with path 'custom path/%' and an argument 'Term ID' before you create the taxonomy menu.
 To use the 'Display Depth in Custom Path:' option, the path in the view has to be 'custom path/%/%'" 
 The two arguments must be 'Term ID (with depth)' and 'Depth Modifier'. Have this view setup before you create the taxonomy menu.
   
NOTES
=====
 * Menu Items are Path Alias aware and compatible with PATHAUTO.
 * Taxonomy Menu does not handle the menu call backs.  It only creates the links to the menus.
 * The router item must be created before Taxonomy Menu creates the links.  Failure to so so 
    will cause the menu items to not be created.
 * Router items can be created by either a view or another modules hook_menu.
 * If using Path Auto, the URL passed to the code it taxonomy/term/$tid.
 * Advanced Breadcrumbs can be controled by Taxonomy Breadcrumb (http://drupal.org/project/taxonomy_breadcrumb)
 * Changing the taxonomy default URL to match the custom Taxonomy Menu Path can
    be controled by Taxonomy Redirect (http://drupal.org/project/taxonomy_redirect)
 * When using the CCK 'Content Taxonomy' module the field option Save values additionally to the core taxonomy system 
    (into the 'term_node' table)' has to be enabled. 
	Otherwise nodes with taxonomy terms linked through this field will not be shown within the 
	menu structure that Taxonomy Menu creates.
1	TAXONOMY MENU
2	=============
3
4	INTRO
5	=====
6	This module adds links to taxonomy terms to the global navigation menu.
7
8
9	INSTALLATION
10	============
11	1) Place this module directory into your Drupal modules directory.
12
13	2) Enable the taxonomy_menu module in Drupal, at:
14	administration -> site configuration -> modules (admin/build/modules)
15
16	3) Choose which vocabularies to appear in the menu at:
17	administration -> content management -> taxonomy
18	(admin/content/taxonomy)
19
20	4) Edit the vocabulary or create a new one.
21
22	CONFIGURATION
23	=============
24	All configuration options are on the vocabulary's edit screen
25	admin/content/taxonomy/edit/vocabulary/$vid)
26	Options:
27	Menu: Select which menu the vocabulary's terms should appear under
28
29	Menu Path Type: Select how the url for the term path should be created.
30	Included are Default, hierarcy and custom.
31	This is extendable using hook_taxonomy_menu_path().
32	See developers documentation for more information. (http://drupal.org/node/380652)
33
34	Syncronise changes to this vocabulary: If selected, the menu will auto update when you
35	change a node or term. Recommened to always have this selected.
36
37	Display Number of Nodes: Displays the number of nodes next to the term in the menu.
38
39	Hide Empty Terms: Does not create menu links for terms with no nodes attached to them.
40
41	Item for Vocabulary: Create a menu link for the vocabulary. This will be the parent menu item.
42
43	Auto Expand Menu Item: Enables the 'Expand' option when creating the menu links.
44	This is useful if using suckerfish menus in the primary links.
45
46	Display Descendants: Alters the URL to display all of child terms. <base path>/$tid $tid $tid $tid
47	When this is set, the Path Alias is not applied.
48
49	Select to rebuild the menu on submit: Deletes all of menu items and relationships between the menu and terms
50	and recreates them from the vocabulary's terms. This will create new mlid's for each item, so be careful
51	if using other modules to extend the menu functionality.
52
53	HIERARCHY PATH
54	==============
55	This should only be used if you have custom code or a block that relies on the category/vid/tid/tid/tid.
56	If you would like the url to be this path, the recomendation is to use PathAuto with 'category/[vocab-raw]/[copath-raw]'.
57	Use the field "Base Path for Hierarchy Path" to see the base URL that will match the veiw or page callback.
58	The view or pagecall back MUST be created before the taxonomy menu.
59
60	CUSTOM PATH
61	===========
62
63
64	"Base Path for Hierarchy Path:"
65	VIEWS
66	=====
67	VIEWS WITH MENU PATH TYPE: DEFAULT
68	The default view is 'taxonomy_term (default)'.
69	The path of the view is 'taxonomy/term/%', the argument is 'Term ID (with depth)' and 'Depth Modifier' -
70	but only TERM ID will be passed as an argument.
71	This view can be changed - but it is recommended to use the option MENU PATH TYPE: CUSTOM for individual views.
72
73	VIEWS WITH MENU PATH TYPE: CUSTOM
74	You need to have a view with path 'custom path/%' and an argument 'Term ID' before you create the taxonomy menu.
75	To use the 'Display Depth in Custom Path:' option, the path in the view has to be 'custom path/%/%'"
76	The two arguments must be 'Term ID (with depth)' and 'Depth Modifier'. Have this view setup before you create the taxonomy menu.
77
78	NOTES
79	=====
80	* Menu Items are Path Alias aware and compatible with PATHAUTO.
81	* Taxonomy Menu does not handle the menu call backs. It only creates the links to the menus.
82	* The router item must be created before Taxonomy Menu creates the links. Failure to so so
83	will cause the menu items to not be created.
84	* Router items can be created by either a view or another modules hook_menu.
85	* If using Path Auto, the URL passed to the code it taxonomy/term/$tid.
86	* Advanced Breadcrumbs can be controled by Taxonomy Breadcrumb (http://drupal.org/project/taxonomy_breadcrumb)
87	* Changing the taxonomy default URL to match the custom Taxonomy Menu Path can
88	be controled by Taxonomy Redirect (http://drupal.org/project/taxonomy_redirect)
89	* When using the CCK 'Content Taxonomy' module the field option Save values additionally to the core taxonomy system
90	(into the 'term_node' table)' has to be enabled.
91	Otherwise nodes with taxonomy terms linked through this field will not be shown within the
92	menu structure that Taxonomy Menu creates.