Skip to content

pkp/pkp-lib#12071 add optional funding statement metadata #12138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kaitlinnewson wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

pkp/pkp-lib#12071 add optional funding statement metadata #12138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions classes/components/forms/context/PKPMetadataSettingsForm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,19 @@ public function __construct($action, $context)
],
'value' => $context->getData('dataAvailability') ? $context->getData('dataAvailability') : Context::METADATA_DISABLE,
]))
->addField(new FieldMetadataSetting('fundingStatement', [
'label' => __('submission.fundingStatement'),
'description' => __('manager.setup.metadata.fundingStatement.description'),
'options' => [
['value' => Context::METADATA_ENABLE, 'label' => __('manager.setup.metadata.fundingStatement.enable')]
],
'submissionOptions' => [
['value' => Context::METADATA_ENABLE, 'label' => __('manager.setup.metadata.fundingStatement.noRequest')],
['value' => Context::METADATA_REQUEST, 'label' => __('manager.setup.metadata.fundingStatement.request')],
['value' => Context::METADATA_REQUIRE, 'label' => __('manager.setup.metadata.fundingStatement.require')],
],
'value' => $context->getData('fundingStatement') ? $context->getData('fundingStatement') : Context::METADATA_DISABLE,
]))
->addField(new FieldOptions('submitWithCategories', [
'label' => __('category.category'),
'description' => __('manager.submitWithCategories.description'),
Expand Down
9 changes: 9 additions & 0 deletions classes/components/forms/publication/PKPMetadataForm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,15 @@ public function __construct(string $action, array $locales, Publication $publica
]));
}

if ($this->enabled('fundingStatement')) {
$this->addField(new FieldRichTextarea('fundingStatement', [
'label' => __('submission.fundingStatement'),
'tooltip' => __('manager.setup.metadata.fundingStatement.description'),
'isMultilingual' => true,
'value' => $publication->getData('fundingStatement'),
]));
}

