Requirements for: Pagination by letter

[bobbingwide]

These are some of the requirements for the Pagination by letter plugin, taken from the first draft of the plugin, dated 27th July 2016.

• Automatically sets the value for the identified first letter taxonomies using extendable rules
• Provides a category page with selectable letters
• Taxonomies can be associated to any post type
• Batch population of letter category
• Initialisation of the letter terms - A ... Z, -, ?, #

Assumptions

• Expected to be implemented as taxonomies rather than categories
• Extendable rules will enable plugins to implement filters to choose the 'letter term' to which the post is associated.
• Multiple letter categories will be allowed per post type.

Requirements

for WP-a2z

• Letter taxonomy for APIs, Classes, Files and Hooks
• using a flexible approach to choosing the first letter after the identifying prefix(es) in the post's identifier

for bigram.co.uk

Letter taxonomies:

• s-letter for S-words - choosing the second letter from the s-word taxonomy
• b-letter for B-words - choosing the second letter from the b-word taxonomy

[bobbingwide]

For others sites where we want to support simple A to Z pagination in addition to numeric page pagination .... e.g. bobbingwidewebdesign.com, oik-plugins.com we need an action hook to display the selection list for the selected letter taxonomy.
The action hook will be oik_a2z_display, taking two parameters $taxonomy and $url

In a Genesis framework child theme we'd hook into an action such as genesis_after_endwhile

[bobbingwide]

To reduce confusion with letter pagination and numeric page pagination we need to ensure that we group all first letter digits 0..9 as #.

[bobbingwide]

The currently selected taxonomy term should be highlighted in a similar manner to the pagination links.
i.e. the list item of the active link should have additional CSS classes "active current".

[bobbingwide]

Note: The basic requirements have now been implemented such that the logic can be used in a Genesis child theme.

I won't close this issue just yet since:

• PHPUnit tests have not been developed,
• the batch facility requires oik-batch,
• the solution for WP-a2z has not yet been developed
• the solution for bigram uses its own custom code
• the solution lends itself to implementation using a shortcode and a widget

[bobbingwide]

Updated requirements - 17 Feb 2017

• Automatically sets the value for the identified first letter taxonomies using extendable rules
• Provides a taxonomy page with selectable letters
• Taxonomies can be associated to any post type
• Batch population of letter category
• Initialisation of the letter terms - A ... Z, -, ?, #
• Filtering of the terms by selected post type
• [bw_terms] shortcode for use in text widgets.

Assumptions

• Expected to be implemented as taxonomies rather than categories
• Extendable rules will enable plugins to implement filters to choose the 'letter term' to which the post is associated.
• Multiple letter categories will be allowed per post type.
• Multiple terms may be set for each taxonomy.

Requirements

for WP-a2z, oik-plugins and similar sites

• API Letters taxonomy for APIs, Classes, Files and Hooks
• API Letters allows multiple terms from the title
• Letter(s) taxonomy for posts, oik-plugins, oik-themes, oik_shortcodes etc
• Letter taxonomy only has one value per post.

For bigram.co.uk

Requirements unchanged

[bobbingwide]

The code must also work with PHP 7.1. Need to correct logic in the filter function oik_a2z_first_letter that attempts to convert a string parameter to an array. It needs to return an array.