Review main Merged

90503[DOCS] Improve EXT:form finisher documentation

Christian Reifenscheid CR +2 V +2 Expert +1200 −1011 updated 09/21/25, 09:46

Commit message

This patch:

* fixes incorrect indentation in config examples
* adds a hint for iconIdentifier
* splits up the finisher documentation into smaller sections

Review

  • Code review CR +2 Done
    • Garvin Hicking +2
    • Lina Wolf +1
  • Verified V +2 Done
    • Garvin Hicking +2
    • Lina Wolf +1
    • core-ci +1 CI

Issues 1

Files 23

Show 3 more files

Review log 3241

Show 1416 earlier messages
  1. Christian Reifenscheid uploaded patch set 1 08/29/25, 07:10

  2. core-ci voted on patch set 1 V +1 08/29/25, 07:17 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/83968

  3. Lina Wolf commented on patch set 1 08/29/25, 16:44

    Great Work! I have some remarks however. Unfortunarily we have no automatic checks for syntx and cgl yet

    Index.rst:14

    The backtick markup should be used for code only, it will create something like <code>Redirect finisher</code> in the output. You can just write redirect finisher

    Index.rst:10

    Always use indentation of 4 spaces as is configured in the editorconfig.

    Index.rst:12

    Some merging artefacts?

    Index.rst:25

    I would suggest to put large amount of code into an external file and include it. It has the advantage that you can automatically apply CGL and indentation, have syntax check etc. See https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Code/Codeblocks.html#literalinclude

    Index.rst:5

    The first headline in a rst document should be overlined and underlined with === See https://docs.typo3.org/permalink/h2document:headlines-and-sections
  4. Lina Wolf commented on patch set 1 CR -1 08/29/25, 16:46

    There are merging artefacts in one file. This may not be merged like this
  5. Christian Reifenscheid uploaded patch set 2 CR -1 V +1 09/01/25, 13:13

  6. Lina Wolf commented on patch set 2 09/01/25, 13:17

    Index.rst:14 Reply

    Done

    Index.rst:10 Reply

    Done

    Index.rst:12 Reply

    Done

    Index.rst:25 Reply

    Done
  7. core-ci voted on patch set 2 V +1 09/01/25, 13:20 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/84154

  8. Lina Wolf commented on patch set 2 CR +1 09/01/25, 13:21

    restructured text looks good, I did not try rendering yet
  9. Georg Ringer voted on patch set 2 CR +1 V +1 09/01/25, 16:17

  10. Josua Vogel commented on patch set 2 09/04/25, 18:23

    Thank you for the patch! Two thoughts from me: - Should it be clustered more, i.e., a top page for finishers, which the core provides (subpages are then EmailFinisher, etc.) - and parallel to this, the pages for translating and custom finisher? Currently, it still seems a bit confusing to me. - Should the page “Custom finisher” be assigned to the developer area instead? I generally find it difficult to divide certain topics according to target group.
  11. Josua Vogel commented on patch set 2 09/04/25, 18:26

    Reply

    addition: maybe put the translation part on the new page and link inside frontend rendering
  12. Stefan Froemken commented on patch set 2 09/05/25, 08:44

    You have added the important-box about process-ordering of finishers to each individual finisher. Is that really needed? The is already a global available important box available: https://docs.typo3.org/c/typo3/cms-form/main/en-us/E/Finishers/Index.html

    Index.rst:9

    Either 3 or 4 (preferred) indents, but do not mix the indents here
  13. Christian Reifenscheid commented on patch set 2 09/05/25, 09:34

    Reply

    I wasn’t entirely sure while I was doing this. I thought of developers who had come directly from a search engine or followed a link, and I wanted to make sure they received this information as well.

    Index.rst:14 Reply

    Done

    Index.rst:10 Reply

    Done

    Index.rst:12 Reply

    Done

    Index.rst:25 Reply

    Done

    Index.rst:5 Reply

    Done
  14. Christian Reifenscheid uploaded patch set 3 CR +1 V +1 09/08/25, 13:00

  15. Christian Reifenscheid uploaded patch set 4 09/08/25, 13:00

  16. Christian Reifenscheid commented on patch set 2 09/08/25, 13:04

    Reply

    Hi Josua, thanks for your feedback. I agree. Therefore, I have clustered it a bit more (please see the latest patchset). I also agree with this. While checking the corresponding part of the documentation, I noticed that this chapter could also use some improvement. I would like to handle this in a separate task, so I left it untouched for now.

    Index.rst:9 Reply

    Done
  1. Josua Vogel commented on patch set 4 09/08/25, 13:07

    Reply

    Done
  2. core-ci voted on patch set 3 V +1 09/08/25, 13:08 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/84628

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

  4. Josua Vogel commented on patch set 4 09/08/25, 13:10

    Reply

    I would remove the box on the pages of the developer section. It´s important for editors and this is documented on the corresponding page. As I already mentioned, this should be structured differently - but in another patch.
  5. Christian Reifenscheid commented on patch set 4 09/18/25, 10:53

    Reply

    Acknowledged
  6. Garvin Hicking uploaded patch set 5 V +1 09/19/25, 18:17

  7. Garvin Hicking commented on patch set 5 09/19/25, 18:19

    I took the liberty to structure this around a bit. I think the central note in subpages has some worth to keep. And it allows in the future to maybe put up more code examples in each finisher section (or describe finisher overrides or so). I also removed a dedicated subpage just to point to another chapter.
  8. Garvin Hicking voted on patch set 5 CR +1 V +1 09/19/25, 18:19

  9. core-ci voted on patch set 5 V +1 09/19/25, 18:25 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85182

  10. Stefan Froemken commented on patch set 6 CR +1 V +1 09/19/25, 18:40

    Published edit on patch set 5.
  11. core-ci voted on patch set 6 V +1 09/19/25, 18:46 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85184

  12. Garvin Hicking voted on patch set 6 CR +1 V +1 09/19/25, 18:53

  13. Stefan Froemken commented on patch set 7 CR +1 V +1 09/19/25, 19:31

    Published edit on patch set 6.
  14. Stefan Froemken commented on patch set 7 CR +1 09/19/25, 19:34

    Thank you for your work, but I saw all these 3-4 indent miss-match. Holy! This EXT:form doc kills me. I have not changed any text. I just corrected the indents and wrap 3 or 4 long lines into next line.
  15. core-ci voted on patch set 7 V +1 09/19/25, 19:38 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85185

  16. Lina Wolf commented on patch set 7 CR -1 09/20/25, 07:33

    Working on it
  17. Lina Wolf uploaded patch set 8 CR +1 V +1 09/20/25, 08:47

  18. Lina Wolf commented on patch set 8 CR +1 V +1 09/20/25, 08:48

    Looks good to me. We might want to make a follow up, where we integrate https://docs.typo3.org/c/typo3/cms-form/main/en-us/D/FinisherOptions/Index.html directly into this chapter
  19. Lina Wolf commented on patch set 8 09/20/25, 08:50

    Reply

    I moved more codesnippets into files, added some introductionary passages, made the warning box smaler and created a dedicated section with an example that is linked instead. Also corrected some additional syntax issues.
  20. core-ci voted on patch set 8 V -1 09/20/25, 08:53 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85200

  21. Lina Wolf uploaded patch set 9 CR +1 V +1 09/21/25, 08:17

  22. Lina Wolf voted on patch set 9 CR +1 V +1 09/21/25, 08:17

  23. core-ci voted on patch set 9 V +1 09/21/25, 08:24 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85242

  24. Garvin Hicking voted on patch set 9 CR +2 V +2 09/21/25, 09:37

  25. Garvin Hicking merged patch set 10 09/21/25, 09:46