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.

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

Jump to bottom

Adds new features #23

Open
wants to merge 47 commits into
base: stable-3_3_0
Choose a base branch
from
Open

Adds new features #23

wants to merge 47 commits into from

Conversation

JhonathanLepidus
Copy link

This PR adds the following features:

  • Annotations page, where all submissions with annotations are listed
  • A new button with the number of annotations next to the PDF button in the preprint page. When this is clicked, the PDF is opened with the annotations tab opening automatically.
  • The same button to the preprint item in the list of preprints

These features were discussed in the issue

JhonathanLepidus and others added 30 commits July 20, 2022 16:38
@JhonathanLepidus
WIP: Get galley annotation number through Hypothesis API
1226215 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Vitoria <[email protected]>
@JhonathanLepidus
Finishes HypothesisClient class
4270fca 
It can now request the number of annotations of a galley to the Hypothesis API

Signed-off-by: Jhon <[email protected]>
Signed-off-by: Vitoria <[email protected]>
@JhonathanLepidus
Prepares the including of custom template in preprint landing page
f91a402 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Vitoria <[email protected]>
@JhonathanLepidus
Creates the template to add the annotation viewer to landing page
62a38d8 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Vitoria <[email protected]>
@JhonathanLepidus
Removes left margin of annotation viewer
ea10bc6 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Switch annotation viewer addin strategy
c755f8f 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Removes commented code
9912be6 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Brings Hypothesis API call to the template
80d50b4 
Also changes some visual styling

Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Adds Hypothesis config template
f6e5fbd 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Uses load event for configuring Hypothesis client
9a1eab7 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Hypothesis sidebar opens when clicking in annotation number
2b64509 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Redesigns annotation viewer to use the same link of the galley
a502236 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Creates HypothesisHandler class
4334c65 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Adds page to list submissions with annotations
f15100b 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Fixes bug occurred when galleys did not have file
4b05163 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Requests Hypothesis API for annotations by submissions chunks
a118d42 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Fixes problem with submissions groups annotations requests
f16d57d 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Get submission object for submissions with annotations
dbf5996 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Stores submissions with annotations in cache
6f11bb0 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Set annotations cache to updated through scheduled task
8486eb3 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Fixes bug when adding annotation number viewer
e98980b 
Also changes the path for annotations page

Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Creates page for listing of submissions with annotations
09e1351 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Sets locales for annotations page
2e81266 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Fix bug occurred for submissions without publications
be5214a 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Handler returns submissions' annotations
45a2971 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Richard <[email protected]>
@JhonathanLepidus
Sets annotations retrieving from cache
e50a87f 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Richard <[email protected]>
@richardauzier-afk
Set up the display of annotations
d8214ac 
Signed-off-by: Richard <[email protected]>
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Adds styling for annotations
55ccaea 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Richard <[email protected]>
@JhonathanLepidus
Adds Annotation class
e73ffd9 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Richard <[email protected]>
@JhonathanLepidus
Retrieves annotation data from API response
8229782 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Richard <[email protected]>
JhonathanLepidus and others added 14 commits September 22, 2022 15:46
@JhonathanLepidus
Exhibits new annotation info in annotations page
4f17353 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Richard <[email protected]>
@JhonathanLepidus
WIP: Read more for annotation targets
f7bc301 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Richard <[email protected]>
@JhonathanLepidus
Adds read more button for annotation targets
521a488 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Richard <[email protected]>
@JhonathanLepidus
Adds read more button for annotation content
84fc02e 
Signed-off-by: Jhon <[email protected]>
Signed-off-by: Richard <[email protected]>
@JhonathanLepidus
Adds submission metadata to annotations page
95c2247 
Signed-off-by: Jhon <[email protected]>
Signed-off-by> Richard <[email protected]>
@lucasDevLepidus
Remove search box
3486656 
Issue: documentacao-e-tarefas/scielo#396

Signed-off-by: Lucas Anselmo <[email protected]>
Signed-off-by: Laís Reis <[email protected]>
@JhonathanLepidus
Adds order by date of last annotation
8e32bfa 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Adds ordering by date published
a0a8554 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Adds select to order of submissions in annotations page
bd4a865 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
OrderBy is selected according to page's URL
f1f146a 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Changes annotations page ordering when one is selected
7e7a1a3 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Keeps selected order through annotations pagination
27783eb 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Refactors code of annotations ordering functions
58431e3 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Changes default ordering to order by last annotation
ba8d71e 
Signed-off-by: Jhon <[email protected]>
asmecher
asmecher reviewed Feb 1, 2024
View reviewed changes
templates/submissionAnnotations.tpl Outdated
</div>
{/if}
<span class="annotation_content">
<blockquote>{$annotation->content}</blockquote>
Copy link
Owner

