Project

General

Profile

Actions

Feature #11937

closed

Integration between WP Grade Comments and Reckoning

Added by Laurie Hurson about 5 years ago. Updated over 2 years ago.

Status:
Resolved
Priority name:
Normal
Assignee:
Category name:
Reckoning
Target version:
Start date:
2019-10-03
Due date:
% Done:

0%

Estimated time:
Deployment actions:

Description

Hi All,

At the last meeting we discussed the google doc and possibilities for updating/building out the reckoning plugin.
GDoc:https://docs.google.com/document/d/1oNxivPjB4wsbsILSMEt09TaY7jbuOActsXYYgx1jzbY/edit

Our conversation generated several possibilities to follow up on:

1. Categories: if the post was categorized, is it possible to pull that category into user summary overview page?

2. Can we build in an option to export the Reckoning data to CSV? We probably only need to export info from the user summary overview, not the second page with full length posts.

3. Explore potential for creating functional connection between WP Grade Comments and Reckoning. The most useful connection might be whether reckoning can pull the "grade" attached to each post and display in the user summary. This mechanism might exist in some form through WP Grade comments plugin already because when you view the post list in the dashboard, the grade is also displayed (Screenshot attached). Would it be possible to use that functionality in reckoning to have grades appear with the posts in the user summary?


Files

WP Grade Comments_ grades on posts.png (174 KB) WP Grade Comments_ grades on posts.png Laurie Hurson, 2019-10-03 11:28 AM
screen 1.png (298 KB) screen 1.png Laurie Hurson, 2019-10-03 02:45 PM
screenshot 3 qp grade comments.png (320 KB) screenshot 3 qp grade comments.png Laurie Hurson, 2019-10-03 02:45 PM
screenshot_ post comments view.png (418 KB) screenshot_ post comments view.png Laurie Hurson, 2019-10-03 03:38 PM
reckoning user view.png (282 KB) reckoning user view.png Laurie Hurson, 2022-04-08 10:56 AM
reckoning Summary view.png (266 KB) reckoning Summary view.png Laurie Hurson, 2022-04-08 10:56 AM
Principles-of-New-Media-SAMPLE-User-Summary-2022-04-08.csv (4.74 KB) Principles-of-New-Media-SAMPLE-User-Summary-2022-04-08.csv Laurie Hurson, 2022-04-08 10:56 AM
Screen Shot 2022-04-13 at 3.18.44 PM.png (123 KB) Screen Shot 2022-04-13 at 3.18.44 PM.png Laurie Hurson, 2022-04-13 03:21 PM
Reckoning Column layout.png (258 KB) Reckoning Column layout.png Laurie Hurson, 2022-04-28 11:47 AM

Related issues

Related to CUNY Academic Commons - Bug #11862: Testing WP Grade Comments for inclusion on Commons ResolvedRaymond Hoh2019-09-16

Actions
Related to CUNY Academic Commons - Feature #11939: Add post categories to Reckoning user summaryResolvedBoone Gorges2019-10-03

Actions
Related to CUNY Academic Commons - Feature #11941: CSV export for Reckoning dataResolvedRaymond Hoh2019-10-03

Actions
Actions #1

Updated by Boone Gorges about 5 years ago

  • Related to Bug #11862: Testing WP Grade Comments for inclusion on Commons added
Actions #2

Updated by Boone Gorges about 5 years ago

  • Related to Feature #11939: Add post categories to Reckoning user summary added
Actions #3

Updated by Boone Gorges about 5 years ago

Actions #4

Updated by Boone Gorges about 5 years ago

  • Subject changed from Updates to Reckoning Plugin to Integration between WP Grade Comments
  • Category name set to Reckoning
  • Status changed from New to Reporter Feedback
  • Assignee set to Boone Gorges
  • Target version set to 1.17.0

Thanks, Laurie. I've opened separate tickets for 1 and 2, and will hijack this ticket for 3, which is integration with WP Grade Comments.

Can you spell out in more detail how you envision item 3 working? Perhaps you could share screenshots and make some suggestions about exactly what grade content would appear, and where.

Actions #5

Updated by Laurie Hurson about 5 years ago

Hi Boone,

Thanks for organizing the tickets.

The WP Grade plugins adds the "Grade" column (screenshot 3). I believe the comment bubble is standard wordpress but when you view the comments, you can see that there are private comments, and the grade column is added in the comments view, too.

