Review main Merged

84183[DOCS] Add sprintf() reference to f:translate ViewHelper documentation

Garvin Hicking CR +2 V +2 Easy +12 −4 updated 05/09/24, 08:35

Commit message

The ViewHelper documentation for f:translate mentioned
sprintf() from PHP, but did not link to it.

This patch adds a link and also optimizes markup, plus a few more
sprintf() examples with ordered parameters and number formatting.

See forge issue for screenshots how this looks before and
after the change.

Review

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

Issues 1

Files 1

Review log 912

  1. Garvin Hicking uploaded patch set 1 05/08/24, 20:42

  2. core-ci voted on patch set 1 V +1 05/08/24, 20:47 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/57417

  3. Lina Wolf commented on patch set 1 05/09/24, 06:34

    We need to use Markdown, not rst here

    TranslateViewHelper.php:93

    We cannot use rst syntax here, but must use Markdown. The Markdown is then transfered into rst in https://github.com/TYPO3-Documentation/fluid-documentation-generator
  4. Garvin Hicking uploaded patch set 2 V +1 05/09/24, 07:30

    Adjust link
  5. Garvin Hicking commented on patch set 2 05/09/24, 07:35

    Reply

    The other Viewhelpers utilize :php: and :html: as well and get properly rendered/interpreted, so I think this usage is inline with that and should not deviate.

    TranslateViewHelper.php:93 Reply

    I adjusted my use of the link syntax to be in line with other ViewHelpers (f:security.IfHasRole, f:format:html) so it should be treated like the others. We talked about this on Slack - if this format should be converted from RST to Markdown in the ViewHelpers, we should do that in a seperate patch/issue. For now we'll keep it in line.
  6. core-ci voted on patch set 2 V +1 05/09/24, 07:36 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/57439

  7. Lina Wolf voted on patch set 2 CR +1 V +1 05/09/24, 07:41

  8. Markus Klein updated the commit message in patch set 3 CR +1 V +1 05/09/24, 08:30

  9. Markus Klein voted on patch set 3 CR +1 V +1 05/09/24, 08:31

  10. Lina Wolf voted on patch set 3 CR +2 V +2 05/09/24, 08:35

  11. core-ci voted on patch set 3 V +1 05/09/24, 08:35 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/57440

  12. Lina Wolf merged patch set 4 05/09/24, 08:35