dspace-angular icon indicating copy to clipboard operation
dspace-angular copied to clipboard

Add a generic ItemPageLicenseFieldComponent

Open abelgomez opened this issue 1 year ago • 5 comments

References

  • Fixes #3170
  • Fixes #3167
  • Requires DSpace/DSpace#9882
  • Relates to #3165 (and may require manual merge)

Description

This PR adds a new ItemPageLicenseFieldComponent, which allows showing generic rights information. If the component detects that the rights information points to a Creative Commons license, it delegates the rendering to the existing ItemPageCcLicenseFieldComponent.

If non-default properties are used to indicate CC licenses, they must be exposed in the backend (see DSpace/DSpace#9882).

If the item contains the same numbers of URIs than license names/descriptions, the links will be associated to the names/descriptions in the order they appear. If not, all fields will be explicitly listed (see example below).

Instructions for Reviewers

Create an item with the following properties:

  • cc.license.uri: https://www.example.com/license
  • cc.license: All rights reserved

License should be rendered as a license text with a link:

imagen

Create an item with the following properties:

  • cc.license.uri: https://www.example.com/license1
  • cc.license.uri: https://www.example.com/license2
  • cc.license: License 1
  • cc.license: License 2

Licenses should be rendered as list of licenses with links:

imagen

Create an item with the following properties:

  • cc.license.uri: https://www.example.com/license1
  • cc.license.uri: https://www.example.com/license2
  • cc.license: License 1
  • cc.license: License 2
  • cc.license: License 3

Licenses should render all fields explicitly (and URIs will be rendered as links), since no matching can be established between the license names and the links:

imagen

Create an item with the following properties:

  • cc.license.uri: https://creativecommons.org/licenses/by-nc-sa/4.0/
  • cc.license: CC BY-NC-SA 4.0

License will be rendered as in DSpace 8 using ItemPageCcLicenseFieldComponent:

imagen

NOTE: instructions to test this PR when custom fields are used for the CC license are not given since that requires #3165 to be merged in the main branch. If #3165 is merged, this PR will be updated accordingly with new instructions.

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!

  • [x] 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).
  • [x] 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.
  • [x] My PR passes ESLint validation using npm run lint
  • [x] My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • [x] My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • [x] 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.
  • [x] My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • [x] 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.
  • [x] If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • [x] If my PR fixes an issue ticket, I've linked them together.

abelgomez avatar Sep 20 '24 14:09 abelgomez