Choose a reason for hiding this comment

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

I'm not sure whether annotations should be allowed to contain limited HTML, but this should probably receive at least limited escaping for XSS attacks -- and probably also the other annotation attributes (user and target) too.

Copy link
Author

Choose a reason for hiding this comment

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

Changes done!

@asmecher
Copy link
Owner

Thanks, @JhonathanLepidus! @defstat, would you mind taking a deeper look?

@defstat
Copy link
Contributor

defstat commented Mar 6, 2024

@JhonathanLepidus two questions on this:

I can see that the description of the issue defines

A new button with the number of annotations next to the PDF button in the preprint page.

  1. I don't seem to see this button - should I do something in order to see it?
  2. Does that work for OPS (because you are referring to preprints) or it should work across applications, namely OJS, OMP and OPS?

@JhonathanLepidus
Copy link
Author

JhonathanLepidus commented Mar 11, 2024 •
edited
Loading

@defstat sorry for missing this information. In fact, there should be an integration with the theme plugin in order for it to work. The integration is the calling of the hook Hypothesis::annotationNumber in the place where it is intended to display the button.

For example, we did this implementation in the SciELO Preprints theme: example. It should work in other applications besides OPS.

We did it this way because it was simpler for us, but I think it can be a problem for others to use. Do you think we should change it?

@JhonathanLepidus
Copy link
Author

We were able to identify an alternative implementation. We can change the plugin so that it uses template filters to add the button with the number of annotations next to the galley buttons.

This way, this feature could work on both platforms (OJS/OPS) without needing to be linked to a specific theme.

@defstat
Copy link
Contributor

defstat commented Mar 14, 2024

Hi @JhonathanLepidus. Thanks for that - Yes, the plugins should be "self contained", so your initial approach should be managed somehow. @jardakotesovec is a better person to talk about front end implementations, so I leave that for him.

Do you plan to migrate that change to stable-3.4 and/or main branch?

Also could you provide some screenshots on the intended end-result of the features this implementation adds?

@JhonathanLepidus
Copy link
Author

Hi! Yes, we plan to make these features available for the version compatible with stable 3.4.0 as well. Below are some screenshots of these features.

The annotations page:

annotations_page

Button with annotations number on archive page

archive_page

Button with annotations number on preprint page

preprint_page

@JhonathanLepidus
Makes plugin fully compatible with OJS and OPS
3c8c56e 
Also removes dependency for others plugins

Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Minor fixes in annotations page
b98e0b6 
Signed-off-by: Jhon <[email protected]>
@JhonathanLepidus
Copy link
Author

Hi @defstat

We have updated the code in the source branch of this pull request, in order to bring the following improvements:

  • Updating of the cache cointaining the submissions with annotations through a scheduled task by the Acron plugin
  • The buttons with the number of annotations are now added without the use of a dependency with the theme plugin
  • Minor adjustements that make the new features fully compatible with both OJS and OPS

The features have also been adapted to the version compatible with OJS/OPS 3.4.0 and are ready to be shipped at a later moment.

@defstat
Copy link
Contributor

defstat commented Apr 2, 2024

Hi @JhonathanLepidus! Thanks for all that work! It looks great, and I see that you have adapted the newer/more fluent syntax regarding

Only one question about the caching - is the caching mechanism going to affect the realtime update of the annotation display?

If you have PRs for 3.4 version, please don't hesitate to add those in #22 so that they can be reviewed also.

@JhonathanLepidus
Copy link
Author

JhonathanLepidus commented Apr 2, 2024 •
edited
Loading

Hi @defstat , thanks for the feedback.

The caching mechanism does not affect the display of annotations when viewing the PDF. The cached items are only used for display on the annotations page and do not affect other parts of the application.

We will open a pull request with our contributions to 3.4.0.

Edit: PR opened

@defstat
Copy link
Contributor

defstat commented Sep 24, 2024 •
edited
Loading

@JhonathanLepidus thanks for all this work. Can you share the state of this change?

@JhonathanLepidus
Copy link
Author

HI @defstat !

The changes are ready to be merged. They're present in this pull request (for 3.3.0 version) and in this other one (for 3.4.0 version).

If you have any other doubt, please contact me.

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

@asmecher asmecher asmecher left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@JhonathanLepidus @asmecher @defstat @pablovp86 @richardauzier-afk @lucasDevLepidus