if ($this->enabled('pub-id::publisher-id')) {
$this->addField(new FieldText('pub-id::publisher-id', [
'label' => __('submission.publisherId'),
Expand Down
1 change: 1 addition & 0 deletions classes/context/Context.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -609,6 +609,7 @@ public function getRequiredMetadata(): array
'coverage',
'dataAvailability',
'disciplines',
'fundingStatement',
'keywords',
'rights',
'source',
Expand Down
1 change: 1 addition & 0 deletions classes/core/PKPApplication.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -665,6 +665,7 @@ public static function getMetadataFields(): array
'agencies',
'citations',
'dataAvailability',
'fundingStatement',
];
}

Expand Down
6 changes: 5 additions & 1 deletion controllers/modals/submission/ViewSubmissionMetadataHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,17 @@ public function display($args, $request)
$context = $request->getContext();
$templateMgr = TemplateManager::getManager($request);
$publication = $submission->getCurrentPublication();

if ($reviewAssignment->getReviewMethod() != ReviewAssignment::SUBMISSION_REVIEW_METHOD_DOUBLEANONYMOUS) { /* ReviewAssignment::SUBMISSION_REVIEW_METHOD_ANONYMOUS or _OPEN */
$templateMgr->assign('authors', $publication->getAuthorString());

if ($publication->getLocalizedData('dataAvailability')) {
$templateMgr->assign('dataAvailability', $publication->getLocalizedData('dataAvailability'));
}

if ($publication->getLocalizedData('fundingStatement')) {
$templateMgr->assign('fundingStatement', $publication->getLocalizedData('fundingStatement'));
}
}

$templateMgr->assign('publication', $publication);
Expand Down
17 changes: 17 additions & 0 deletions locale/en/manager.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2386,6 +2386,23 @@ msgid "manager.setup.metadata.dataAvailability.require"
msgstr ""
"Require the author to provide a data availability statement before accepting their submission."

msgid "manager.setup.metadata.fundingStatement.description"
msgstr ""
"A short statement describing funding details."

msgid "manager.setup.metadata.fundingStatement.enable"
msgstr "Enable funding statement metadata"

msgid "manager.setup.metadata.fundingStatement.noRequest"
msgstr "Do not request a funding statement from the author during submission."

msgid "manager.setup.metadata.fundingStatement.request"
msgstr "Ask the author to provide a funding statement during submission."

msgid "manager.setup.metadata.fundingStatement.require"
msgstr ""
"Require the author to provide a funding statement before accepting their submission."

msgid "manager.setup.metadata.plainLanguageSummary"
msgstr "Plain language summary"

Expand Down
9 changes: 9 additions & 0 deletions locale/en/submission.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3376,3 +3376,12 @@ msgstr "Organization or group"

msgid "submission.submit.contributorType.anonymous"
msgstr "Anonymous"

msgid "submission.fundingStatement"
msgstr "Funding Statement"

msgid "submission.fundingStatement.tip"
msgstr "Statement that describes the funding for the research on which this work was based."

msgid "submission.submit.form.fundingStatementRequired"
msgstr "Please enter the Funding Statement."
8 changes: 8 additions & 0 deletions schemas/context.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -994,6 +994,14 @@
"in:0,enable,request,require"
]
},
"fundingStatement": {
"type": "string",
"description": "Whether to not request, request or require a Funding Statement from the authors.",
"validation": [
"nullable",
"in:0,enable,request,require"
]
},
"plainLanguageSummary": {
"type": "string",
"description": "Enable plain language summary metadata. `0` is disabled. `enable` will make it available in the workflow. `request` will allow an author to enter a value during submission. `require` will require that the author enter a value during submission.",
Expand Down
8 changes: 8 additions & 0 deletions schemas/publication.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,14 @@
"readOnly": true,
"apiSummary": true
},
"fundingStatement": {
"type": "string",
"description": "Optional metadata that describes funding details for this publication.",
"multilingual": true,
"validation": [
"nullable"
]
},
"id": {
"type": "integer",
"readOnly": true,
Expand Down
12 changes: 11 additions & 1 deletion templates/controllers/modals/submission/viewSubmissionMetadata.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<div class="abstract">
{$publication->getLocalizedData('abstract')|strip_unsafe_html}
</div>
{if $additionalMetadata || $dataAvailability}
{if $additionalMetadata || $dataAvailability || $fundingStatement}
<pkp-table>
{foreach $additionalMetadata as $metadata}
<pkp-table-row>
Expand All @@ -37,6 +37,16 @@
</pkp-table-cell>
</pkp-table-row>
{/if}
{if $fundingStatement}
<pkp-table-row>
<pkp-table-cell :is-row-header="true">
{translate key="submission.fundingStatement"}
</pkp-table-cell>
<pkp-table-cell>
{$fundingStatement|strip_unsafe_html}
</pkp-table-cell>
</pkp-table-row>
{/if}
</pkp-table>
{/if}
</div>
Expand Down
3 changes: 3 additions & 0 deletions templates/submission/review-editors.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@
{if in_array($currentContext->getData('dataAvailability'), [$currentContext::METADATA_REQUEST, $currentContext::METADATA_REQUIRE])}
{include file="/submission/review-publication-field.tpl" prop="dataAvailability" inLocale=$localeKey name="{translate key="submission.dataAvailability"}" type="html"}
{/if}
{if in_array($currentContext->getData('fundingStatement'), [$currentContext::METADATA_REQUEST, $currentContext::METADATA_REQUIRE])}
{include file="/submission/review-publication-field.tpl" prop="fundingStatement" inLocale=$localeKey name="{translate key="submission.fundingStatement"}" type="html"}
{/if}
{if $localeKey === $submission->getData('locale')}
{if $isCategoriesEnabled}
<div class="submissionWizard__reviewPanel__item">
Expand Down