Exam mode: Remove exercise title from solution containers

[edkaya]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Client

• I added multiple screenshots/screencasts of my UI changes.
• I translated all newly inserted strings into English and German.

Motivation and Context

The title of an exercise is displayed three times during the exam (see screenshot), if the sidebar is not collapsed. Therefore, the exercise title in the solution container becomes unnecessary.

Description

Changed the exercise title displayed in the solution container to a static text "Your Solution", which is presented only in text, modeling, and file upload exercises.

Exam Mode Testing

Prerequisites:

• 1 Exam with 3 exercises (text, modeling, and file upload)
• 1 Student

(There is already an exam called 'Exam Title Container' under my course on TS4. Test users 1-5 are registered to the exam.)

1. Log in to Artemis
2. Participate in the exam
3. Verify that you see 'Your Solution' or 'Deine Lösung' in the solution container header instead of the exercise title

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Exam Mode Test

• Test 1
• Test 2

Screenshots

Before

After

Summary by CodeRabbit

• New Features

  • Updated exercise title display logic to show a translated string for "your solution" based on the exam timeline state.
  • Added new translation keys for "your solution" in both English and German.

• Bug Fixes

  • Improved clarity in user submissions by ensuring the correct title is displayed when the exam timeline is not available.

[coderabbitai]

Walkthrough

The pull request introduces changes to the HTML templates of three components related to exam submissions: file-upload-exam-submission.component.html, modeling-exam-submission.component.html, and text-exam-submission.component.html. The modifications focus on the conditional rendering of exercise titles based on the examTimeline state, replacing direct title displays with a translation key for "your solution." Additionally, new entries for the translation keys are added to the English and German JSON files, enhancing the user interface for exam submissions.

Changes

File Path	Change Summary
src/main/webapp/app/exam/participate/exercises/file-upload/file-upload-exam-submission.component.html	Updated exercise title rendering to use translation key when examTimeline is true.
src/main/webapp/app/exam/participate/exercises/modeling/modeling-exam-submission.component.html	Changed exercise title display logic to show translation key when examTimeline is falsy.
src/main/webapp/app/exam/participate/exercises/text/text-exam-submission.component.html	Modified exercise title rendering to use translation key instead of group title when examTimeline is false.
src/main/webapp/i18n/de/exam.json	Added "yourSolution": "Deine Lösung" to the exam section.
src/main/webapp/i18n/en/exam.json	Added "yourSolution": "Your Solution" to the exam section.
src/test/javascript/spec/component/exam/participate/exercises/file-upload-exam-submission.component.spec.ts	Updated tests to verify static text instead of dynamic values for exercise titles.
src/test/javascript/spec/component/exam/participate/exercises/modeling-exam-submission.component.spec.ts	Removed unused import and updated tests to check for static text.

Possibly related PRs

• Exam mode: Fix problems with highlighting of the differences in the problem statement #8461: Changes in file-upload-exam-submission.component.html and modeling-exam-submission.component.html involve similar modifications to the display logic of exercise titles based on the examTimeline variable.
• Exam mode: Show exercise group title in breadcrumbs #9254: Ensures correct titles are displayed, enhancing clarity in the exam interface.

Suggested labels

bugfix, user interface

Suggested reviewers

• pzdr7
• JohannesStoehr
• coolchock
• SimonEntholzer
• anian03

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between b6b47e7 and 182626b.

📒 Files selected for processing (5)

• src/main/webapp/app/exam/participate/exercises/file-upload/file-upload-exam-submission.component.html (1 hunks)
• src/main/webapp/app/exam/participate/exercises/modeling/modeling-exam-submission.component.html (1 hunks)
• src/main/webapp/app/exam/participate/exercises/text/text-exam-submission.component.html (1 hunks)
• src/main/webapp/i18n/de/exam.json (1 hunks)
• src/main/webapp/i18n/en/exam.json (1 hunks)

🧰 Additional context used

📓 Path-based instructions (4)

src/main/webapp/app/exam/participate/exercises/file-upload/file-upload-exam-submission.component.html (1)

Pattern src/main/webapp/**/*.html: @if and @for are new and valid Angular syntax replacing *ngIf and *ngFor. They should always be used over the old style.

src/main/webapp/app/exam/participate/exercises/modeling/modeling-exam-submission.component.html (1)

Pattern src/main/webapp/**/*.html: @if and @for are new and valid Angular syntax replacing *ngIf and *ngFor. They should always be used over the old style.

src/main/webapp/app/exam/participate/exercises/text/text-exam-submission.component.html (1)

Pattern src/main/webapp/**/*.html: @if and @for are new and valid Angular syntax replacing *ngIf and *ngFor. They should always be used over the old style.

src/main/webapp/i18n/de/exam.json (1)

Pattern src/main/webapp/i18n/de/**/*.json: German language translations should be informal (dutzen) and should never be formal (sietzen). So the user should always be addressed with "du/dein" and never with "sie/ihr".

🔇 Additional comments (3)

src/main/webapp/app/exam/participate/exercises/modeling/modeling-exam-submission.component.html (1)

19-19: LGTM! Verify translation key existence.

The changes align with the PR objectives by conditionally rendering either the exercise title or "Your Solution" based on the examTimeline value. The new Angular syntax (@if) is correctly used as per the coding guidelines.

To ensure the translation key is properly set up, please run the following script:

src/main/webapp/app/exam/participate/exercises/text/text-exam-submission.component.html (1)

19-19: LGTM! Verify translation key existence.

The change aligns well with the PR objectives by replacing the exercise title with a translated "Your Solution" text when examTimeline is false. This modification enhances the user interface for exam submissions as intended.

To ensure the translation key is properly defined, please run the following script:

This script will help confirm that the new translation key is properly defined in both language files, ensuring a smooth localization experience.

src/main/webapp/i18n/de/exam.json (1)

153-153: Translation looks good!

The added translation "Deine Lösung" for "yourSolution" is correct and follows the required informal style (dutzen). It's consistent with the context and maintains the JSON structure.

[anian03]

Tested, works as expected

[SimonEntholzer]

Would it be possible here to use the jhiTranslate instead of the artemisTranslate pipe?

[JohannesStoehr]

Code

[edkaya]

Would it be possible here to use the jhiTranslate instead of the artemisTranslate pipe?

I couldn't find a way to use jhiTranslate here. Any suggestions?

Edit:
We can use something like this @SimonEntholzer:
<ng-container *ngTemplateOutlet="examTimeline ? yourSolution : exerciseTitle"></ng-container>
<ng-template jhiTranslate="artemisApp.exam.yourSolution"#yourSolution></ng-template>
<ng-template jhiTranslate="artemisApp.exam.exerciseTitle" #exerciseTitle></ng-template>

But I think it's not really a great approach if the only reason is to avoid using the artemisTranslate pipe here. So I would still use artemisTranslate here 😄

[PaRangger]

Code LGTM