Review main Merged

88050[TASK] Allow markdown syntax in settings descriptions

Benjamin Franzke CR +2 V +2 Normal +199 −22 updated 02/10/25, 11:29

Commit message

Site settings and category descriptions can now use
markdown syntax in order to add code formatting,
line-breaks or blockquotes.

Executed commands:

  npm install marked dompurify
  grunt build

Review

  • Code review CR +2 Done
    • Andreas Kienast +2
    • Benjamin Kott +1
  • Verified V +2 Done
    • Andreas Kienast +2
    • Benjamin Kott +1
    • core-ci +1 CI

Issues 1

Files 18

Review log 2028

Show 23 earlier messages
  1. Benjamin Franzke uploaded patch set 1 02/06/25, 10:41

  2. core-ci voted on patch set 1 V +1 02/06/25, 10:48 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/73646

  3. Benjamin Franzke uploaded patch set 2 V +1 02/06/25, 11:17

  1. core-ci voted on patch set 2 V +1 02/06/25, 11:23 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/73647

  2. Benjamin Franzke voted on patch set 2 CR -1 02/06/25, 11:56

  3. Benjamin Franzke uploaded patch set 3 CR -1 V +1 02/06/25, 13:59

  4. core-ci voted on patch set 3 V +1 02/06/25, 14:08 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/73661

  5. Benjamin Franzke uploaded patch set 4 V +1 02/06/25, 14:08

  6. core-ci voted on patch set 4 V +1 02/06/25, 14:15 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/73664

  7. Garvin Hicking commented on patch set 4 02/06/25, 14:16

    Feature-103437-IntroduceSiteSets.rst:72

    Would it be consciously not applied for the category description as well?
  8. Benjamin Franzke uploaded patch set 5 V +1 02/07/25, 14:16

  9. Benjamin Franzke commented on patch set 5 02/07/25, 14:16

    Feature-103437-IntroduceSiteSets.rst:72 Reply

    I'd argue that a category description should be plaintext-only as code blocks or what-not would clutter the interface – but I'm not strongly against it and I'm fine with supporting it (with the hope that it is not misued to add too long descriptions…)
  10. Benjamin Franzke uploaded patch set 6 02/07/25, 14:20

  11. core-ci voted on patch set 5 V +1 02/07/25, 14:22 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/73734

  12. core-ci voted on patch set 6 V +1 02/07/25, 14:27 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/73735

  13. Benjamin Kott commented on patch set 6 CR -1 V -1 02/07/25, 15:22

    missing null checks
  14. Benjamin Franzke uploaded patch set 7 CR -1 V +1 02/07/25, 15:28

  15. Benjamin Franzke commented on patch set 7 02/07/25, 15:29

    Reply

    Thanks! Fixed.
  16. Benjamin Kott voted on patch set 7 CR +1 V +1 02/07/25, 15:36

  17. core-ci voted on patch set 7 V +1 02/07/25, 15:37 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/73747

  18. Andreas Wolf commented on patch set 7 CR +1 02/07/25, 20:30

    Looks good except for two nitpicks on the labels.

    labels.xlf:36

    The "" around the values should probably be removed if we code-highlight them, or?

    labels.xlf:30

    disable => disables
  19. Benjamin Franzke uploaded patch set 8 CR +1 V +1 02/09/25, 06:14

  20. Benjamin Franzke commented on patch set 8 02/09/25, 06:14

    labels.xlf:36 Reply

    Ack, I actually kept it because Backtick-Backtick was printed as-is and not as `<code></code>` by the markdown parser in the case for the `settings.description.styles.content.links.keep` label where an empty-string is shown as an example. Therefore I kept `"` in all cases for consistency. Anyway, I like it better without `"` as well and therefore used another workaround using `<code> </code>` (not ideal either, but better than placing `"` all over the place) for `settings.description.styles.content.links.keep` and adapted the styling to make spaces in code blocks visible.

    labels.xlf:30 Reply

    Thanks, fixed!
  21. core-ci voted on patch set 8 V +1 02/09/25, 06:20 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/73827

  22. Andreas Kienast voted on patch set 8 CR +1 V +1 02/10/25, 11:21

  23. Benjamin Kott voted on patch set 8 CR +1 V +1 02/10/25, 11:22

  24. Andreas Kienast voted on patch set 8 CR +2 V +2 02/10/25, 11:22

  25. Andreas Kienast merged patch set 9 02/10/25, 11:29