Feature Wiki

Information about planned and released features

Tabs

Abandon ILIAS-specific TinyMCE Plugins for Forum and Test & Assessment

1 Reasons to Abandon Feature

The TinyMCE as a rich text editor is used in ILIAS to let user generate HTML content in places like:

  1. CoPage
  2. Survey
  3. SurveyQuestionPool
  4. Exercise
  5. Forum
  6. TestQuestionPool

There are ILIAS-specific plugins provided in the TinyMCE toolbar, which can be used within the components 2 - 6 when creating/editing content:

  1. Create/edit LaTeX code
  2. Paste from Latex
  3. Insert/edit image
  4. Quotation

1.1 Latest Changes

While these ILIAS-specific plugins have been rewritten (1, 2, 4) or created (3) to support TinyMCE in Version 5.x in the course of the "Call for Bids: 'Updating Tiny MCE to Most Current Stable Version'" of the ILIAS open source e-Learning e. V. for ILIAS 7.x (won by Minervis and implemented), the RTE component itself is not actively maintained anymore (see: https://github.com/ILIAS-eLearning/ILIAS/blob/trunk/docs/development/maintenance.md). Unfortunately, this implementation was not followed by a takeover of the maintainership.

1.2 Current State

As a result of the "Dependency JourFixe" for ILIAS 10, PR 6748 suggested to reintroduce TinyMCE in Version 6.x for our NPM JavaScript dependencies, but without caring about these ILIAS-specific plugins.

There is currently no one who feels responsible to upgrade these ILIAS-specific TinyMCE plugins to be compatible with ILIAS 10, nor to maintain the RTE component (where these plugins should belong to). They have to be upgraded to be compatible with the suggested TinyMCE version for ILIAS 10 (as mentioned above, 6.x, but the latest stable release is already 7.x).

Beside the maintenance problem described above, the strategy of ILIAS is to get rid of the TinyMCE, and instead, push the Markdown based editor. Unfortunately, this cannot be used as a "Drop In Replacement" for ILIAS 10, because such ILIAS-specic TinyMCE plugins are not yet/will possibly never be part of the Markdown editor.

Therefore the authorities of the components Test & Assessment and Forum suggest to abandon the usage of the above mentioned plugins in their components for ILIAS 10.

1.3 What does this mean for our users?

As long as the TinyMCE is still available in the components, at least LaTex can be still integrated (by "Power Users" who are familiar with the syntax) by using the "Source Code" feature of the TInyMCE to create/edit the raw HTML.
Even images can be included by specifing the respective HTML elements and using http(s) ressources.

  • Although it will be possible to reference images by editing the raw HTML, it won't be possible anymore to upload images like in ILIAS <= 9.x (where these images are converted to media objects and fully integrated into ILIAS).
    • Outlook: There are ongoing conceptual discussions and also scheduled projects for a feasibility study to introduce such a conveniance functionality for image uploads for the Markdown editor.
  • There won't be a replacement for the "Quotation" plugin in forums. So quotations have to be manually added, e.g. by using the "Source Code" feature.

2 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.}

3 Contact

4 Funding

Removing the feature from the ILIAS code base might need funding. If you are interest in funding this request, please add your name and institution to this list.

  • ...

5 Discussion

Use the following discussion section to express your objections against this request or your consent to get rid of this feature.

2024-05-13, Falkenstein, Rob [rob]: Hi all, thank you for presenting the current state of Tiny, its plugins and the outlook to the markdown based editor. When I read this request some questions were coming up:
- Is there a way in order to ensure the longtime ability to use LaTex syntax in the T&A component?
- Do we have any reading resources about the reasons for the abandonment of the TinyMCE? This editor is widely used in the internet and reasons to abandon this editor should concern other projects as well.
- Do we have any reading resources that compare the current features of TinyMCE and the features and planned features of the markdown based editor or can you provide some more information? 
- How can I test the current implementation of the markdown editor? In general I am open for a replacement of Tiny but my wish is that there is an obvious and understandable way of transfering old content and functions to the upcoming editor. 
Best regards,
Rob

Kunkel, Matthias [mkunkel], 13 MAY 2024: We highly appreciate this suggestion and abandon the Tiny plugin support with ILIAS 10. Existing legacy content (that uses images or LaTex) won't be changed. Adding LaTex will also be possible but requires input via HTML input.

6 Implementation

{The maintainer has to give a description of the final implementation and possible consequences for existing installations.}

Removed Testcases

The following testcases have been removed from Testrail or modified because the feature is no longer part of the ILIAS core.

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

Approval

Approved at {date} by {user}.

Last edited: 13. May 2024, 16:03, Kunkel, Matthias [mkunkel]