[UI-LIBRARY][main] #7505 Initial Commit Upload - Delete - Download JATS File #300

defstat · 2023-11-24T10:47:08Z

No description provided.

asmecher

I'll send this along to someone else for a proper review when we're ready, but in the meantime, just a quick comment!

src/components/ListPanel/jats/SubmissionJatsListPanel.vue

asmecher · 2023-12-05T22:30:22Z

@jardakotesovec, would you mind taking a look at this PR (part of pkp/pkp-lib#7505)? Thanks!

asmecher · 2023-12-05T22:30:35Z

@defstat, I think you were going to raise something specific here about error handling?

defstat · 2023-12-06T19:44:19Z

@jardakotesovec I was having some trouble figuring out how I should handle possible errors. Is there a "standard" way of doing that when using PKP's vue.js components? Are we handling exceptions in a particular way?

src/components/ListPanel/jats/SubmissionJatsListPanel.vue

jardakotesovec · 2023-12-07T11:16:48Z

src/components/ListPanel/jats/SubmissionJatsListPanel.vue

+	.filePanel__header {
+		grid-column: span 12;
+		background: #f3f3f3;
+	}


This class does not seems to exist, maybe just something to clean up?

It does exist though here.

Are you perhaps referring to something else?

jardakotesovec · 2023-12-07T11:24:05Z

src/components/ListPanel/jats/SubmissionJatsListPanel.vue

@@ -0,0 +1,392 @@
+<template>
+	<div class="jatsPanel">
+		<slot>


It would be better not to categorize this components as ListPanel. Not on PHP side nor Vue.js side. Its very custom component that does not have to do anything with our actual ListPanel component.

Tricky part I guess is that where to put things for such custom component, right?

My intention going forward is to have src/pages/ (you can already see example and submissions folder there), where any page specific component would go.

My suggestion in this case would be just to create folder in src/pages/workflow and create something like PublicationSectionJats.vue.

On PHP side you can remove that ListPanel and couple of props (its hugely reduced when translations goes away) you can pass without using JatsListPanel.php.

Feel free to ask follow-up questions. I am also in process on figuring out details how to organise things, so there is always something I might have missed.

Thanks @jardakotesovec, yes, placing and being able to use the component was the problem for me, so I left it in the list panels. You are right, never the less, that should not be there. So I made the following changes:

Moved the old JatsListPanel to the where you recommended, namely pages/workflow/PublicationSectionJats.vue

Referenced this component into the WorkflowPage.vue, instead of the import JatsListPanel from '@/components/ListPanel/jats/SubmissionJatsListPanel.vue';

Moved the PKP/classes/components/listPanels/JatsListPanel.php to PKP/classes/components/PublicationSectionJats.php

Removed the references to ListPanel from PKP/classes/components/PublicationSectionJats.php making the appropriate changes to make that work.

In PKP/js/load.js I referenced the import PublicationSectionJats from '@/pages/workflow/PublicationSectionJats.vue';

In PKP/js/load.js I registered the new component as such VueRegistry.registerComponent('PkpPublicationJats', PublicationSectionJats);

In APP/templates/workflow/workflow.tpl I changed the appropriate tab's tag from <jats-list-panel> to <pkp-publication-jats>

With those steps we have the new component free of dependences from ListPanel which can be placed (I think) independently where ever we need to, keeping the same functionality as before.

Please check if that meets our goals.

@defstat That looks great, only thing that I added as commint to pkp-lib is to not include it to lib/pkp/js/load.js as its not general component, its fine just to imported in workflow.vue in 'components'.

jardakotesovec · 2023-12-07T11:42:48Z

@jardakotesovec I was having some trouble figuring out how I should handle possible errors. Is there a "standard" way of doing that when using PKP's vue.js components? Are we handling exceptions in a particular way?

@defstat Do you have some use case in mind?

We need to handle the error situations coming from API, which should be covered by that ajaxErrorCallback.

And than if you would be doing something, lets say processing some xml on client side (lets not do that) that might fail on client side, than you should handle that with try catch. Don't see anything like that in this PR.

Everything else would fall to category programmer mistake that crashes app. And there are probably opportunities for some custom handling of such crashes, but that would be up to me to implement global handler for unhandled exception. Thats not something that needs to be worried about in individual components.

src/components/ListPanel/jats/SubmissionJatsListPanel.vue

jardakotesovec · 2023-12-07T11:48:20Z

src/components/ListPanel/jats/SubmissionJatsListPanel.vue

@@ -65,7 +65,7 @@
 				:files="newJatsFiles"
 				:options="options"
 				:queryParams="{fileStage}"
-				:uploadProgressLabel="uploadProgressLabel"
+				upload-progress-label="Uploading {$percent}% complete"
 				@updated:files="setJatsFile"


This also will need to be localizable.

Changed it to :upload-progress-label="t('submission.upload.percentComplete')"

jardakotesovec · 2023-12-12T13:04:26Z

src/components/Container/WorkflowPage.vue

@@ -1,6 +1,7 @@
 <script type="text/javascript">
 import Page from './Page.vue';
 import ContributorsListPanel from '@/components/ListPanel/contributors/ContributorsListPanel.vue';
+import JatsSection from '@/pages/workflow/PublicationSectionJats.vue';
 import Composer from '@/components/Composer/Composer.vue';


Please keep naming consistent and import it as PublicationSectionJats

jardakotesovec · 2023-12-12T13:12:17Z

@defstat This is looking great, css still could be bit more refined, but lets do it as part of conversion to composition api and tailwindcss :-). I added only two small notes, nothing significant.

