Skip to content

ENH: Add a WYSIWYG editor for text properties

Florian Spreckelsen requested to merge f-wysiwyg into dev

Summary

Needed for https://gitlab.indiscale.com/caosdb/customers/cfaed/management/-/issues/13. Adds a WYSIWYG editor to (scalar) text properties that produces markdown output.

Focus

ckeditor was added to the project's dependencies and is used in ext_editmode_wysiwyg_text.js to replace the textareas of scalar text properties. Do you think that the decision to leave out lists of text is a reasonable one?

Test Environment

Start the WebUI wit BUILD_MODULE_EXT_EDITMODE_WYSIWYG_TEXT = ENABLED. Verify that

  • entities with text properties are assigned WYSIWYG editors when they are edited
  • the editor does not appear in any other input fields
  • newly added text properties also have the editor
  • toggling a scalar property to a list makes the editor vanish, toggling back makes it re-appear

You may also test the output of the editor with various markdown commands together with the complexity wiki. Use the local-query branch of the cfaed server profile and main in complexitywiki for this.

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

  • All automated tests pass
  • Reference related Issues
  • Up-to-date CHANGELOG.md
  • Annotations in code (Gitlab comments)
    • Intent of new code
    • Problems with old code
    • Why this implementation?

Check List for the Reviewer

  • I understand the intent of this MR
  • All automated tests pass
  • Up-to-date CHANGELOG.md
  • The test environment setup works and the intended behavior is reproducible in the test environment
  • In-code documentation and comments are up-to-date.
  • Check: Are there spezifications? Are they satisfied?

For further good practices have a look at our review guidelines.

Edited by Henrik tom Wörden

Merge request reports