ISSUE-87: CSL-citations as a twig extension & a field formatter: a tale of two converging paths #192

aksm · 2022-04-26T20:17:29Z

Beginning work on #87. Still a long way to go. Currently some of the styles (list of examples below) cause the first letter of each word in a title to be stripped:

chicago-author-date
chicago-author-date-16th-edition
university-of-york-mla

It's possible that the following log notice is involved:

Notice: iconv(): Wrong charset, conversion from `ISO-8859-1' to `UTF-8//IGNORE' is not allowed in Symfony\Polyfill\Mbstring\Mbstring::mb_convert_case() (line 285 of /var/www/html/vendor/symfony/polyfill-mbstring/Mbstring.php).

ISSUE-187: Wrong key value collection for UUID based Metadata Display Entity Autocomplete element

…template yet). Also does not include language/locale processing yet and uses default (en-us).

aksm · 2022-04-27T15:41:20Z

@DiegoPino I think I located bug involving words in titles being stripped of their first letters.

The following ternary evaluates to true, but then the true condition doesn't return the concatenated string (I'm guessing because of that Mbstring notice that occurs in the logs (mentioned above):

return in_array($encoding, self::ISO_ENCODINGS) ?
    Mbstring::mb_strtoupper($firstChar, $encoding).$then : $firstChar.$then;

The above is from here:

https:/seboettg/citeproc-php/blob/afdfbfd616b2ed3dd0f0e45feda72d0b007e9c8e/src/Util/StringHelper.php#L142-L144

Still looking into it. Will follow up as soon as I figure out more.

DiegoPino · 2022-04-27T15:46:13Z

@aksm the problem is this here
https://stackoverflow.com/questions/63746822/why-does-iconv-returns-empty-string-in-php7-4-fpm-alpine-docker

aksm · 2022-04-27T16:11:09Z

@DiegoPino Hmm, I saw that and skipped, hoping it wasn't a devops/dependency issue. Do we go with the accepted answer?

DiegoPino · 2022-04-27T16:34:35Z

Probably good to test with the accepted answer. Try running the command on your own local php container (without rebuilding, just the command live) and reload the container. See if that changes things. IF so, then I will rebuild both 7.4 and 8.0 to include an updated iconv library

DiegoPino · 2022-04-27T18:13:14Z

src/Plugin/Field/FieldFormatter/StrawberryCitationFormatter.php

+ // $locale_options[$key] = $this->t($locale_string);
+ //}
+ // There's a better way to get this directory
+ $citation_style_directory = '/var/www/html/vendor/citation-style-language/styles-distribution';


citation-style-language library needs to be a composer dependency and yes, that is not a good way of getting that folder

I will fix my own comment here. If we go composer we will need a custom script to git clone that repository. Or we can ship this as a DevOps operation and have a configuration (global one for archipelago) to state where this is downloaded/present

Ok, this is already solved in the libraries example

{ "name": "vendor-name/program-name", "repositories": [ { "type": "package", "package": { "name": "citation-style-language/locales", "version":"1.0.0", "source": { "type": "git", "url": "https:/citation-style-language/locales.git", "reference": "master" } } }, { "type": "package", "package": { "name": "citation-style-language/styles-distribution", "version":"1.0.0", "source": { "type": "git", "url": "https:/citation-style-language/styles-distribution.git", "reference": "master" } } } ], "require": { "citation-style-language/locales":"@dev", "citation-style-language/styles-distribution":"@dev", "seboettg/citeproc-php": "^2" } }

so this needs to go in our composer, not just the "seboettg/citeproc-php": "master"

…t using IIIF Presentation Manifest API 3.0 everything seems to work except the aspect ratio (height) is wrong.

…IIF Presentation API 3 Creative Works Series Manifest' as the metadata display template

…rifying that the getImagesListApi3 works with the 'IIIF Presentation API 3 Creative Works Series Manifest'

…irst structure range, if present, to define image order. I noticed that the initial structures page ordering failed for PDF books because the IIIF 3.0 Presentation Manifest has a bug in assigning the page IDs to the structure range item ids. I added trapping for that, and do not use the structure order if the ids don't match.

…service[0]['id']

…not have been committed

DiegoPino · 2022-05-06T01:00:09Z

@DiegoPino Do I have this right for generating a unique ID for the element, or am I missing something?

You mean referencing an existing ID as here var theid = '#' + $(this).attr("id"); ?

aksm · 2022-05-06T14:01:35Z

@DiegoPino Do I have this right for generating a unique ID for the element, or am I missing something?

You mean referencing an existing ID as here var theid = '#' + $(this).attr("id"); ?

More on the other side, i.e. generating a unique ID that won't conflict if there are multiple blocks:

      $uniqueid =
        'bibliography-' . $items->getName(
        ) . '-' . $nodeuuid . '-' . $delta;

