Review main Merged

61104[TASK] Improve ViewHelper documentation

Daniel Siepmann CR +2 V +2 Expert +983 −421 updated 07/01/19, 21:30

Commit message

* Add examples to ViewHelpers that did not have any example yet.
* Add cross references between ViewHelpers where a different ViewHelper
  was mentioned.
* Add full stop to end if sentences.
* Fix indentation within examples.
* Add some syntax like code.
* Fix escaping of PHP classes with namespaces by wrapping them with
  :php:`` text role.
* Use https for urls to php.net.
* Remove '/en/' path from urls to php.net. This ensures the current user
  language is auto detected. Not forcing anyone to keep english.

Review

  • Code review CR +2 Done
    • Tymoteusz Motylewski +2
    • Daniel Goerz +1
  • Verified V +2 Done
    • Tymoteusz Motylewski +2
    • Daniel Goerz +1
    • TYPO3com +1 CI

Files 81

Show 61 more files

Review log 2028

Show 23 earlier messages
  1. Daniel Siepmann uploaded patch set 1 06/21/19, 07:44

  2. Daniel Siepmann marked it work in progress 06/21/19, 07:44

  3. TYPO3com voted on patch set 1 V -1 06/21/19, 07:44 Completed build in 11s on Fri, 21 Jun, 09:44 AM Test Summary: No tests found Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-34471

  1. Daniel Siepmann uploaded patch set 2 06/21/19, 09:43

  2. TYPO3com voted on patch set 2 V -1 06/21/19, 09:43 Completed build in 18s on Fri, 21 Jun, 11:43 AM Test Summary: No tests found Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-34472

  3. Daniel Siepmann uploaded patch set 3 06/21/19, 13:34

  4. TYPO3com voted on patch set 3 V -1 06/21/19, 13:35 Completed build in 28s on Fri, 21 Jun, 03:35 PM Test Summary: No tests found Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-34485

  5. Daniel Siepmann uploaded patch set 4 06/21/19, 13:57

  6. TYPO3com voted on patch set 4 V -1 06/21/19, 13:57 Completed build in 15s on Fri, 21 Jun, 03:57 PM Test Summary: No tests found Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-34487

  7. Daniel Siepmann commented on patch set 4 06/21/19, 13:58

    This change is ready for review.
  8. Daniel Siepmann uploaded patch set 5 06/21/19, 14:02

  9. TYPO3com voted on patch set 5 V +1 06/21/19, 14:13 Completed build in 10m 30s on Fri, 21 Jun, 04:13 PM Test Summary: 46478 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-34488

  10. Tom Warwick voted on patch set 5 V +1 06/21/19, 14:19

  11. Daniel Siepmann uploaded patch set 6 06/21/19, 14:54

  12. TYPO3com voted on patch set 6 V +1 06/21/19, 15:05 Completed build in 10m 45s on Fri, 21 Jun, 05:05 PM Test Summary: 46478 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-34492

  13. Tymoteusz Motylewski voted on patch set 6 CR +1 06/29/19, 18:14

  14. Simon Gilli commented on patch set 6 06/30/19, 12:07

    Great Daniel, thank you! Found 2 minor things, have a look at my comments

    UrlencodeViewHelper.php:23

    Shouldn't that be https too?

    TranslateViewHelper.php:78

  15. Simon Gilli voted on patch set 6 CR +1 06/30/19, 12:08

  16. Daniel Goerz commented on patch set 6 07/01/19, 08:21

    MenuViewHelper.php:31

    This sentence is messed up

    PaginateViewHelper.php:24

    with required arguments only

    CObjectViewHelper.php:60

    This should also contain an example how to use the data in the TypoScript Object

    TranslateViewHelper.php:78 Reply

    I dont think this adds any value to the documentation. I would just remove this note.
  17. Tymoteusz Motylewski commented on patch set 6 CR 0 07/01/19, 08:31

    TranslateViewHelper.php:78 Reply

    I would remove the sentence completely. As this code is TYPO3 CMS only.
  18. Daniel Goerz commented on patch set 7 07/01/19, 18:33

    Published edit on patch set 6.
  19. TYPO3com voted on patch set 7 V -1 07/01/19, 18:33 Completed build in 13s on Mon, 1 Jul, 08:33 PM Test Summary: No tests found Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-34699

  20. Daniel Goerz commented on patch set 7 07/01/19, 18:35

    MenuViewHelper.php:31 Reply

    Done

    PaginateViewHelper.php:24 Reply

    Done

    CObjectViewHelper.php:60 Reply

    Done

    UrlencodeViewHelper.php:23 Reply Unresolved

    The URL does not work with SSL

    TranslateViewHelper.php:78 Reply

    Done
  21. Daniel Goerz commented on patch set 8 07/01/19, 18:35

    Published edit on patch set 7.
  22. TYPO3com voted on patch set 8 V +1 07/01/19, 18:47 Completed build in 11m 21s on Mon, 1 Jul, 08:47 PM Test Summary: 46836 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-34700

  23. Daniel Goerz voted on patch set 8 V +1 CR +1 07/01/19, 18:48

  24. Tymoteusz Motylewski voted on patch set 8 V +2 CR +2 07/01/19, 21:30

  25. Tymoteusz Motylewski merged patch set 9 07/01/19, 21:30