Revision of Public Comments Overview

1 Initial Problem

The "Public Comments" (Communication menu) consists of legacy components and cannot be accessed via the central Kitchensink components, nor does it benefit functionally from changes to the framework.

In addition, the page currently uses a combination of multiple selection and content display, which should be revised.

In the context of these adjustments, the existing functions should also be reconsidered and conceptually revised.

Current Situation

2 Conceptual Summary

Public comments can be added to various ILIAS objects if the option has been activated. They are used to start a discussion or to place one's own opinion and information publicly for others to see. The Public Comments overview page offers the possibility to view your own public comments collected in one place and in connection with the other comments on the same object.

2.1 Add Toolbar

A toolbar is introduced.

Print
The action "Print" is moved to this toolbar.

1. click on "Print".
2. The Print button invokes the browser print feature. (same procedure like Remove PDF Generation from Wiki)
3. Nothing changes here.

If the comments are filtered (i.e. not all are visible) only the filtered comments are printed.

Sort Ascending / Sort Descending

With the introduction of ListingPanels, the current "Sort Ascending" is offered as an sortation view control in the toolbar in Comments Screen and Comments Modal.

• en: Creation Date, asc. / Creation Date, desc.
• de: Erstellungsdatum, aufst. / Erstellungsdatum, abst.

The default setting of the view control should be Creation Date, desc..

Additional Information

As requested by the JF, we have adjusted the existing labels. Our proposal has no general validity. The labels of sorting options should be discussed and decided elsewhere.
If you want to follow the discussion, check out the following BR (see Mantis 26634).

Add Comment

If an object has been selected via the filter, the toolbar is extended by the Add Comment entry. If the user clicks on the button, a modal will open and a comment can be added to the corresponding object. 

2.2 Introduce new filter

In order to find the desired comments quickly, the new filter is to be used, which allows the comments to be filtered according to different criteria:

• Filter by Text (textinput)
  • searches all texts (user name, content of comments and object title)
• Filter by Object (multiselect)
  • new: Entry "All" (default)
  • lists all objects where user added a comment (f.e. Discussionforum, Introduction of Algebra)

All comments are displayed chronologically (last comment on top) and grouped by same object (Course XY, Discussionforum,....). The group with the latest comment will be displayed on top.

The filter should be collapsed by default and the object filter should be set to all.

2.3 Transfer to ListingPanel

Transfer of the previous content to the Standard Listing Panel:

• List Title = Comments
• Subtitle = Object Title (f.e. Discussionforum, Introduction of Algorithm, ...)
• Image = Letter or Picture Avatar
• Item Title = First Name Last Name [username] (f.e. Bert Sommer [b.sommer])
• Content = Comment
• Key Value Pairs
  • Origin = The object to which the comment is assigned
  • Date = Creation Date or Last edited Date of Comment
• Actions
  • Edit
  • Delete

Additional Information (not part of the request):

The ListingPanel is primarily used to present the comments. With the introduction of the Listing Panel, the possibility of deleting multiple comments is eliminated. This is not a private comment issue, but a common issue with the introduction of panels. To enable multiple action in panel as well, this issue is discussed in another feature request. For the concept of the Manage screen, see Introduction of a new Manage screens

2.4 Actions

Edit
If a comment is edited, a roundtrip-modal opens in which the comment can be edited. This is the same modal that is displayed for the object when editing a comment from there.

Structure of Modal

1. Header with title of the modal and close-Glyph
2. Content:
   1. Visual indication of which object it is
   2. Text input with existing comment (editable)
   3. Button "Update Comment"
   4. In chronological order all other comments at this point as standard listing panel
3. Footer with "Cancel" button.

Clicking on the "Update Comment" button saves the updated comment, closes the modal and returns to the comment page. A message indicates that the changes have been saved. The comment has been updated and the date adjusted. (as before).

Clicking on the "Cancel" button closes the modal and returns you to the commentary page. The comment is not updated.

Delete
If a comment is deleted, a message box appears asking whether you are sure that the comment should be deleted.

2.5 Abandon Add Comment Input Field

Currently, comments can be added directly from the comments page. To do this, an object must first be selected, then a new comment can be added to this object.

To simplify the page, it should only be used to represent and edit or delete existing comments. Therefore, we recommend to remove the Input Field and the "Add Comment" action from this screen. Via the link to an object type (origin of comment) of an existing comment, users can go directly to an object and add new comments from there.

3 User Interface Modifications

3.1 List of Affected Views

3.2 User Interface Details

3.3 New User Interface Concepts

Use existing KS-elements like Standard Listing Panel and Standard Filter

The standard listing panel needs to be extended so that it can display the letter or picture avatar.

3.4 Accessibility Implications

4 Technical Information

No technicall issues.

5 Privacy

See Notes and Comments PRIVACY.md

6 Security

No security issues.

7 Contact

8 Funding

If you are interest in funding this feature, please add your name and institution to this list.

9 Discussion

JourFixe, ILIAS [jourfixe], 04 APR 2022 : Thanks for revising the feature request. We highly appreciate the suggestion and accept the feature for ILIAS 8. Filter should be deactivated by default to show all comments.

10 Implementation

Workflow Header Action (modal)

Workflow Dashboard (embedded)

Workflow Infoscreen (embedded)

This is an example for the "Add" action. Everything happens in the location where the widget is initially rendered. In all cases the same thing happens. The "Add" button just shows the form at the current location. The "mixed" mode would require to either a) show the form in the current location or b) open a modal and rerender the list including the form. This kind of conditional code would be needed for all Buttons and Dropdown actions.

Test Cases

Approval

Approved at 2022-05-11 by Stake, Sebastian [sstake].