Close #3913 Add new content field to AZ Publication.

[trackleft]

Description

This Pull Request adds a new field and some demo content for the az_publication content type.
The new field has been added as hidden on each existing display mode except for the default display.
The new field has been added to the bottom of the az_publication edit/create form

Related issues

Close #3913

How to test

Create a new publication
Scroll to bottom of publication form and see field labelled page elements.
Add some elements and save the publication.
View how the publication is displayed.

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.
• My change requires release notes.

[trackleft]

It was determined that we should include the new content field as a paragraphs field.

[ewlyman]

Field works as designed. All good as far as I can see :)

[trackleft]

Add paragraphs as a dependency of az_publication.

[trackleft]

Add paragraphs as a dependency of az_publication.

Looks like that dependency already exists: https://github.com/az-digital/az_quickstart/blob/issue/3913-add-content-field-to-az-publication/modules/custom/az_publication/az_publication.info.yml#L35

[bberndt-uaz]

For the default display (as shown above), I recommend that we add headings for the Publication File and the Main Content. Also, maybe the Publication File should go directly below the Reference?

[bberndt-uaz]

To follow up on a question that came up on Wednesday about the heading text for the main content field: it seems difficult to come up with an appropriate heading that would account for all situations. I think we could make the heading customizable as Cameron suggested as an option or we could skip adding the heading and just add a small amount of extra margin above that field to set it apart from the other content. I still think the Publication File should have a heading or some kind of label--whatever you think is best!

[bberndt-uaz]

Looks good!

[trackleft]

Use full text for the label instead of publication.

[tadean]

I can't provide a commit suggestion because the file's not in the PR, but perhaps something like the following?

diff --git a/modules/custom/az_publication/az_publication.module b/modules/custom/az_publication/az_publication.module
index 2ba7ad9b..905dbadb 100644
--- a/modules/custom/az_publication/az_publication.module
+++ b/modules/custom/az_publication/az_publication.module
@@ -275,9 +275,14 @@ function az_publication_node_view(array &$build, EntityInterface $entity, Entity
           if ($view_mode !== 'full') {
             $has_cover = !empty($entity->field_az_publication_image->target_id);
             $has_abstract = !empty($entity->field_az_publication_abstract->value);
+            // Check if publication has paragraph content.
+            $has_content = (
+              $entity->hasField('field_az_main_content') &&
+              !empty($entity->get('field_az_main_content')->referencedEntities())
+            );
             $url = Url::fromRoute('entity.node.canonical', ['node' => $entity->id()]);
-            // Linking to full node if there is an abstract or cover page.
-            if ($has_cover || $has_abstract) {
+            // Link to full node if there is abstract, cover page, or content.
+            if ($has_cover || $has_abstract || $has_content) {
               $blob->itemlink = $url->toString();
             }
           }

[trackleft]

While writing tests for this, I found a potential bug where non-links are rendered within a tags.

[trackleft]

Markup for row that has failing test

<div class="views-row">
    

<article class="node node--type-az-publication node--view-mode-az-publication-reference clearfix">
  <header>
    
        
      </header>
  <div class="node__content clearfix">
    <div class="csl-bib-body">
  <div class="csl-entry"><a href="/person/thomas-urquhart">Sir Thomas Urquhart</a>. “<a href="/sites/default/files/Small-PDF.pdf" class="ext" data-extlink="" target="_blank" rel="noopener" title="(opens in a new window)">The Trissotetras: Or, a Most Exquisite Table for Resolving All Manner of triangles. </a>”. <i>Book</i>, 2nd Edition, Mathematical Works Publishing, 15 Jan. 2023, p. 400, <a href="https://doi.org/10.1000/2000">https://doi.org/10.1000/2000</a>. <a href="https://example.com/trissotetras">https://example.com/trissotetras</a></div>
</div>
  </div>
</article>

  </div>

[bberndt-uaz]

On the default display, is the Cover Link necessary? If not, I would recommend removing it to prevent the caption and image credit of the publication image from being wrapped in links to the publication file.

[tadean]

On the default display, is the Cover Link necessary? If not, I would recommend removing it to prevent the caption and image credit of the publication image from being wrapped in links to the publication file.

The use-case for this particular feature is in the case where the cover image is sometimes a screenshot of the journal or publication itself, where it might be somewhat natural for the user to click on the picture of the publication to see it.

It does seem somewhat unfortunate styling when combined with image credits, however... maybe we should consider whether the publication file link from the image is useful enough to warrant the confusing styling of caption/credit.

[tadean]

Should az_publication now declare a dependency on az_paragraphs ?

[trackleft]

Should az_publication now declare a dependency on az_paragraphs ?

Good catch! https://github.com/az-digital/az_quickstart/blob/main/modules/custom/az_paragraphs/config/install/field.storage.node.field_az_main_content.yml

[maine-inventor]

Works. Added a publication of a certain type, issue, volume, version. The citation displays correctly.

[maine-inventor]

Works. Added a publication of a certain type, issue, volume, version. The citation displays correctly.