Feature Wiki

Information about planned and released features

Tabs

Replace TinyMCE by Markdown Editor in Data Collection

1 Initial Problem

The TinyMCE is without maintenance.

Its use prevents the switch to kitchen sink forms.

2 Conceptual Summary

The TinyMCE in the data collection is to be replaced by the Markdown Editor. (See here)

There will be no migration. In accordance with previous processes for switching from TinyMCE to ILIAS Page Editor or Markdown a read-only until ILIAS 10, if it exists.
This content will be removed in ILIAS 11 and later.

The settings form of the individual table should be converted to KS Forms.
That's a good thing.

The context DataCollection was never considered in the Administration settings for TinyMCE, therefore no changes are to be considered.

3 User Interface Modifications

3.1 List of Affected Views

  • "Settings"-Tab in each Data Collection Table.

3.2 User Interface Details

Integration of the Markdown Editor
If content has already been created with TinyMCE, it will be made accessible.

3.3 New User Interface Concepts

None.

3.4 Accessibility Implications

None.

4 Technical Information

Within this Feature the whole Form was refactored to the new UIForm.
This has some minor visual implications (see "Implementation").

5 Privacy

Nothing specific.

6 Security

Nothing specific.

7 Contact

8 Funding

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

9 Discussion

Kunkel, Matthias [mkunkel], 27 MAY 2024: Will there be a separate FR for introducing the markdown editor in the DC? IMHO it makes sense to bundle both requirements. Otherwise it could happen that we only have a simple text input – which I would object! Therefore I recommend to rename this FR to "Replace TinyMCE by Markdown Editor in Data Collection" and to add additional information to the page. Thanks!

Samoila, Oliver [oliver.samoila], 19 May 2024: Thank you for your feedback. I have restructured the request from the perspective of the replacement.

JourFixe, ILIAS [jourfixe], 10 JUN 2024: We highly appreciate this suggestion and accept it for ILIAS 10 / trunk.

10 Implementation

The feature is implemented here.

Due to the usage of the new Form, which implies a more strict UI, the following changes where made:

  • The form title was removed.
  • A section title for the first section was added ("General settings")
  • The form button was unified to "save" instead of "Create/Update table" and "cancle"
  • The Info "field" within the User Actions section was moved to the sections byline

There is no automatic migration.
The current content of descriptions will be migrated by resaving the description (html tags will be removed by the markdown editor on save).

Test Cases

Test cases completed at 05 November 2024 by Samoila, Oliver [oliver.samoila].

  • C281 : Neue Tabelle erstellen

Privacy

Information in privacy.md of component: no change required

Approval

Approved at 24th October 2024 by Becker, Matthias [matthias.becker].

Last edited: 13. Nov 2024, 16:00, Szmais, Ingmar [iszmais]