You are here

README.txt in Node Hierarchy 7.4

Same filename and directory in other branches
  1. 5 README.txt
  2. 6.3 README.txt
  3. 6 README.txt
  4. 6.2 README.txt
  5. 7.2 README.txt
-------------------------------------------------------------------------------
Node Hierarchy 2 for Drupal 6.x
  by Ronan Dowling, Gorton Studios - ronan (at) gortonstudios (dot) com
-------------------------------------------------------------------------------

Node Hierarchy is a module which allows nodes to be children of other nodes
creating a tree-like hierarchy of content.

The module offers:
  * Automatic hierarchical urls using pathauto
    (eg: http://example.com/aboutus/history/beginning).
  * Automatic creation of hierarchical menus if desired.
  * Optional Views integration.
  * Optional Node Access integration (REMOVED UNTILL NODE ACCESS IS UPDATED)

-------------------------------------------------------------------------------
Installation
------------
Go to administer -> site building -> modules and enable the Node Hierarchy
module.

You must then tell the module which node types can be parents and which can be
children. To do this you can either:
1) Go to administer -> content administration -> content types. Click edit on
the types you want modify and check the "Can be parent" and "Can be child"
checkboxes
-- OR --
2) Go to administer -> settings -> Node Hierarchy and check the boxes in the for
the desired types.

You can also pick a default node for each given type. For example, you can
create a page called "Blogs" and have nodes of type "blog" be a child of that
page by default.

You will also need to assign the following permissions to the appropriate users:

1) create child nodes
   For users who are allowed to create children under existing nodes.
2) edit all node parents
   For users who are allowed to change the parent of any node, regardless of
   authorship.
3) edit own node parents
   For users who are allowed to change the parent of nodes which they have
   authored.
4) reorder children
   For users who are allowed to change the order of children on any node.
5) view site outline
   For users who are allowed to view the site outline
6) administer hierarchy
   For users who are allowed to edit the node hierarchy defaults.


-------------------------------------------------------------------------------
Using Node Hierarchy
--------------------
To assign a parent to a node, either:
1) Create a new node of a type that whose "Can be child" setting is true or edit
   an existing node. Expand the Node Hierarchy fieldset and chose a parent from
   the pulldown.
-- OR --
2) Navigate to the node you wish to make a parent. Click on the children tab,
   and click on one of the create links at the bottom of the tab.

To create a menu for a node:
Edit the node, expand the Node Hierarchy fieldset and check the "Create Menu"
box. Click Submit.
If the node's parent has a menu item, a new menu will be created for the node
under it's parent's menu item. The name of the menu item will be the title of
the node and it's weight will be the node's sort order.

If you edit the parent of a node or it's title, you can recreate an existing
menu item by checking "Recreate Menu". This will set the menu item's parent to
the new parent and the title to the new title. This is not done automatically
on edit, so that you can maintain menu hierarchy separately from node hierarchy
if desired.

If the node does not have a parent or it's parent does not have a menu item, the
new menu item will be a child of the default menu item set in the Node
Hierarchty settings.

Reordering Child Nodes:
Use the green arrow links on the Children tab of the parent node to rearrange
child nodes. This will also update the order of any generated menu items as long
as they have not been moved from their original location.

Token and Pathauto
----------------------
Node Hierarchy integrates with token (and therefore Pathauto 2.x and others).

For Pathauto, the recommended pattern to use is 
  [node:nodehierarchy:parent:url:alias]/[node:title] 
This will give you a hierarchical path which respects automatic and custom paths
for each ancestor up to the top level. 

For example a node with the hierarchical path:
  About us > History > Early Years > 1940s
will have the url:
  about-us/history/early-years/1940s

And if you change the About Us node's path to 'about' the descendant's path will
be 
  about/history/early-years/1940s
All descendant's url paths will need to be regenerated in order to reflect this 
change.

Views
-----
Node hierarchy integrates with Views providing the following:

Arguments:
  Parent Node Id - Takes a node id and returns only nodes which are children of
  that node. Used to provide lists of children for a give node.

Fields:
  Child Weight - The numerical sort order of a child node.

Sort Fields:
  Child Weight - Use this to sort child nodes by their Node Hierarchy sort order.

To enable views integration, turn on the Node Hierarchy Views module. With this
module turned on, you will also be able to embed a view of a node's children on
that node's page.

-------------------------------------------------------------------------------
Node Access
-----------
Node Access integration has been removed from Version 6, as the nodeaccess
module has not been updated to 6 at the time of this writing.

-------------------------------------------------------------------------------
Known Issues
------------
* Settings can break with long content type names.
* Does not respect revisions. Hierarchy settings are revision independant.
* Not tested with pgsql install

-------------------------------------------------------------------------------
TODO
----
* Improve "Can be child" setting to allow admins to specify which node types
  can be children of which node types. (e.g. 'chapter' nodes can only be
  children of 'book' nodes)
-------------------

File