I think the simplest integration would entail having (information generated by) this grade column appear in the reckoning user summary overview (screenshot 1) connected to the post on which the grade was posted. Similar to how the posts dashboard has several columns, I am suggestion the reckoning user summary overview also might have several columns, such as post title and date posted (current) plus post category (ticket #11939) and grade. I know in the post dashboard the columns are dynamic, but I don't think they need to be in reckoning beyond having a link to the post (current functionality).

If we could add more dynamic functionality to the reckoning user summary overview, I would suggest adding the comment bubble so that an admin could see how many comments were on the students post and easily navigate to their own feedback (or see that they missed a comment) from the reckoning overview screen.

What did I miss? Thoughts?

Actions #7

Updated by Boone Gorges about 5 years ago

  • Subject changed from Integration between WP Grade Comments to Integration between WP Grade Comments and Reckoning

> I think the simplest integration would entail having (information generated by) this grade column appear in the reckoning user summary overview (screenshot 1) connected to the post on which the grade was posted. Similar to how the posts dashboard has several columns, I am suggestion the reckoning user summary overview also might have several columns, such as post title and date posted (current) plus post category (ticket #11939) and grade. I know in the post dashboard the columns are dynamic, but I don't think they need to be in reckoning beyond having a link to the post (current functionality).

Got it - I think this is fine. Presumably we'd also put the data in the "Extended User Summary" interface, where it may not be represented by a column - the display is different there - but along the lines of whatever we do with categories. #11939

If we could add more dynamic functionality to the reckoning user summary overview, I would suggest adding the comment bubble so that an admin could see how many comments were on the students post and easily navigate to their own feedback (or see that they missed a comment) from the reckoning overview screen.

Can you provide more details about this idea? I get what you mean about showing a comment count (this would apply only to posts, of course) but I'm not sure about "easily navigate" - where would it go? To the comments section of the public post? And, just to be clear, this suggestion isn't really directly related to WP Grade Comments?

Actions #8

Updated by Laurie Hurson about 5 years ago

just to be clear, this suggestion isn't really directly related to WP Grade Comments?

Correct, since comments are standard wordpress, but it's related.

The comment bubble links to a dashboard page with all the comments on a particular post (screenshot). I was suggesting integrating this comment bubble into reckoning for each post. So along with the post name, post category (to be added), dated posted, and grade (to be integrated), you could also see the dynamic comment bubble and when clicked, be taken to the dashboard page of comments on post (screenshot).

If the comment bubble is integrated into reckoning, when viewing reckoning with post information, a prof could easily navigate to view all the comments on a particular post, including their own, which maybe be associated with the grade that is visible in reckoning.

Actions #9

Updated by Boone Gorges about 5 years ago

  • Status changed from Reporter Feedback to Assigned

Thanks, Laurie. This gives me some good context. Let me see how the rest of the 1.17 release goes - the comment bubble, while motivated by WP Grade Comments, is technically independent, and as such may be doable prior to full WP Grade Comments integration.

Actions #10

Updated by Boone Gorges over 4 years ago

  • Target version changed from 1.17.0 to 1.18.0
Actions #11

Updated by Boone Gorges about 4 years ago

  • Target version changed from 1.18.0 to 1.19.0
Actions #12

Updated by Boone Gorges about 3 years ago

  • Target version changed from 1.19.0 to Future release
Actions #13

Updated by Laurie Hurson over 2 years ago

Hi Boone,

In several recent workshops faculty have been asking about ability to assign formative feedback/grade to posts, and then download this info to integrate into external grading platform (like excel).

I wanted to revisit #3 from the original post

3. Explore potential for creating functional connection between WP Grade Comments and Reckoning. The most useful connection might be whether reckoning can pull the "grade" attached to each post and display in the user summary. This mechanism might exist in some form through WP Grade comments plugin already because when you view the post list in the dashboard, the grade is also displayed (Screenshot attached). Would it be possible to use that functionality in reckoning to have grades appear with the posts in the user summary?

Could we consider developing a a way to pull in WP grade Comment comments and grades into reckoning and also allow for this to be downloaded as part of the CSV data?

Actions #14

Updated by Boone Gorges over 2 years ago

Yes, I think we can consider this. The challenge here is that comments and posts are collated separately. Grades, as posted via WP Grade Comments, are associated with individual comments, where presumably (correct me if I'm wrong) you would want the grades exported with the posts. This logic obviously isn't too complicated - when pulling up a list of posts, check the comments belonging to each, and if one has a grade, then include it with that post - but it could cause issues in the (rare but technically possible) case where a post has more than one comment with a grade.

Anyway, given this technical background, can you give an overview of how and where you think that grade data should be included in the display and CSV export?

Actions #15

Updated by Laurie Hurson over 2 years ago

Hi Boone,

Sorry for the delay in getting back to you.

presumably (correct me if I'm wrong) you would want the grades exported with the posts.

Yes, that is correct

This logic obviously isn't too complicated - when pulling up a list of posts, check the comments belonging to each, and if one has a grade, then include it with that post - but it could cause issues in the (rare but technically possible) case where a post has more than one comment with a grade.

yes, exactly. I think the two grade thing is rare and we could deal with that if/when it occurs?

can you give an overview of how and where you think that grade data should be included in the display and CSV export?

Attached screenshots of reckoning for backend display ideas. I think the grades could be added as column H in the csv export, mirroring the back end reckoning display. Sample CSV attached.

Actions #16

Updated by Boone Gorges over 2 years ago

Thanks, Laurie, for the very helpful feedback.

I'll take a look in the upcoming weeks and see what I can figure out. This may be something we can pull into the 1.20 release.

Actions #17

Updated by Raymond Hoh over 2 years ago

Boone, just a FYI that the CSV code for Reckoning is located at /mu-plugins/assets/admin/reckoning.php.

Actions #18

Updated by Boone Gorges over 2 years ago

Thank you sir!

Actions #19

Updated by Boone Gorges over 2 years ago

  • Status changed from Assigned to Testing Required
  • Target version changed from Future release to 2.0.0

I've built a first pass at this: https://github.com/cuny-academic-commons/cac/commit/e825f870d3753c96d83ae7aad1586ad39b11064f

Laurie, could you have a test of this on cdev? Set up a site, activating Reckoning and WP Grade Comments, then create some posts and leave some grade-comments. You should see a Grade column in the Reckoning 'Posts' view (I've left it out of the 'Comments' tables, as it doesn't seem to make sense there). It's also part of the CSV export.

Actions #20

Updated by Laurie Hurson over 2 years ago

Began testing this today- it looks good! Exciting to see these plugins working together.

I was testing on cdev here: https://sitetest2.commons.gc.cuny.edu/2022/04/13/7/

A few things:

- Somewhat related to the "what if another prof adds a (second) grade?" question: Can we make it so that the most recent grade added is the one shown in the reckoning back end? This way, the most recently added grade is visible and, more importantly I think, a single prof can update grades this way - in case the grade is entered wrong or is changed later.

- Could we make it possible to add a grade without having to add a comment? Currently when I try to add a grade without a comment a modal appears asking me to make a comment in order to submit (screenshot attached). I realize it might be impossible to separate the grade submission from required comment but I figured I would ask.

Actions #21

Updated by Boone Gorges over 2 years ago

Thanks for the quick feedback, Laurie.

I've changed the logic of the plugin so that newer comments are preferred over older ones. https://github.com/cuny-academic-commons/cac/commit/52bf4a2290b0fa575c54f6002c1f64a3a98c0337

- Could we make it possible to add a grade without having to add a comment? Currently when I try to add a grade without a comment a modal appears asking me to make a comment in order to submit (screenshot attached). I realize it might be impossible to separate the grade submission from required comment but I figured I would ask.

Yes, I recently added this to the plugin for the City Tech OpenLab, but hadn't yet released it. I've done so and update the Commons in https://github.com/cuny-academic-commons/cac/commit/03b5313de392fa600ed7ef5d72bde0268f7852b0. Be sure you do a hard-refresh in order to load the new JavaScript when testing.

Actions #22

Updated by Laurie Hurson over 2 years ago

Thanks for these updates Boone. I can see now that newer grades replace older ones, and I can add a grade without entering a full comment.

One more question - would it be possible to somehow designate which comments were entered as private. Either through another column (Private Comment? with a check mark) or through some alternative organization? I don't have preferences about display here, but i think it would be helpful to be able to view private vs. pubic comments in this area.

Actions #23

Updated by Boone Gorges over 2 years ago

I've added a 'Private?' column to the Comments column in the web view ('private' is a property of comments, not of posts, in the wp-grade-comments context) and also a 'Private?' column in the CSV export. The CSV export combines posts and comments into a single set of headers, so there may be some confusion when there's a 'Private' column next to post rows. But I'll leave it up to your testing to decide whether we can or should do anything about it. https://github.com/cuny-academic-commons/cac/commit/29cae48275046dd3a6841bf6b5209e725a434a71

Actions #24

Updated by Laurie Hurson over 2 years ago

Hi Boone,

Thanks for these updates, they look good. A few questions --

For consistency, can we have "date" be in the same column in user summary and "grade" and Private" in the last column, see screenshot. Do you think it will be confusing to have date in the same column? I think this helps with clarity but could see other issues arising too.

In the CS export:
1. Would it be possible upon download that the column for private reads "private comment"? Does not need to be this language in the UI on the site but upon download that might help clarify that column.
2. Similarly, can the csv export column for grade just say "grade" and not "grade comment"? to help differentiate these fields?

Actions #25

Updated by Laurie Hurson over 2 years ago

If anyone would like to test this WP Grade Comment & Reckoning integration some steps below.

I guess try to imagine you are an instructor who is using posts, comments, private comments, "grades", as the assignment turn in and feedback mechanism in your course.

I did a workshop yesterday on ungrading and shared how these features can be used in feedback and ungrading practices. I am wondering if down the road we might considering changing the word "grade" to something equally as descriptive since the commons seeks to foster alternative forms of assessment.

I don't have any good ideas and I don't want to complicate this more than necessary (and its in the plugin name so... we can leave it as is for now). But I wanted to raise this idea, and offer it something else to think about as you test these features.

1. Make a test post, categorize it.

2. Comment on the post

3. Private Comment on the post and add a grade. Visit reckoning backend (User summary)
- Does your post and comments appear in reckoning back end?
- Is the reckoning UI clear? Does it make sense that some posts have comments, private comments, grades?

4. Go back to post and add new grade without submitting text comment
- Check reckoning, has the grade on the post been updated to reflect the most recent grade?

5. Download the csv and open on your local machine.
- Is the CSV clear? Does the layout and columns make sense?

If I am missing any steps, feel free to add.

Actions #26

Updated by Boone Gorges over 2 years ago

Thanks, Laurie. I've made the requested changes.

Actions #27

Updated by Colin McDonald over 2 years ago

Here are a few small things, I think really for Laurie as this continues to be refined, that I thought I'd mention from going through her testing steps:

- From what I gather, the purpose here is to be able to grade someone's Wordpress post, because you can only have one grade on a post in the backend. So is there a point to the step 2 comment, the public one, other than comparing to the private/graded one that actually gets pulled into Reckoning?

- It was hard at first to figure out that I needed to go to Dashboard > Users > User Summary to see the right Reckoning screen, but I'm sure walkthroughs/documentation can help with that.

- Is it better to change a grade by editing the initial graded/private comment, or by creating a new one? Or maybe it's no difference. I assume the newest private/graded comment supersedes and is what Reckoning attaches/exports/etc for that particular post.

- The CSV is clear, and I guess just requires some specific sorting to isolate the grades that apply to each individual student, especially if there are multiple posts by multiple students? Since there are separate rows for posts and comments, you have to sort by post title then by type, perhaps? Or is it better to use the user (i.e. student) display name?

Actions #28

Updated by Laurie Hurson over 2 years ago

Hi Colin,

Thanks for this feedback. I tried to clarify the use of these plugins and answer your questions in the documentation which can be viewed here: https://help.commons.gc.cuny.edu/student-assessment-2/

- From what I gather, the purpose here is to be able to grade someone's Wordpress post, because you can only have one grade on a post in the backend. So is there a point to the step 2 comment, the public one, other than comparing to the private/graded one that actually gets pulled into Reckoning?

I am a bit confused but i think you mean the public comment option? This is standard and we will leave as is. If someone isn't posting a private comment, they may be posting a public comment, possibly to foster discussion, or provide public feedback.

- It was hard at first to figure out that I needed to go to Dashboard > Users > User Summary to see the right Reckoning screen, but I'm sure walkthroughs/documentation can help with that.

I tried to make this clear in documentation.

- Is it better to change a grade by editing the initial graded/private comment, or by creating a new one? Or maybe it's no difference. I assume the newest private/graded comment supersedes and is what Reckoning attaches/exports/etc for that particular post.

Grades can only be changed by visiting the post and entering a second grade- only the most recent grade appears in reckoning. We may want to test that only admins can submit grades and add private comments...

- The CSV is clear, and I guess just requires some specific sorting to isolate the grades that apply to each individual student, especially if there are multiple posts by multiple students? Since there are separate rows for posts and comments, you have to sort by post title then by type, perhaps? Or is it better to use the user (i.e. student) display name?

Yes, you would sort by username. I added this info to documentation too.

Actions #29

Updated by Colin McDonald over 2 years ago

Thanks, Laurie. I didn't think that the regular commenting feature had any connection to Reckoning, and was inartfully trying to talk through that. I think we're all set here.

Actions #30

Updated by Boone Gorges over 2 years ago

  • Status changed from Testing Required to Staged for Production Release
Actions #31

Updated by Boone Gorges over 2 years ago

  • Status changed from Staged for Production Release to Resolved
Actions

Also available in: Atom PDF