Review 13.4 Merged

89042[DOCS] Unify VH descriptions, move examples to Fluid Reference

Garvin Hicking CR +2 V +2 Nightmare +778 −2208 updated 04/15/25, 19:35

Commit message

This patch performs no code changes.

The phpDoc blocks of each ViewHelper class are updated:

- Streamlined wording, beginning with "ViewHelper which does/formats X"
- Only provide a very basic example, linking to docs.typo3.org for more
- Be more precise in short descriptions
- Use markdown code blocks so that IDEs can better display them
- Use bold "Notes" instead of (not interpreted) ReST
- Remove specific ReST attribution like :html:, :php:, :file: which is
  not rendered in markdown

The idea of this patch is that properly formatted examples will
be maintained in the TYPO3 docs at [1], keeping the code in the
core repository clean and simple. Still, developers are able to
see a very brief usage examples.

Changes in ViewHelper arguments or new features will need to
be brought up to the Documentation team, or a Changelog feature/important
ReST file will trigger the documentation workflow of updating
the documentation about them.

The XSD schema generation of ViewHelpers allows developers to see
argument hinting within their IDE. Tooltips of IDEs like PHPStorm
will present class usage with a clickable "@see" link, directly
leading to the docs (see issue screenshot [2]). Code blocks are
now properly formatted/highlighted.

[1] https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/Index.html
[2] https://forge.typo3.org/attachments/39526

Review

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

Issues 1

Files 105

Show 85 more files

Review log 913

  1. Garvin Hicking commented on patch set 1 04/10/25, 18:10

    Cherry Picked from branch main.
  2. core-ci voted on patch set 1 V +1 04/10/25, 18:17 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/77455

  3. Garvin Hicking rebased onto patch set 2 V +1 04/11/25, 15:43

    The following files contain Git conflicts: * typo3/sysext/redirects/Classes/ViewHelpers/TargetPageIdViewHelper.php
  4. Garvin Hicking commented on patch set 3 04/11/25, 15:43

    Published edit on patch set 2.
  5. Garvin Hicking marked it ready for review 04/11/25, 15:43

  6. core-ci voted on patch set 3 V +1 04/11/25, 16:00 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/77557

  7. core-ci voted on patch set 2 V -1 04/11/25, 16:02 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/77556

  8. Garvin Hicking commented on patch set 3 CR -1 04/11/25, 16:04

    needs to adapt the renamed TargetPageRecordVH from TargetPageIdVH earlier now due to https://review.typo3.org/89045
  9. Garvin Hicking uploaded patch set 4 CR -1 V +1 04/15/25, 18:37

    adapt vh
  10. Garvin Hicking voted on patch set 4 CR +1 V +1 04/15/25, 18:37

  11. core-ci voted on patch set 4 V +1 04/15/25, 18:44 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/77775

  12. Garvin Hicking voted on patch set 4 CR +2 V +2 04/15/25, 19:35

  13. Garvin Hicking merged patch set 5 04/15/25, 19:35