defstat mentioned this pull request Nov 24, 2023

Add basic support for JATS XML files to publications pkp/pkp-lib#7505

Closed

asmecher requested changes Nov 24, 2023

View reviewed changes

src/components/ListPanel/jats/SubmissionJatsListPanel.vue Outdated Show resolved Hide resolved

asmecher requested a review from jardakotesovec December 5, 2023 22:29

defstat force-pushed the i7505 branch from d1b63d5 to 103592d Compare December 6, 2023 08:15

defstat force-pushed the i7505 branch from 103592d to 7bf5f4a Compare December 6, 2023 20:21

jardakotesovec reviewed Dec 7, 2023

View reviewed changes

src/components/ListPanel/jats/SubmissionJatsListPanel.vue Outdated Show resolved Hide resolved

jardakotesovec requested changes Dec 7, 2023

View reviewed changes

jardakotesovec reviewed Dec 7, 2023

View reviewed changes

src/components/ListPanel/jats/SubmissionJatsListPanel.vue Outdated Show resolved Hide resolved

jardakotesovec reviewed Dec 7, 2023

View reviewed changes

jardakotesovec reviewed Dec 12, 2023

View reviewed changes

defstat added 5 commits December 18, 2023 20:01

pkp/pkp-lib#7505 Support for JATS files/content added

02afc34

pkp/pkp-lib#7505 Review Changes

3e616ef

pkp/pkp-lib#7505 Remove new Jats Component dependency from ListPanel

2cda52d

pkp/pkp-lib#7505 Handle Jats creation Errors

863245f

pkp/pkp-lib#7505 Fix UI in error cases

989dbe3

defstat force-pushed the i7505 branch from 64838eb to 989dbe3 Compare December 18, 2023 18:02

pkp/pkp-lib#7505 Review Changes

d635251

asmecher merged commit fa798c7 into pkp:main Dec 18, 2023
2 of 4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[UI-LIBRARY][main] #7505 Initial Commit Upload - Delete - Download JATS File #300

[UI-LIBRARY][main] #7505 Initial Commit Upload - Delete - Download JATS File #300

defstat commented Nov 24, 2023

asmecher left a comment

asmecher commented Dec 5, 2023

asmecher commented Dec 5, 2023

defstat commented Dec 6, 2023

jardakotesovec Dec 7, 2023

defstat Dec 7, 2023

jardakotesovec Dec 7, 2023

defstat Dec 7, 2023

jardakotesovec Dec 12, 2023

jardakotesovec commented Dec 7, 2023

jardakotesovec Dec 7, 2023

defstat Dec 7, 2023

jardakotesovec Dec 12, 2023

defstat Dec 18, 2023

jardakotesovec commented Dec 12, 2023

[UI-LIBRARY][main] #7505 Initial Commit Upload - Delete - Download JATS File #300

[UI-LIBRARY][main] #7505 Initial Commit Upload - Delete - Download JATS File #300

Conversation

defstat commented Nov 24, 2023

asmecher left a comment

Choose a reason for hiding this comment

asmecher commented Dec 5, 2023

asmecher commented Dec 5, 2023

defstat commented Dec 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jardakotesovec commented Dec 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jardakotesovec commented Dec 12, 2023