Fixes #2313 Update Citation Style Configuration

[tadean]

Description

The seboettg/citeproc-php package has updated in its 2.6.0 release to begin using the citation-style-language/locales and citation-style-language/styles packages for its CSL rules. These packages were not previously available on packagist and it used to be a manual step to install them.

Previously, Quickstart was using academicpuma/locales (an older copy of the same locale files that was available on packagist) for its locale information, to prevent needing to install them manually.

Now that these styles are available on packagist, we may want to consider refactoring how we include the styles. This PR updates the Publication content type to use citation-style-language/locales and modifies our configuration style entities to prefer referencing CSL styles in the citation-style-language/styles package by name rather than including the xml directly.

Modifications are made to the style configuration form to allow either referencing a CSL style by name, or by custom XML. Most of our managed styles now refer to the citation-style-language/styles by reference. Bluebook Law Review currently still uses custom XML as the citation-style-language/styles version of bluebook law review does not support bibliographies The custom version of quickstart's Bluebook Law Review managed style has been modified to support bibliographies.

Spike: Feedback is desired on the best way to include references to the stylesheets, given there are a very large number of options in citation-style-language/styles; dropdown built via cached introspection of the files, specifying name manually, etc.

Related issues

#2313

How to test

• enable az_publication
• create some publications
• verify citations are still rendered correctly
• visit /admin/config/az-quickstart/settings/az-publication/az_citation_style
• create a new style or edit one
• For the new style, enter a stylesheet name or custom CSL (see Citation Style Language Repository for examples. Enter stylesheet names without the .csl extension, e.g. modern-language-association
• change the default site style at /admin/config/az-quickstart/settings/az-publication to your style and verify they work correctly

Types of changes

Arizona Quickstart (install profile, custom modules, custom theme)

• Patch release changes
  • Bug fix
  • Accessibility, performance, or security improvement
  • Critical institutional link or brand change
  • Adding experimental module
  • Update experimental module
• Minor release changes
  • New feature
  • Breaking or visual change to existing behavior
  • Upgrade experimental module to stable
  • Enable existing module by default or database update
  • Non-critical brand change
  • New internal API or API improvement with backwards compatibility
  • Risky or disruptive cleanup to comply with coding standards
  • High-risk or disruptive change (requires upgrade path, risks regression, etc.)
• Other or unknown
  • Other or unknown

Drupal core

• Patch release changes
  • Security update
  • Patch level release (non-security bug-fix release)
  • Patch removal that's no longer necessary
• Minor release changes
  • Major or minor level update
• Other or unknown
  • Other or unknown

Drupal contrib projects

• Patch release changes
  • Security update
  • Patch or minor level update
  • Add new module
  • Patch removal that's no longer necessary
• Minor release changes
  • Major level update
• Other or unknown
  • Other or unknown

Checklist

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[joeparsons]

Code changes look good to me. I'm glad to see that classes/methods for discovering available stylesheets are provided by the CiteProc library so you didn't have to implement any of that. 👍🏻

Adding autocomplete to the stylesheet selection form element would definitely be a nice future improvement but this version seems totally usable to me as-is and I would be in favor of merging this PR.

[joeparsons]

Suggested change from 2023-04-05

• Add a boolean (checkbox) config entity setting and form field that indicates whether the citation style config entity contains CSL or not instead of having 2 separate text fields for the style name and custom style markup.

[tadean]

Todo:

• Refactor to use boolean config switch on style loading
• Add boolean checkbox config setting for style behavior
• AJAXify form to transform style element based on style type

[bberndt-uaz]

Tested in Probo and everything looks good for this PR!

However, I did notice a potential issue with the way pages are displayed by the MLA style:

[tadean]

Interesting - thanks @bberndt-uaz ! I'll take a look at that and see what's going on in the style.

[tadean]

@bberndt-uaz it seems that MLA uses the minimal-two CSL page numbering style. It looks like the intended output of this field should be 140-50, removing the redundant one, so it seems some transformation of this number is expected, but it doesn't seem like the zero should be dropped. I'll do some testing and see if this is an issue in the CSL processor we're using.

[joeparsons]

@tadean Is going to create a follow-up issue for addressing the page number issue.