…checking and cleanup to do.

…t using IIIF Presentation Manifest API 3.0 everything seems to work except the aspect ratio (height) is wrong.

…IIF Presentation API 3 Creative Works Series Manifest' as the metadata display template

… exist.

DiegoPino · 2022-05-19T20:16:14Z

src/Plugin/Field/FieldFormatter/StrawberryCitationFormatter.php

@@ -10,6 +10,7 @@
 use Drupal\Core\Session\AccountInterface;
 use Drupal\Core\Template\TwigEnvironment;
 use Drupal\format_strawberryfield\EmbargoResolverInterface;
+use Drupal\pathauto\MessengerInterface;


Hi, this interface is not the right one for the Messenger. Check other plugins or inspect $this->messenger()

DiegoPino · 2022-05-19T20:16:25Z

src/Plugin/Field/FieldFormatter/StrawberryCitationFormatter.php

- // Get the list of style files.
- $style_list = $this->fileSystem->scanDirectory($citation_style_directory, '/\.(csl)$/i', ['recurse' => FALSE, 'key' => 'name']);
- # Generate a list of select options and push in the styles.
+ $csl_exists = is_dir($csl_root);


DiegoPino · 2022-05-19T20:16:53Z

src/Plugin/Field/FieldFormatter/StrawberryCitationFormatter.php

- $style_options[$style_name] = $this->t($style_title);
+ if (!$csl_exists) {
+ $this->messenger()->addWarning('Please run "drush archipelago-download-citeproc-dependencies" before using this formatter.', 'warning');
+ } else {


DCS (Drupal coding standards), the else needs to go in a next line

DiegoPino · 2022-05-19T20:17:05Z

src/Plugin/Field/FieldFormatter/StrawberryCitationFormatter.php

+ $style_options[$style_name] = $this->t($style_title);
+ }
+ // Alphabetize them.
+ asort($style_options);


DiegoPino · 2022-05-19T20:17:21Z