README.txt
View source
  1. -------------------------------------------------------------------------------
  2. Node Hierarchy 2 for Drupal 6.x
  3. by Ronan Dowling, Gorton Studios - ronan (at) gortonstudios (dot) com
  4. -------------------------------------------------------------------------------
  5. Node Hierarchy is a module which allows nodes to be children of other nodes
  6. creating a tree-like hierarchy of content.
  7. The module offers:
  8. * Automatic hierarchical urls using pathauto
  9. (eg: http://example.com/aboutus/history/beginning).
  10. * Automatic creation of hierarchical menus if desired.
  11. * Optional Views integration.
  12. * Optional Node Access integration (REMOVED UNTILL NODE ACCESS IS UPDATED)
  13. -------------------------------------------------------------------------------
  14. Installation
  15. ------------
  16. Go to administer -> site building -> modules and enable the Node Hierarchy
  17. module.
  18. You must then tell the module which node types can be parents and which can be
  19. children. To do this you can either:
  20. 1) Go to administer -> content administration -> content types. Click edit on
  21. the types you want modify and check the "Can be parent" and "Can be child"
  22. checkboxes
  23. -- OR --
  24. 2) Go to administer -> settings -> Node Hierarchy and check the boxes in the for
  25. the desired types.
  26. You can also pick a default node for each given type. For example, you can
  27. create a page called "Blogs" and have nodes of type "blog" be a child of that
  28. page by default.
  29. You will also need to assign the following permissions to the appropriate users:
  30. 1) create child nodes
  31. For users who are allowed to create children under existing nodes.
  32. 2) edit all node parents
  33. For users who are allowed to change the parent of any node, regardless of
  34. authorship.
  35. 3) edit own node parents
  36. For users who are allowed to change the parent of nodes which they have
  37. authored.
  38. 4) reorder children
  39. For users who are allowed to change the order of children on any node.
  40. 5) view site outline
  41. For users who are allowed to view the site outline
  42. 6) administer hierarchy
  43. For users who are allowed to edit the node hierarchy defaults.
  44. -------------------------------------------------------------------------------
  45. Using Node Hierarchy
  46. --------------------
  47. To assign a parent to a node, either:
  48. 1) Create a new node of a type that whose "Can be child" setting is true or edit
  49. an existing node. Expand the Node Hierarchy fieldset and chose a parent from
  50. the pulldown.
  51. -- OR --
  52. 2) Navigate to the node you wish to make a parent. Click on the children tab,
  53. and click on one of the create links at the bottom of the tab.
  54. To create a menu for a node:
  55. Edit the node, expand the Node Hierarchy fieldset and check the "Create Menu"
  56. box. Click Submit.
  57. If the node's parent has a menu item, a new menu will be created for the node
  58. under it's parent's menu item. The name of the menu item will be the title of
  59. the node and it's weight will be the node's sort order.
  60. If you edit the parent of a node or it's title, you can recreate an existing
  61. menu item by checking "Recreate Menu". This will set the menu item's parent to
  62. the new parent and the title to the new title. This is not done automatically
  63. on edit, so that you can maintain menu hierarchy separately from node hierarchy
  64. if desired.
  65. If the node does not have a parent or it's parent does not have a menu item, the
  66. new menu item will be a child of the default menu item set in the Node
  67. Hierarchty settings.
  68. Reordering Child Nodes:
  69. Use the green arrow links on the Children tab of the parent node to rearrange
  70. child nodes. This will also update the order of any generated menu items as long
  71. as they have not been moved from their original location.
  72. Token and Pathauto
  73. ----------------------
  74. Node Hierarchy integrates with token (and therefore Pathauto 2.x and others).
  75. For Pathauto, the recommended pattern to use is
  76. [node:nodehierarchy:parent:url:alias]/[node:title]
  77. This will give you a hierarchical path which respects automatic and custom paths
  78. for each ancestor up to the top level.
  79. For example a node with the hierarchical path:
  80. About us > History > Early Years > 1940s
  81. will have the url:
  82. about-us/history/early-years/1940s
  83. And if you change the About Us node's path to 'about' the descendant's path will
  84. be
  85. about/history/early-years/1940s
  86. All descendant's url paths will need to be regenerated in order to reflect this
  87. change.
  88. Views
  89. -----
  90. Node hierarchy integrates with Views providing the following:
  91. Arguments:
  92. Parent Node Id - Takes a node id and returns only nodes which are children of
  93. that node. Used to provide lists of children for a give node.
  94. Fields:
  95. Child Weight - The numerical sort order of a child node.
  96. Sort Fields:
  97. Child Weight - Use this to sort child nodes by their Node Hierarchy sort order.
  98. To enable views integration, turn on the Node Hierarchy Views module. With this
  99. module turned on, you will also be able to embed a view of a node's children on
  100. that node's page.
  101. -------------------------------------------------------------------------------
  102. Node Access
  103. -----------
  104. Node Access integration has been removed from Version 6, as the nodeaccess
  105. module has not been updated to 6 at the time of this writing.
  106. -------------------------------------------------------------------------------
  107. Known Issues
  108. ------------
  109. * Settings can break with long content type names.
  110. * Does not respect revisions. Hierarchy settings are revision independant.
  111. * Not tested with pgsql install
  112. -------------------------------------------------------------------------------
  113. TODO
  114. ----
  115. * Improve "Can be child" setting to allow admins to specify which node types
  116. can be children of which node types. (e.g. 'chapter' nodes can only be
  117. children of 'book' nodes)
  118. -------------------