Review main Abandoned

86178[DOCS] Update EXT:form YAML config for backend

Stefan Froemken CR 0 V 0 Hard +231 −177 updated 02/25/25, 21:08

Commit message

Update example on how to register TypoScript for EXT:form
backend context. Remove a duplication of YAML registration
for backend. Correct indents. Migrate table to a
better readable rst format

Review

  • Code review CR 0
  • Verified V 0

Issues 1

Files 1

Review log 2633

Show 68 earlier messages
  1. Stefan Froemken uploaded patch set 1 09/18/24, 10:31

  2. Stefan Froemken uploaded patch set 2 09/18/24, 10:32

  3. core-ci voted on patch set 2 V +1 09/18/24, 10:48 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/66120

  4. core-ci voted on patch set 1 V +1 09/18/24, 10:48 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/66119

  5. HOJA M A voted on patch set 2 CR +1 09/18/24, 10:51

  6. Garvin Hicking commented on patch set 2 09/18/24, 11:04

    Thanks! Minor comment. And we should cherry-pick this to 12.4 too, right? Does it apply to v11, too?

    Index.rst:132

    Unsure here. It's good you adjusted the example above, but IMO it's still viable to do module TS configuration in your custom sitepackage extension via "regular" setup.typoscript and not inside PHP ext_localconf.php scope. How about phrasing the sentence abbove to: ```` Since the key ``10`` is already taken, we recommend registering your own configuration beginning with the key ``100``. You can override the default module configuration either via a custom extension's :file:`setup.typoscript` with TypoScript, or you can use the same "inline typoscript" option through the :file:`ext_localconf.php` file of your custom extension. ``` And then we would continue to highlight this code as :typoscript, without the wrap around. (phrasing TBD)
  7. Stefan Froemken uploaded patch set 3 CR +1 V +1 09/18/24, 12:16

  8. Stefan Froemken commented on patch set 2 09/18/24, 12:17

    I have added a second example on how to extend EXT:form module TS with ext_typoscript_setup.typoscript

    Index.rst:132 Reply

    Hi Garvin, if you open the EXT:form module you don't have any page-tree. So you can't chose a page where your setup.typoscript is inserted. So, you have to add that module.* TypoScript to a place where it is always available. And that's only the global|default TypoScript which can be registered via ext_typoscript_setup.typoscript or via ExtensionManagerUtility. It looks like EXT:form has migrated the ext_typoscript_setup.typoscript solution to ext_localconf.php in earlier patches. That makes sense as you can't override that TS in your own site-package with an ext_localconf.php solution. In patch you see that I replaced some TypoScript codes to PHP already. To override the default TS of EXT:form I always prefer to use the same way. But maybe you have written the wrong, but mean the right. In that case: Yes, we can add a note about extending module TS with ext_typoscript_setup.typoscript.
  1. core-ci voted on patch set 3 V +1 09/18/24, 12:33 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/66132

  2. Garvin Hicking commented on patch set 3 CR +1 09/18/24, 12:36

    Index.rst:132 Reply

    Yes, sorry for confusing these. I'm not really an integrator and I often mess TSConfig/TS setup/PageTSConfig and similar terms up. So you did good, thank you! :)
  3. Chris Müller commented on patch set 3 09/18/24, 15:30

    Index.rst:142

    I suggest to use the current timestamp as best practise. In one of my 3rd-party extensions, a got an issue, that I override someones 100 because I also use 100. A timestamp should not collide with other configurations of extensions.

    Index.rst:155

    Here too.
  4. Garvin Hicking commented on patch set 3 09/18/24, 16:12

    Index.rst:142 Reply

    This is a good point. The documentation currently mixes "extending" and "overriding". Maybe we should give an exmpample for both. I agree that picking "100" instead is unfortunate, and would be a good improvement to change this now!
  5. Stefan Froemken uploaded patch set 4 CR +1 V +1 09/19/24, 10:29

  6. Stefan Froemken commented on patch set 4 09/19/24, 10:31

    Uploaded new patch. As described: Each example has now its own individual timestamp ;-)

    Index.rst:142 Reply

    Good point. I also had the timestamp solution in all of my projects. Done.

    Index.rst:155 Reply

    Done
  7. Stefan Froemken commented on patch set 4 09/19/24, 10:31

    Index.rst:142 Reply

    Done
  8. core-ci voted on patch set 4 V +1 09/19/24, 10:45 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/66198

  9. Garvin Hicking voted on patch set 4 CR +1 V +1 09/19/24, 15:11

  10. Chris Müller commented on patch set 4 CR -1 09/19/24, 16:56

    Index.rst:161

    Hmm, maybe I don't understand: but aren't the methods described *above* for backend?

    Index.rst:172

    Isn't the TypoScript record (meaning sys_template) only frontend-related? Or which record is meant? Maybe I don't understand it correctly.

    Index.rst:175

    You switch b to 1. But 1 is for the whole installation?
  11. Stefan Froemken uploaded patch set 5 09/19/24, 18:49

    Copied Votes: * Code-Review+1, Code-Review-1 (copy condition: "**changekind:NO_CHANGE** OR is:MIN") * Verified+1 (copy condition: "**changekind:NO_CHANGE**")
  12. core-ci voted on patch set 5 V +1 09/19/24, 18:54 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/66241

  13. Stefan Froemken uploaded patch set 6 CR +1 V +1 09/19/24, 18:55

  14. Stefan Froemken commented on patch set 6 09/19/24, 18:59

    Index.rst:161 Reply

    > Hmm, maybe I don't understand: but aren't the methods described *above* for backend? Remove that part, because of duplication

    Index.rst:172 Reply

    > Isn't the TypoScript record (meaning sys_template) only frontend-related? Or which record is meant? Maybe I don't understand it correctly. Removed a lot of duplications

    Index.rst:175 Reply

    > You switch b to 1. But 1 is for the whole installation? I have remove the whole part. It was the same as the explanation from above
  15. Stefan Froemken commented on patch set 6 09/19/24, 18:59

    Index.rst:161 Reply

    Done

    Index.rst:172 Reply

    Done

    Index.rst:175 Reply

    Done
  16. core-ci voted on patch set 6 V +1 09/19/24, 19:02 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/66243

  17. Chris Müller voted on patch set 6 CR +1 09/20/24, 07:10

  18. Garvin Hicking commented on patch set 6 09/20/24, 07:23

    what about a 12.4 backport?
  19. Chris Müller commented on patch set 6 CR 0 V -1 09/20/24, 07:25

    Index.rst:421 Unresolved

    The double backticks are not interpreted in the table cell, instead they are displayed unhandled.
  20. Chris Müller commented on patch set 6 09/20/24, 07:26

    I also suggest to stick to one scope and not to mix things up (like changing to table). Then the patchset can get in quicker.
  21. Garvin Hicking rebased onto patch set 7 V +1 02/20/25, 08:13

    The following files contain Git conflicts: * typo3/sysext/form/Documentation/I/Concepts/Configuration/Index.rst
  22. Garvin Hicking commented on patch set 7 02/20/25, 08:14

    @froemken@gmail.com Would you be interested in picking this up to get it to the finish line? We could either try to brush this one up here, or as Chris suggested first do a round of formatting and merge this, and as a follow-up do the smaller code changes?
  23. core-ci voted on patch set 7 V +1 02/20/25, 08:21 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/74444

  24. Chris Müller wrote 02/20/25, 16:48

    Removed reviewer Chris Müller.
  25. Stefan Froemken abandoned the change 02/25/25, 21:08

    Nice. Lolli has created his own patch and solved my issue in one go.