You are here

Home » API reference » Views Alpha Pagination 8.2

README.txt in Views Alpha Pagination 8.2

Same filename and directory in other branches
  1. 7.2 README.txt
  2. 7 README.txt
Views Alphabetic Pagination Navigator
-------------------------------------

The Alpha Pagination for Views module enables you to add an alphabetical menu in the header or footer of a views display. 

Alpha Pagination for Views was designed and written by Michael Bagnall: https://www.drupal.org/u/elusivemind.

This module exists thanks to the support of Highwire Press, Inc and the Institute for the Arts and Humanities and UNC and was created as part of the Symposiac Conference Platform.


Install
-------
Install the Alpha Pagination module.

1) Copy the alpha_pagination folder to the modules folder in your installation.

2) Enable the Alpha Pagination for Views module using Administer -> Modules (/admin/build/modules).


Views Integration and Configuration
------------------------------------
1) Build a new view of either users, content (nodes), or comments.

2) Add whatever field you want to use as the basis for the alphabetic grouping (e.g. title, body). You can optionally exclude this field from display if you don't want it to appear in the results shown on the page for some reason. You can only choose a field that is a textfield, textarea or a textarea with a summary.

3) Add either a header or a footer to your view. Select the new item available in the menu of options for Global: Alpha Pagination. 

4) Configure how you want alpha_pagination to work and specify where it should appear:
  a) set the path to the results view page.
  b) select the field you want to use as the basis for the alphabetic grouping from the options presented in the select list (note: if the field you want to use does not appear, go back and add it to your view and then return to this configuration page to select the field).
  c) add a contextual filter that is the same as the field you wish to use as the basis for alphabetic sorting. Be sure to enable Glossary mode and set the character limit to 1. The transform case option on the URL should be set to Upper Case. Also be sure this is the value item for the field and not something else like formatter.
  d) by default the alpha pagination will apply to all displays; if you only want the alpha pagination to appear on the current display, use the drop-down menu at the top of the administrative interface to change the setting from "All displays" to "This page (override)".

5) An optional sample view is included and can be enabled via the alpha_pagination_example view. The sample relies on the 'article' default content type. You can create sample content using the devel module or rely on your own data.

Credits:
--------
https://www.drupal.org/node/2664344
Additional styles & configuration options by MarkCarver: (https://www.drupal.org/u/markcarver)

https://www.drupal.org/node/2654274
Arabic Letter Support by Jad Sayegh: (https://www.drupal.org/u/jadsay)

File

README.txt
View source 
  1. Views Alphabetic Pagination Navigator

  2. -------------------------------------

  3. 

  4. The Alpha Pagination for Views module enables you to add an alphabetical menu in the header or footer of a views display. 

  5. 

  6. Alpha Pagination for Views was designed and written by Michael Bagnall: https://www.drupal.org/u/elusivemind.

  7. 

  8. This module exists thanks to the support of Highwire Press, Inc and the Institute for the Arts and Humanities and UNC and was created as part of the Symposiac Conference Platform.

  9. 

  10. 

  11. Install

  12. -------

  13. Install the Alpha Pagination module.

  14. 

  15. 1) Copy the alpha_pagination folder to the modules folder in your installation.

  16. 

  17. 2) Enable the Alpha Pagination for Views module using Administer -> Modules (/admin/build/modules).

  18. 

  19. 

  20. Views Integration and Configuration

  21. ------------------------------------

  22. 1) Build a new view of either users, content (nodes), or comments.

  23. 

  24. 2) Add whatever field you want to use as the basis for the alphabetic grouping (e.g. title, body). You can optionally exclude this field from display if you don't want it to appear in the results shown on the page for some reason. You can only choose a field that is a textfield, textarea or a textarea with a summary.

  25. 

  26. 3) Add either a header or a footer to your view. Select the new item available in the menu of options for Global: Alpha Pagination. 

  27. 

  28. 4) Configure how you want alpha_pagination to work and specify where it should appear:

  29.   a) set the path to the results view page.

  30.   b) select the field you want to use as the basis for the alphabetic grouping from the options presented in the select list (note: if the field you want to use does not appear, go back and add it to your view and then return to this configuration page to select the field).

  31.   c) add a contextual filter that is the same as the field you wish to use as the basis for alphabetic sorting. Be sure to enable Glossary mode and set the character limit to 1. The transform case option on the URL should be set to Upper Case. Also be sure this is the value item for the field and not something else like formatter.

  32.   d) by default the alpha pagination will apply to all displays; if you only want the alpha pagination to appear on the current display, use the drop-down menu at the top of the administrative interface to change the setting from "All displays" to "This page (override)".

  33. 

  34. 5) An optional sample view is included and can be enabled via the alpha_pagination_example view. The sample relies on the 'article' default content type. You can create sample content using the devel module or rely on your own data.

  35. 

  36. Credits:

  37. --------

  38. https://www.drupal.org/node/2664344

  39. Additional styles & configuration options by MarkCarver: (https://www.drupal.org/u/markcarver)

  40. 

  41. https://www.drupal.org/node/2654274

  42. Arabic Letter Support by Jad Sayegh: (https://www.drupal.org/u/jadsay)