Skip to content
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.

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

Clearer management of files when assigning typesetting #216

Merged
merged 15 commits into from
Aug 22, 2024

Conversation

joemull
Copy link
Member

@joemull joemull commented Jul 17, 2024

This tackles a set of related issues with file management during typesetting assignments, especially in subsequent rounds of typesetting involving proofing files and galley correction.

Regarding #152, this PR does not allow editors to individually select proofreaders' comments, but it does allow them to individually select proofing files separately from comments, and upload their own proofing files. If they want to collate the comments together, they can do this more easily given the summary/details display of proofing comments.

Dependencies:

Editor's main view of typesetting files

image

Editor assigns a typesetter

image
image
image
image

Typesetter views the assignment

image
image

@joemull joemull requested a review from ajrbyers July 18, 2024 06:02
@joemull joemull added the documentation Improvements or additions to documentation label Jul 18, 2024
Copy link
Member

@ajrbyers ajrbyers left a comment

Choose a reason for hiding this comment

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

Thanks for this @joemull I think this will help editors out a lot with this step in the process.

  • I've added two review comments
  • I do have a concern around not presenting the typesetters, automatically, with figure files. Do you think editors will be okay with selecting them? I think journals like CG will consider this a step backwards as they often have large numbers of images that will need to be selected.
  • For articles in typesetting we will need a data migration that will add the figures to the list of files for the typesetter otherwise they will lose access to them.

Let me know what you think about the above.

@ajrbyers ajrbyers assigned joemull and unassigned ajrbyers Jul 24, 2024
@joemull
Copy link
Member Author

joemull commented Jul 24, 2024

I do have a concern around not presenting the typesetters, automatically, with figure files. Do you think editors will be okay with selecting them? I think journals like CG will consider this a step backwards as they often have large numbers of images that will need to be selected.

I think we got into trouble with the usability of this interface by automatically controlling the visibility of things, so what if we make a button with which editors can select all figure files, if they want to? I think I can expand the select_all widget to support looking for value in a data- attribute, and we could use the result of file_type there.

For articles in typesetting we will need a data migration that will add the figures to the list of files for the typesetter otherwise they will lose access to them.

I can write a migration for this.

@joemull joemull assigned ajrbyers and unassigned joemull Jul 24, 2024
@joemull
Copy link
Member Author

joemull commented Jul 24, 2024

Or we could add a setting that controls whether they are pre-selected.

Or if we think most people will want this, we could just preselect them always, without a setting. A few other things are now preselected, so this would not be unique behavior.

Thoughts @ajrbyers ?

@joemull joemull requested a review from ajrbyers July 24, 2024 16:10
@joemull
Copy link
Member Author

joemull commented Jul 26, 2024

@ajrbyers I've gone ahead and pre-checked data and figure files.

Copy link
Member

@ajrbyers ajrbyers left a comment

Choose a reason for hiding this comment

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

Generally this is really good.

  1. When assigning a correction request the editor is presented with the option to select Galley files twice. They Typesetter will have access to the Galley regardless of whether the editor selects the file here.
Screenshot 2024-08-14 at 15 35 59
  1. When logged in as a Typesetter and undertaking a correction task I was able to see the same Galley listed twice.
Screenshot 2024-08-14 at 15 40 18
  1. The article metadata has been moved to the foot of the Typesetter page. Would it be worth adding some sort of signpost? It could easily be missed.

@ajrbyers ajrbyers assigned joemull and unassigned ajrbyers Aug 14, 2024
@joemull
Copy link
Member Author

joemull commented Aug 19, 2024

Thanks @ajrbyers.

  1. When assigning a correction request the editor is presented with the option to select Galley files twice.

One part of the form asks "Which files should be used?" and the other asks "Which galleys need to be corrected?". The two are different things and it is important to be literal and clear in these interfaces, according to the user reports. The selected files control different lists on the typesetter's end, with different explanations (see below).

I prevent errors with the confirmable form:

https://github.com/BirkbeckCTP/typesetting/blob/07115db9480f3919d0bef0ec9ad614be38fbcc2e/forms.py#L92-L105

They Typesetter will have access to the Galley regardless of whether the editor selects the file here.

That's how it used to work, but I changed it because that was one of the sources of confusion. The typesetter sees this text above the first list of files:

"The following files have been selected for use or reference when generating the typeset articles."

For "have been selected" to be true, it is important that all the files, and only the files, selected by the editor appear here. Otherwise the interface can contradict the editors' instructions, which is a source of confusion that users reported.

Granted, it is true that the galley files uploaded by the typesetter will always appear in a separate list. The text above that list says:

"Any galleys (typeset files) that were selected by the editor for correction, or that you originally uploaded, will appear here."

This list needs to stay separate so that the editors' selection is a meaningful piece of communication between editor and typesetter.

  1. When logged in as a Typesetter and undertaking a correction task I was able to see the same Galley listed twice.

Thanks for catching that. I'll fix it.

  1. The article metadata has been moved to the foot of the Typesetter page. Would it be worth adding some sort of signpost? It could easily be missed.

I've added a skip link. Doesn't look fantastic but it will do the trick for now:

image

@joemull joemull assigned ajrbyers and unassigned joemull Aug 19, 2024
@joemull joemull requested a review from ajrbyers August 19, 2024 14:56
Copy link
Member

@ajrbyers ajrbyers left a comment

Choose a reason for hiding this comment

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

🥇

@ajrbyers ajrbyers requested a review from mauromsl August 21, 2024 15:22
@ajrbyers ajrbyers assigned mauromsl and unassigned ajrbyers Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment