You are here

README.txt in Node Order 5

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 7 README.txt
*******************************************************
    README.txt for nodeorder.module for Drupal
*******************************************************
The nodeorder module gives users an easy way to order nodes within their
taxonomy terms.

By default, the taxonomy module orders listings of nodes by stickiness and
then by node creation date -- most recently posted nodes come first.

The nodeorder module gives the user the ability to put nodes in any order they
wish within each category that the node lives.

There are two ways that a user can order nodes within a category.  The first
is to use the "move up" and "move down" links that can be configured to appear
on each node (especially useful when looking at lists of taxonomy terms).  The
second is to use drag and drop, which appears on the administrative listings
of nodes in a category.

To install the nodeorder module:

- Put the nodeorder directory in your modules directory.
- Navigate to administer --> modules, and enable the nodeorder module.
- Navigate to administer --> access control, and assign one or more roles
the right to "order nodes within categories."
- You may turn on "orderability" on a per-vocabulary basis by visiting your
vocabularies' administration pages (admin/taxonomy).  This module adds a
checkbox on the "edit vocabulary" page titled "Orderable" -- it defaults to
being unchecked.  After checking this box and saving your changes, you'll be
able to order nodes that are classified in this category.

- In order to use drag and drop node ordering feature, install the
<a href="http://drupal.org/project/jquery_update">jQuery Update</a>
module, the
<a href="http://drupal.org/project/jquery_interface">jQuery Interface</a>
module, and the <a href="http://drupal.org/project/interface_sortable">jQuery
Interface Sortable</a> modules.  Follow those modules' installation instructions
and test to make sure they are working.  Installing 
<a href="http://drupal.org/project/messagefx">Message Effects</a>
will also test jQuery Update and jQuery Interface, so it's not a bad idea to
install (and test) it before installing Nodeorder.
- To use drag and drop node ordering, you will find a tab called "order
nodes" on any admin/taxonomy/VID pages where the vocabulary has been set to
orderable.

- Navigate to admin/settings/nodeorder, where you can set some options
that determine the way nodeorder works.

- Nodeorder now contains better Views integration.  You should now be able
to sort taxonomy views by 'Nodeorder: weight_in_tid' which will make your
taxonomy/term/TID pages behave the same way as nodeorder/term/TID pages.

TECHNICAL NOTES:

Upon installation, this module adds a new column (weight_in_tid) to the
term_node table.  Adding a column to a core table?  Are you crazy?  Yeah,
I guess so ... but it lets us keep the module's code very small since
most everything works through taxonomy.  Also it helps to avoid an extra
join for every node listing.

Please note that the node order is only respected when visiting links
that begin with "nodeorder" -- if you visit links that begin with
"taxonomy" they will appear in the generic taxonomy order.  Since the
module implements hook_term_path, the taxonomy links that get printed
per node will correctly point to the "nodeorder" space when they are in
orderable vocabularies.

The nodeorder module was developed by FunnyMonkey.

File

README.txt
View source
  1. *******************************************************
  2. README.txt for nodeorder.module for Drupal
  3. *******************************************************
  4. The nodeorder module gives users an easy way to order nodes within their
  5. taxonomy terms.
  6. By default, the taxonomy module orders listings of nodes by stickiness and
  7. then by node creation date -- most recently posted nodes come first.
  8. The nodeorder module gives the user the ability to put nodes in any order they
  9. wish within each category that the node lives.
  10. There are two ways that a user can order nodes within a category. The first
  11. is to use the "move up" and "move down" links that can be configured to appear
  12. on each node (especially useful when looking at lists of taxonomy terms). The
  13. second is to use drag and drop, which appears on the administrative listings
  14. of nodes in a category.
  15. To install the nodeorder module:
  16. - Put the nodeorder directory in your modules directory.
  17. - Navigate to administer --> modules, and enable the nodeorder module.
  18. - Navigate to administer --> access control, and assign one or more roles
  19. the right to "order nodes within categories."
  20. - You may turn on "orderability" on a per-vocabulary basis by visiting your
  21. vocabularies' administration pages (admin/taxonomy). This module adds a
  22. checkbox on the "edit vocabulary" page titled "Orderable" -- it defaults to
  23. being unchecked. After checking this box and saving your changes, you'll be
  24. able to order nodes that are classified in this category.
  25. - In order to use drag and drop node ordering feature, install the
  26. jQuery Update
  27. module, the
  28. jQuery Interface
  29. module, and the jQuery
  30. Interface Sortable modules. Follow those modules' installation instructions
  31. and test to make sure they are working. Installing
  32. Message Effects
  33. will also test jQuery Update and jQuery Interface, so it's not a bad idea to
  34. install (and test) it before installing Nodeorder.
  35. - To use drag and drop node ordering, you will find a tab called "order
  36. nodes" on any admin/taxonomy/VID pages where the vocabulary has been set to
  37. orderable.
  38. - Navigate to admin/settings/nodeorder, where you can set some options
  39. that determine the way nodeorder works.
  40. - Nodeorder now contains better Views integration. You should now be able
  41. to sort taxonomy views by 'Nodeorder: weight_in_tid' which will make your
  42. taxonomy/term/TID pages behave the same way as nodeorder/term/TID pages.
  43. TECHNICAL NOTES:
  44. Upon installation, this module adds a new column (weight_in_tid) to the
  45. term_node table. Adding a column to a core table? Are you crazy? Yeah,
  46. I guess so ... but it lets us keep the module's code very small since
  47. most everything works through taxonomy. Also it helps to avoid an extra
  48. join for every node listing.
  49. Please note that the node order is only respected when visiting links
  50. that begin with "nodeorder" -- if you visit links that begin with
  51. "taxonomy" they will appear in the generic taxonomy order. Since the
  52. module implements hook_term_path, the taxonomy links that get printed
  53. per node will correctly point to the "nodeorder" space when they are in
  54. orderable vocabularies.
  55. The nodeorder module was developed by FunnyMonkey.