You are here

README.txt in Free pager 7.2

This module allows you to use Views to create simple forward/next pagers. It
provides a new display, Pager block, which will create a block with pager for
items listed in the view.

This pager module is a bit more difficult to wrap your head around than most
pager modules. In return, you get much more flexibility in what you can put
pagers on, and how the pagers should work. The basic concept is this:

* You build a pager to browse between URLs. This means that everything you want
  to browse must have its own URL, but that's the only restriction.
* You need to build a view of these URLs. If you're listing nodes, you can build
  this by rewriting the NID field to "node/[nid]", but if you want to have
  pagers on the node edit pages you could use "node/[nid]/edit" instead.
* You can then add other fields to the view, and use them as the previous/next
  links. This could be node titles, image thumbnails, or custom text with static
  "previous" or "next" messages. Or anything else you can get into Views.
* Free pager is then available as a block, which you can place in any region on
  your Drupal site. If the URL list generated by Views matches the currently
  viewed URL the pager will show, otherwise it will be hidden.

The example above uses nodes, but you could of course also use Views to build
lists of user URLs, comment URLs, or whatever other way of generating URLs you
want.

A few notes:
* The tricky part, really, is to have Views creating the list of URLs you want
  to be able to flip through. If you find this module cumbersome, start there.
* The fields used for 'previoius', 'current' and 'next' should *not* be linked
  in themselves, since Free pager will link them for you.
* There are variables $row_number and $total_rows available in the template file
  for Free pager blocks, which can be used to show "3 of 21" or so.
* The module was built to flip through maybe a hundered or two of items, not
  many thousands. The module relies on Views rendering the full list of items,
  which for 1000 items means a bit more than half a second of work (and quite
  a bit of memory consumption). If you want to browse thousands of items,
  strongly consider using another module.

There is an example feature provided by this module, showing one way of using
Free pager to flip through content sharing the same taxonomy term.
To use the demo feature:
* Enable the feature, either from the modules list or the features page.
* Go to structure > taxonomy > section and add at least one section.
* Go to structure > blocks and place "Free pager: section browser" in a region
  of your choice.
* Create a few nodes of the type "news".

When viewing a node marked with a section, Free pager will provide links to the
older/newer content sharing the same section.
Note that this feature is for educational purpose only. If used on an actual
news site, Views would soon choke on the number of items to render on every
page.

File

README.txt
View source
  1. This module allows you to use Views to create simple forward/next pagers. It
  2. provides a new display, Pager block, which will create a block with pager for
  3. items listed in the view.
  4. This pager module is a bit more difficult to wrap your head around than most
  5. pager modules. In return, you get much more flexibility in what you can put
  6. pagers on, and how the pagers should work. The basic concept is this:
  7. * You build a pager to browse between URLs. This means that everything you want
  8. to browse must have its own URL, but that's the only restriction.
  9. * You need to build a view of these URLs. If you're listing nodes, you can build
  10. this by rewriting the NID field to "node/[nid]", but if you want to have
  11. pagers on the node edit pages you could use "node/[nid]/edit" instead.
  12. * You can then add other fields to the view, and use them as the previous/next
  13. links. This could be node titles, image thumbnails, or custom text with static
  14. "previous" or "next" messages. Or anything else you can get into Views.
  15. * Free pager is then available as a block, which you can place in any region on
  16. your Drupal site. If the URL list generated by Views matches the currently
  17. viewed URL the pager will show, otherwise it will be hidden.
  18. The example above uses nodes, but you could of course also use Views to build
  19. lists of user URLs, comment URLs, or whatever other way of generating URLs you
  20. want.
  21. A few notes:
  22. * The tricky part, really, is to have Views creating the list of URLs you want
  23. to be able to flip through. If you find this module cumbersome, start there.
  24. * The fields used for 'previoius', 'current' and 'next' should *not* be linked
  25. in themselves, since Free pager will link them for you.
  26. * There are variables $row_number and $total_rows available in the template file
  27. for Free pager blocks, which can be used to show "3 of 21" or so.
  28. * The module was built to flip through maybe a hundered or two of items, not
  29. many thousands. The module relies on Views rendering the full list of items,
  30. which for 1000 items means a bit more than half a second of work (and quite
  31. a bit of memory consumption). If you want to browse thousands of items,
  32. strongly consider using another module.
  33. There is an example feature provided by this module, showing one way of using
  34. Free pager to flip through content sharing the same taxonomy term.
  35. To use the demo feature:
  36. * Enable the feature, either from the modules list or the features page.
  37. * Go to structure > taxonomy > section and add at least one section.
  38. * Go to structure > blocks and place "Free pager: section browser" in a region
  39. of your choice.
  40. * Create a few nodes of the type "news".
  41. When viewing a node marked with a section, Free pager will provide links to the
  42. older/newer content sharing the same section.
  43. Note that this feature is for educational purpose only. If used on an actual
  44. news site, Views would soon choke on the number of items to render on every
  45. page.