Differentiate private and public comments in exports

Bug #1873119 reported by Robert Lyon
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mahara
Fix Released
Wishlist
Doris Tam

Bug Description

If they are appearing in HTML export in a modal then we need to get them to appear in PDF a different way (probably appended to the page comments)

The HTML export area for comments is out of date, also which is used by the PDF also. The formatting needs to be updated.

Additional to this, adding a switch to allow private-comment-free exports.

To test this:

1. Create a page with multiple blocks
2. Make comments to the artefacts displaying in the blocks - using a combination of the 'details' view as well as adding private and public comments
3. Export the page with the 'Include comments' ON and 'Include private comments OFF'
   - ✅ CHECK when 'Include comments' is OFF, 'Include private comments' switch is disabled
4. ✅ EXPECT - none of the private comments in the PDF export at the base page where the page comments sit.
6. ✅ EXPECT - the artefacts comments do not appear on the HTML export and only the PDF export
7. Export the page again with 'Include comments' ON and 'Include private comments' ON
8. ✅ EXPECT - the private comments appear in the PDF export with a grey background

Tags: newfeature
Robert Lyon (robertl-9)
Changed in mahara:
milestone: none → 20.04rc1
Revision history for this message
Cecilia Vela Gurovic (ceciliavg) wrote :

The way it used to be done in html on 19.04 before placing the links in the block headers/ artefacts,
when clicking on an artefact, there was a redirection to another page with all the details of the artefact + comments

As I see it there are two options to show all details of each artefact in pdf:

1. Append details at the end of each artefact in the same page
- can have too much data, and it will change the look of the page
- need to define what happens if an artefact has too many comments, we can't show pagination

2. Append a new page to the pdf file with the details and comments of the artefact, as the html in 19.04
- this could be the best option since we don't have to worry about space in the original mahara page and it's easier to implement. We could use the template for /artefact/artefact.php

Changed in mahara:
status: New → Confirmed
importance: Undecided → Wishlist
Revision history for this message
Kristina Hoeppner (kris-hoeppner) wrote :

I'd prefer option 2.

Changed in mahara:
milestone: 20.04rc1 → 20.10.0
Changed in mahara:
milestone: 20.10.0 → 21.04.0
Revision history for this message
Doris Tam (doristam) wrote :

I wasn't able to reproduce this. I made a page with blocks referencing artefacts that had comments attached to them. However, artefact comments didn't appear when I opened up the static HTML of those pages. Which artefacts is this happening to?

Can we please have steps to reproduce this?

Revision history for this message
Doris Tam (doristam) wrote :

I see it now! 😁

Doris Tam (doristam)
Changed in mahara:
status: Confirmed → In Progress
assignee: nobody → Doris Tam (doristam)
Doris Tam (doristam)
summary: - Artefact comments are they appearing in HTML / PDF exports
+ Artefact + general comments are they appearing in HTML / PDF exports
description: updated
Revision history for this message
Mahara Bot (dev-mahara) wrote :

Patch for "master" branch: https://reviews.mahara.org/11527

Changed in mahara:
milestone: 21.04.0 → 21.10.0
Revision history for this message
Doris Tam (doristam) wrote : Re: Artefact + general comments are they appearing in HTML / PDF exports

Decision:

When exporting a PDF export, display artefact comments at the bottom with the page comments. As we can have multiple blocks using the same artefacts, we don't want to double up comments for the same artefacts.

For image artefacts, we shall use the heading '

Revision history for this message
Doris Tam (doristam) wrote :

'Comments for image <image_name.jpg>'
- [display image]
- comments -

For journal type artefacts
'Comments for journal entry <journal_entry_title>
- comments -

For videos, they display as a black blob on the pdf export so we shall use the video title instead
'Comments for video <video_filename>
...

Revision history for this message
Mahara Bot (dev-mahara) wrote : A patch has been submitted for review

Patch for "master" branch: https://reviews.mahara.org/11785

Doris Tam (doristam)
description: updated
Revision history for this message
Mahara Bot (dev-mahara) wrote : A change has been merged

Reviewed: https://reviews.mahara.org/11527
Committed: https://git.mahara.org/mahara/mahara/commit/8df346978c4af1f9dea4dc1b04cd9aea99968a65
Submitter: Robert Lyon (<email address hidden>)
Branch: master

commit 8df346978c4af1f9dea4dc1b04cd9aea99968a65
Author: Doris Tam <email address hidden>
Date: Mon Dec 21 09:24:28 2020 +1300

Bug 1873119: Adding artefact comments in the pdf export

Fix up formatting of comments on HTML export

Replace 'file' lang key calls to use to use the 'File' key instead so
I can use 'file' key to get 'file' string with lower caps along with
other plugin lang strings without lowercase titles to use mid-sentence.

Profile pictures in comments are not showing up - but unrelated to this
bug

Additional typos fixed

Removed the metadata class for comment privacy note

Change-Id: I5c2dc52670b4fcd83347eb56cb5ac743a13bc94f

Revision history for this message
Mahara Bot (dev-mahara) wrote : A patch has been submitted for review

Patch for "master" branch: https://reviews.mahara.org/11970

Revision history for this message
Mahara Bot (dev-mahara) wrote : A change has been merged

Reviewed: https://reviews.mahara.org/11785
Committed: https://git.mahara.org/mahara/mahara/commit/8ecb545305246d0e85d9b3f4dab4f7816f4238e0
Submitter: Robert Lyon (<email address hidden>)
Branch: master

commit 8ecb545305246d0e85d9b3f4dab4f7816f4238e0
Author: Doris Tam <email address hidden>
Date: Mon May 17 16:38:06 2021 +1200

Bug 1873119: Exports: private comment switch

HTML export - done
PDF export - done
Leap2a export - WIP

- Add a switch to allow exporting private comments
- Default to only export public comments
- Added lang string for new switch
- Add option for comment_options to have privatefeedback default true
- Remove dead code
Change-Id: Id0389a6586c27479a30f1ab425683c598592ff33

Revision history for this message
Mahara Bot (dev-mahara) wrote :

Reviewed: https://reviews.mahara.org/11970
Committed: https://git.mahara.org/mahara/mahara/commit/ea4fbaf21621130fe3ba75d56e4a484947a95852
Submitter: Robert Lyon (<email address hidden>)
Branch: master

commit ea4fbaf21621130fe3ba75d56e4a484947a95852
Author: Doris Tam <email address hidden>
Date: Tue Aug 31 21:40:05 2021 +1200

Bug 1873119: Exports: connect comments block to export config

Comment blocks will also be considered on portfolio exports

Change-Id: I50256ebf6b46069aa8181699a457daabc99700fb

Revision history for this message
Mahara Bot (dev-mahara) wrote :

Reviewed: https://reviews.mahara.org/11969
Committed: https://git.mahara.org/mahara/mahara/commit/c01d2f8d183d9fd74e02892ee896db656e34ac7f
Submitter: Robert Lyon (<email address hidden>)
Branch: master

commit c01d2f8d183d9fd74e02892ee896db656e34ac7f
Author: Doris Tam <email address hidden>
Date: Tue Aug 31 20:28:01 2021 +1200

Bug 1873119: Leap2A apply private feedback config to exports
annotations, comments, and peer assessment feedback

Change-Id: I55e9b6a7910daaec0e7c481882751918b7b5adf8

Robert Lyon (robertl-9)
Changed in mahara:
status: In Progress → Fix Committed
tags: added: newfeature
summary: - Artefact + general comments are they appearing in HTML / PDF exports
+ Differentiate private and public comments in exports
Robert Lyon (robertl-9)
Changed in mahara:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.