src/Plugin/Field/FieldFormatter/StrawberryCitationFormatter.php

 '#default_value' => $this->getSetting('citationstyle'),
 ],
 'localekey' => [
 '#type' => 'textfield',
 '#title' => $this->t('Provide a metadata key to use as the locale (language) for citations.'),
 '#default_value' => $this->getSetting('localekey'),
 '#required' => FALSE,
+ '#disabled' => !$csl_exists,


…ce breaking changes are on the roadmap for 1.1.0

…omething went wrong partway.

…r dependencies there. Other option is to override its vendor function or maybe make a symlink?

…ng things wrong, but it works?

…javascript in Twig extension.

…gure out how to generate a unique ID.

DiegoPino · 2022-05-26T19:46:37Z

src/TwigExtension.php

+ $render_bibliography['bibliography'] = [
+ '#markup' => \Drupal\Core\Render\Markup::create($bibliography),
+ ];
+ $rendered_bibliography = \Drupal::service('renderer')->render($render_bibliography);


@aksm this is great!!. Hint. Try returning it without the -> render and check it out. Twig should be able to render Render arrays directly. If that does not work out let me know!

@DiegoPino Tried that at one point and got the Return value must be of type string error. It looks like that only works with functions, not filters? Am I missing something?

aksm · 2022-05-26T20:38:34Z

@DiegoPino I feel this is complete for the most part so will start on the next issue and come back with fresh eyes to review for mistakes/additions. Thanks!

aksm · 2022-06-01T19:40:29Z

@DiegoPino pinging you for review when you're ready.

aksm and others added 11 commits April 5, 2022 16:38

add citeproc as composer dependency

7425179

Replace deprecated Twig_Extension deprecated class

0fc4d11

Add some boilerplate

16c1565

more boilerplate because I don't even understand the basics

0a77ad7

add boilerplate for citation formatter

1e5ae94

Merge pull request #188 from esmero/ISSUE-187

3ae0d0d

ISSUE-187: Wrong key value collection for UUID based Metadata Display Entity Autocomplete element

just testing things out and trying to understand what I'm doing

9a47457

Get style list from CSL files and add them to settings form.

7fa54d5

Display selected citation styles in summary

d1f21e9

Citation formatter code rendering from example JSON data (not a TWIG …

de40516

…template yet). Also does not include language/locale processing yet and uses default (en-us).

Merge remote-tracking branch 'origin/1.0.0-RC3' into ISSUE-87

7b4679a

aksm added enhancement New feature or request Twig Twig template processing metadata Meta(l) data IR Institutional repositories, what every scholar loves and fears labels Apr 26, 2022

aksm requested a review from DiegoPino April 26, 2022 20:17

aksm self-assigned this Apr 26, 2022

DiegoPino changed the base branch from 1.0.0-RC3 to 1.0.0 April 27, 2022 18:06

DiegoPino reviewed Apr 27, 2022

View reviewed changes

DiegoPino and others added 7 commits April 28, 2022 09:18

Update composer for 1.0.0 upcoming release

e5aaaf5

tasks/24607546-cws-to-iab --- spitballing code for display book objec…

572209c

…t using IIIF Presentation Manifest API 3.0 everything seems to work except the aspect ratio (height) is wrong.

tasks/24607546-cws-to-iab --- this is working now for my CWS using 'I…

00bc018

…IIF Presentation API 3 Creative Works Series Manifest' as the metadata display template

tasks/24607546-cws-to-iab --- added a bit of inline documentation cla…

09cd6cd

…rifying that the getImagesListApi3 works with the 'IIIF Presentation API 3 Creative Works Series Manifest'

tasks/24607546-cws-to-iab --- added sanity check for annotation.body.…

116e866

…service[0]['id']

tasks/24607546-cws-to-iab --- removed commented out code that should …

ef819ef

…not have been committed

DiegoPino mentioned this pull request May 6, 2022

Add a Copy from UI JS library to Citations/Metadata Formatters #196

Closed

aksm and others added 7 commits May 12, 2022 16:38

Just some starting boilerplate for drush commands.

45edd2a

Drush command downloads and extracts dependencies, but still lots of …

5997dd6

…checking and cleanup to do.

Update composer for 1.0.0 upcoming release

c250b1c

tasks/24607546-cws-to-iab --- spitballing code for display book objec…

539ced2

…t using IIIF Presentation Manifest API 3.0 everything seems to work except the aspect ratio (height) is wrong.

tasks/24607546-cws-to-iab --- this is working now for my CWS using 'I…

6e4afc6

…IIF Presentation API 3 Creative Works Series Manifest' as the metadata display template

Just some cleanup.

8a28fdd

Add warning at top of settings form if folder of dependencies doesn't…

d41d7ee

… exist.

DiegoPino reviewed May 19, 2022

View reviewed changes

aksm added 9 commits May 19, 2022 16:21

Drupal coding standards on control structures. Still learning!

882d71a

Switch to versioned branches as recommended by README, especially sin…

b363db6

…ce breaking changes are on the roadmap for 1.1.0

Give drush user option to re-download and extract libraries in case s…

479f0cd

…omething went wrong partway.

Additional cleanup. Refactor shared variables and functions. DRY!

7c9f048

Refactor to use vendor folder because citeproc automatically looks fo…

b4e522b

…r dependencies there. Other option is to override its vendor function or maybe make a symlink?

First attempt at overriding CiteProc's StyleSheet class. Probably doi…

6ffcf09

…ng things wrong, but it works?

Refactor to use Class to generate bibliography. Still need to attach …

aea45be

…javascript in Twig extension.

Just some cleanup.

b2ee16b

Finally! Twig filter attaches library and functions. Still need to fi…

d0d9015

…gure out how to generate a unique ID.

DiegoPino reviewed May 26, 2022

View reviewed changes

Generate unique IDs for multiple containers.

37ce25c

Merge branch '1.0.0' into ISSUE-87

933734b

DiegoPino merged commit 755a56d into esmero:1.0.0 Jun 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ISSUE-87: CSL-citations as a twig extension & a field formatter: a tale of two converging paths #192

ISSUE-87: CSL-citations as a twig extension & a field formatter: a tale of two converging paths #192

aksm commented Apr 26, 2022

aksm commented Apr 27, 2022

DiegoPino commented Apr 27, 2022

aksm commented Apr 27, 2022

DiegoPino commented Apr 27, 2022

DiegoPino Apr 27, 2022

DiegoPino Apr 27, 2022

DiegoPino Apr 27, 2022 •

edited

Loading

DiegoPino commented May 6, 2022

aksm commented May 6, 2022

DiegoPino May 19, 2022

DiegoPino May 19, 2022

DiegoPino May 19, 2022

DiegoPino May 19, 2022

DiegoPino May 19, 2022

DiegoPino May 26, 2022

aksm May 26, 2022

aksm commented May 26, 2022

aksm commented Jun 1, 2022

ISSUE-87: CSL-citations as a twig extension & a field formatter: a tale of two converging paths #192

ISSUE-87: CSL-citations as a twig extension & a field formatter: a tale of two converging paths #192

Conversation

aksm commented Apr 26, 2022

aksm commented Apr 27, 2022

DiegoPino commented Apr 27, 2022

aksm commented Apr 27, 2022

DiegoPino commented Apr 27, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DiegoPino Apr 27, 2022 • edited Loading

Choose a reason for hiding this comment

DiegoPino commented May 6, 2022

aksm commented May 6, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aksm commented May 26, 2022

aksm commented Jun 1, 2022

DiegoPino Apr 27, 2022 •

edited

Loading