Feature Wiki

Information about planned and released features

Tabs

Specific Language Variables for Placeholders in Study Programme Mail

1 Initial Problem

There are a number of language variables used for very different purposes, i.e., for the description of placeholders in study programme mails and for table headers in the "Assignments" tab.
With a few of them, the requirements are too different to find a good wording across both purposes:

  • prg#:#prg_status#:#Status
  • prg#:#prg_completion_date#:#Completion date
  • prg#:#prg_completion_by#:#Completion by
  • prg#:#prg_points_required#:#Points Required
  • prg#:#prg_points_current#:#Points Current
  • prg#:#prg_deadline#:#Deadline
  • prg#:#prg_expiry_date#:#Expiry date
  • prg#:#prg_validity#:#Validity

There are some reasons why requirements of both purpose are falling apart:

  • With table headers, it's obvious that information in its table cells is referring to one specific assignment only.
    With placeholders, you better explain that in a little more detail, e.g., the deadline the placeholder is resolved to is the earliest deadline from all assignments of a user, or the end of validity will be resolved to the date furthest in the future.
  • You have plenty of screen space when describing placeholders but little space for table headers.
  • With table headers you obviously need title case in English while this seems questionable with desciption texts for placeholders.

2 Conceptual Summary

There are specific language variables for the description texts for placeholders:

  • prg#:#prg_status_placeholder#:#Status of the latest assignment
  • prg#:#prg_completion_date_placeholder#:#Youngest completion date
  • prg#:#prg_completion_by_placeholder#:#Youngest completion by
  • prg#:#prg_points_required_placeholder#:#Points required from the assignment in progress (if unambiguous)
  • prg#:#prg_points_current_placeholder#:#Points currently achieved Points by the assignment in progress (if unambiguous)
  • prg#:#prg_deadline_placeholder#:#Earliest deadline
  • prg#:#prg_expiry_date_placeholder#:#Expiry date furthest in the future
  • prg#:#prg_validity_placeholder#:#Validity of the assignment with expiry date furthest in the future

3 User Interface Modifications

3.1 List of Affected Views

  • Compose Mail (from "Assignments" tab of a study programme)

3.2 User Interface Details

Changed wording, s. above

3.3 New User Interface Concepts

none

3.4 Accessibility Implications

none

4 Technical Information

{ The maintainer has to provide necessary technical information, e.g. dependencies on other ILIAS components, necessary modifications in general services/architecture, potential security or performance issues. }

5 Privacy

none

6 Security

none

7 Contact

8 Funding

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

9 Discussion

10 Implementation

{ The maintainer has to give a description of the final implementation and add screenshots if possible. }

Test Cases

Test cases completed at {date} by {user}

  • {Test case number linked to Testrail} : {test case title}

Privacy

Information in privacy.md of component: updated on {date} by {user} | no change required

Approval

Approved at {date} by {user}.

Last edited: 6. Mar 2023, 11:24, Suittenpointner, Florian [suittenpointner]