Skip to content

Add citation_doi tag to head meta#4034

Merged
kshepherd merged 2 commits intoDSpace:dspace-7_xfrom
alanorth:7_x-citation-doi
Mar 6, 2025
Merged

Add citation_doi tag to head meta#4034
kshepherd merged 2 commits intoDSpace:dspace-7_xfrom
alanorth:7_x-citation-doi

Conversation

@alanorth
Copy link
Contributor

@alanorth alanorth commented Feb 25, 2025

References

Add references/links to any related issues or PRs. These may include:

Description

Add missing <meta name="citation_doi" ...> fields to the XHTML head section for items that have DOIs. This is used by harvesters like Altmetric to monitor attention on identifiers in repositories and academic publishers.

Instructions for Reviewers

Please add a more detailed description of the changes made by your PR. At a minimum, providing a bulleted list of changes in your PR is helpful to reviewers.

List of changes in this PR:

  • Adds a <meta name="citation_doi" content=...> tag to the <head> section item pages containing a DOI in the dc.identifier.doi field (default).

This will need to be ported to DSpace 8+ manually.

Include guidance for how to test or review your PR. This may include: steps to reproduce a bug, screenshots or description of a new feature, or reasons behind specific changes.

Check the HTML source in the browser inspector on a simple item view page for an item that has a DOI. You should see a new meta tag for citation_doi.

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

@alanorth alanorth added component: SEO Search Engine Optimization high priority labels Feb 25, 2025
@alanorth alanorth added this to the 7.6.4 milestone Feb 25, 2025
@tdonohue tdonohue added port to main This PR needs to be ported to `main` branch for the next major release port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release labels Feb 25, 2025
@tdonohue tdonohue added the 1 APPROVAL pull request only requires a single approval to merge label Feb 26, 2025
@alanorth alanorth marked this pull request as draft March 5, 2025 11:35
alanorth added 2 commits March 5, 2025 16:40
This is used by harvesters like Altmetric and was present in DSpace
version 6 and previous.
Remove commented out this.setCitationDOITag() since it is not used
and we use camel case with this.setCitationDoiTag() now anyway.
@alanorth alanorth marked this pull request as ready for review March 5, 2025 13:41
@tdonohue tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace Maintenance (9.x, 8.x, 7.6.x) Mar 5, 2025
@alanorth alanorth removed port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release port to main This PR needs to be ported to `main` branch for the next major release labels Mar 6, 2025
Copy link
Member

@kshepherd kshepherd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 by inspection, matches previous functionality and follows other meta tag injection patterns. Thanks @alanorth ! This is an important one to fix

@github-project-automation github-project-automation bot moved this from 🙋 Needs Reviewers Assigned to 👍 Reviewer Approved in DSpace Maintenance (9.x, 8.x, 7.6.x) Mar 6, 2025
@kshepherd kshepherd merged commit 99840ba into DSpace:dspace-7_x Mar 6, 2025
15 checks passed
@github-project-automation github-project-automation bot moved this from 👍 Reviewer Approved to ✅ Done in DSpace Maintenance (9.x, 8.x, 7.6.x) Mar 6, 2025
@kshepherd
Copy link
Member

kshepherd commented Mar 6, 2025

@alanorth any reason you removed the port to 8.x. / port to main tags?
(sorry, re-read your description properly and I see this is moved to head-tag.service.ts - i'll push up a quick port soon)

kshepherd added a commit to kshepherd/dspace-angular that referenced this pull request Mar 6, 2025
@alanorth alanorth deleted the 7_x-citation-doi branch March 6, 2025 15:23
@alanorth
Copy link
Contributor Author

alanorth commented Mar 6, 2025

Thanks @kshepherd. I removed the port tags because I manually ported these but forgot to mention them here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1 APPROVAL pull request only requires a single approval to merge component: SEO Search Engine Optimization high priority

Projects

Development

Successfully merging this pull request may close these issues.

3 participants