Series Index

Developed by

Download

Plugin Description

Allows posts to be grouped into series.

Description

Displays an index of series posts using the [series-index] shortcode, an index of every series on the site using the [index-of-series] shortcode, and a link back to a series’ index post using the [series-index-link] shortcode. This plugin is multi-site compatible and can optionally integrate with the Toggle Show/Hide plugin from azurecurve. The format of the index and other options are user configurable through an admin page.

Two custom fields (Series and Series Pos) need to be added to each post in the series; these fields are used for selecting the posts and ordering them when the index is displayed. The post that should act as the series’ index post should have a Series Pos of 0 (this is used for determining the link for the header).

See the Instructions tab on the plugin’s settings page for full details of all three shortcodes and their attributes.

This plugin is multisite compatible; each site will need settings to be configured in the admin dashboard.

Installation

  • Download the latest release of the plugin from GitHub.
  • Upload the entire zip file using the Plugins upload function in your ClassicPress admin panel.
  • Activate the plugin.
  • Configure relevant settings via the configuration page in the admin control panel (azurecurve menu).

Frequently Asked Questions

Can I translate this plugin?

Yes, the .pot file is in the plugin’s assets/languages folder; if you do translate this plugin, please send the .po and .mo files to [email protected] for inclusion in the next version (full credit will be given).

Is this plugin compatible with both WordPress and ClassicPress?

This plugin is developed for ClassicPress, but will likely work on WordPress.

My index isn’t showing any posts after upgrading to 2.0.0, what happened?

Versions prior to 2.0.0 had a long-standing bug where the plugin’s database queries never actually matched the Series/Series Pos custom fields correctly (see the 2.0.0 changelog entry below) – so if your index was already empty or incomplete before upgrading, 2.0.0 should fix it rather than break it. If an index that previously worked stops working after upgrading, check that your custom field names are exactly Series and Series Pos (the plugin also still matches the older Series Position/SERIES POS/SERIES POSITION spellings for the position field as a fallback).

Changelog

Version 2.0.0

  • Rebuilt to match the current azurecurve plugin architecture (namespaced code, settings/menu split across includes files, tabbed admin UI matching Shortcodes in Comments).
  • Fixed every database query in the plugin matching against the wrong custom field name casing (SERIES/SERIES POSITION/SERIES POS instead of the actual Series/Series Pos fields), which meant [series-index] was rendering with no rows, [index-of-series] was always empty, and [series-index-link] was linking to nowhere.
  • Fixed literal “%1$s”/”%2$s” placeholders appearing on the settings page instead of the intended shortcode/field names.
  • Fixed a PHP warning on save when settings had never been configured.
  • Replaced the the_posts shortcode-detection scan with a direct stylesheet enqueue.
  • Fixed an inefficient plugin_action_links hook so it no longer runs for every plugin on the Plugins list page.
  • Added support for multiple title separators (e.g. both “:” and “…”) via a single comma-separated Title Separators setting, replacing the old single-separator/space-checkbox fields (existing sites are migrated automatically to an equivalent combined value).
  • Added a filter parameter to [index-of-series] to show only series whose title contains a given string.
  • Added an explicit “Enable Toggle Integration” setting; Toggle Show/Hide integration (and the “Toggle Default” setting) is now off by default on new installs and only used at all once explicitly enabled.
  • Added Previous/Next-in-series navigation links below the series index (outside the toggle), controlled by a new “Enable Previous/Next Navigation” setting and a matching prevnext shortcode attribute.
  • Added an Instructions tab documenting all three shortcodes ([series-index], [index-of-series], [series-index-link]) – previously only [series-index] was documented, mixed into the settings form.
  • Added functions-activation.php activation/deactivation hooks for architectural parity with the rest of the azurecurve plugin family.
  • Converted all JavaScript to vanilla JS (the plugin did not previously ship any JavaScript of its own).
  • BREAKING: minimum PHP requirement raised to 8.2.
  • BREAKING: text domain renamed from series-index to azrcrv-si, and the translation Domain Path moved from /languages to /assets/languages; existing translation (.po/.mo) files must be re-supplied under the new domain.
  • Update readme.md and remove readme.txt (not required for ClassicPress).
  • Update azurecurve menu.

Version 1.2.6

  • Update plugin header for compatibility with ClasssicPress v2.

Version 1.2.5

  • Update plugin header and readme for compatibility with ClassicPress Directory v2.
  • Update Update Manager to version 2.5.0.

Version 1.2.4

  • Update readme file for compatibility with ClassicPress Directory.

Version 1.2.3

  • Update readme files.
  • Update language template.
  • Fix bug with azurecurve menu.

Version 1.2.2

  • Update azurecurve menu.
  • Update readme files.

Version 1.2.1

  • Update azurecurve menu and logo.

Version 1.2.0

  • Fix plugin action link to use admin_url() function.
  • Rewrite option handling so defaults not stored in database on plugin initialisation.
  • Add plugin icon and banner.
  • Update azurecurve plugin menu.
  • Amend to only load css when shortcode on page.

Version 1.1.8

  • Fix bug with select of series index posts when title includes an apostrophe.

Version 1.1.7

  • Fix bug with setting of default options.
  • Fix bug with plugin menu.
  • Update plugin menu css.

Version 1.1.6

  • Rewrite default option creation function to resolve several bugs.
  • Upgrade azurecurve plugin to store available plugins in options.

Version 1.1.5

  • Update Update Manager class to v2.0.0.
  • Update action link.
  • Update azurecurve menu icon with compressed image.

Version 1.1.4

  • Fix bug with series-index shortcode when series title contains apostrophes.

Version 1.1.3

  • Fix bug with series-index-link shortcode when series title contains apostrophes.

Version 1.1.2

  • Fix bug with selecting series containing apostrophes in series title.

Version 1.1.1

  • Fix bug with incorrect language load text domain.

Version 1.1.0

  • Add integration with Update Manager for automatic updates.
  • Fix issue with display of azurecurve menu.
  • Change settings page heading.
  • Add load_plugin_textdomain to handle translations.

Version 1.0.1

  • Update azurecurve menu for easier maintenance.
  • Move require of azurecurve menu below security check.

Version 1.0.0

  • Initial release for ClassicPress forked from azurecurve Series Index WordPress Plugin.
  • Remove toggle and integrate with Toggle Show/Hide plugin.

Other Notes

About azurecurve

azurecurve was one of the first plugin developers to start developing for ClassicPress; all plugins are available from azurecurve Development and are integrated with the Update Manager plugin for fully integrated, no hassle, updates.

The plugins available from azurecurve are: