Skip to content

Toggle Required Metadata plugin updates - #549

Open
iudizm wants to merge 5 commits into
pkp:mainfrom
lepidus:toggleRequiredMetadata-v3-v2-2-2-2-v1-4-1-6
Open

iudizm wants to merge 5 commits into
pkp:mainfrom
lepidus:toggleRequiredMetadata-v3-v2-2-2-2-v1-4-1-6

Conversation

@iudizm

@iudizm iudizm commented Sep 30, 2026

Copy link
Copy Markdown
  • Update with the latest releases for OJS 3.3, 3.4 and 3.5
  • Adjust the plugin summary and description.

@bozana

bozana commented Oct 14, 2026 •

Copy link
Copy Markdown

Hi @iudizm,

Thanks for the new releases! We now review plugin releases with the help of Claude. We installed 3.0.0.1 on OJS 3.5 and it works as described. Claude suggested a few improvements:

Main points

  • Workflow warning (3.0.0.1): the warning says "The verification e-mail was already sent" for every contributor without a verified ORCID iD, even if no email was ever sent. For example, it appears on articles published before the plugin was enabled, and it asks editors to "Resend Verification Email" to authors who never got one. It also stays after the plugin's rule is met. Could you pass orcidVerificationRequested to the component, use different wording for "not requested yet" and "requested, waiting", and show the warning only where the requirement applies?
  • ORCID check (3.0.0.1, 2.2.2.2): please count a contributor as verified only when an orcid is also stored (orcid && orcidIsVerified), as core's export plugins do.
  • OMP 3.3 (1.4.1.6): OMP's submission/form/step3.tpl sets additionalContributorsFields itself for the chapters grid. That overwrites your variable, so the list of missing details your error message mentions never appears on a press.
  • Defaults: all three requirements are on by default, and the settings are saved the first time any page reads them. So enabling the plugin immediately requires affiliation, biography and ORCID. Maybe save the defaults once on enable (or default to off), or mention the default in the gallery description?
  • version.xml (3.0.0.1, 2.2.2.2): please add <class>ToggleRequiredMetadataPlugin</class> and <lazy-load>1</lazy-load>, so the plugin isn't loaded on every request where it's disabled.

Smaller points

  • manage() should return early when there's no context. In 1.4.1.6, it should call parent::manage($args, $request).
  • The release tarballs include Cypress tests, package files, resources/ sources and README images. These could be left out with export-ignore in .gitattributes.
  • The plugin description in the 2.2.2.2 locale files doesn't mention the biography.

None of these block the release. Would you like to address them before we merge, or should we merge this now and you include them in a next release?

Thanks!

…and 3.0.0.2

Signed-off-by: iudi <iudi@lepidus.com.br>
Signed-off-by: iudi <iudi@lepidus.com.br>
@iudizm

iudizm commented Oct 19, 2026

Copy link
Copy Markdown
Author

Hi @bozana,

Thanks again for the plugin reviews!

I've updated this PR with the latest releases (3.0.0.3, 2.2.2.3 and 1.4.1.7), which address all your review points above.

A few notes:

  • ORCID check (3.4): OJS 3.4 has no orcidIsVerified, so the check keeps orcid && orcidAccessToken, the same one the ORCID Profile plugin uses. It already required a stored iD.
  • Workflow warning (3.5): besides "no verification request pending" and "requested, waiting", it also tells apart contributors who declined the authorization and requests left without a pending verification link (the e-mail failed, or the iD was removed after being verified), as orcidVerificationRequested stays set in those cases. It is hidden once the submission has been published, including its new versions. The last submission step shows the same states.
  • Defaults: we went with requirements off by default on new installs.
  • Package: the README screenshots are the only thing left included.

Also fixed a few related issues along the way.

Thanks a lot!

@iudizm iudizm changed the title Toggle Required Metadata - v3.0.0.1, v2.2.2.2, v1.4.1.6 Toggle Required Metadata Oct 19, 2026
@iudizm iudizm changed the title Toggle Required Metadata Toggle Required Metadata plugin updates Oct 19, 2026
@bozana

bozana commented Oct 21, 2026

Copy link
Copy Markdown

Hi @iudizm,

Thanks a lot for the quick and thorough update! The earlier points are all fixed: the OMP 3.3 list, the defaults, version.xml, manage(), the packaging and the descriptions. The workflow warning now tells "not requested" apart and hides once the rule is met or the article is published.

One thing is still off on current 3.5 (3.5.0-6 and later): the workflow warning decides "waiting" and "declined" in the browser from orcidEmailToken and orcidAccessDenied, but since pkp/pkp-lib#13442 these fields are writeOnly and no longer returned by the API. So after "Request verification" the editor sees "no verification link is pending … use Resend Verification Email" although the email went out, and resending replaces the link the contributor may be about to use. A declined contributor shows the same text. Your Cypress "Waiting for…" check would fail on the current stable-3_5_0 too.

Could you work the state out on the server, as the review step already does, and pass only the state to the component? For example, a derived author property such as orcidVerificationStatus added through Schema::get::author with apiSummary. Please don't add the two fields back to the API.

Smaller ones, if you're in there:

  • For a contributor whose iD is stored but unverified, core shows only "Delete" on the ORCID field, not "Request verification", so the "not requested" text points to a button that isn't there. A separate wording ("delete the unverified iD, then request verification") would help.
  • The warning still shows on declined submissions. Showing it only while the submission is in progress would avoid that.
  • In the review block, the warning icons render smaller than the ORCID and clock icons.

None of these blocks the merge, so please let me know if I should merge now or wait. Thanks again!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants