TYPO3CMS-Reference-CoreApi icon indicating copy to clipboard operation
TYPO3CMS-Reference-CoreApi copied to clipboard

Extension namens / keys for Exempels in Dokumentation

Open Rathch opened this issue 3 weeks ago • 1 comments

Preferred is to submit a suggestion via pull request: For small changes the "Edit on GitHub" button on the top of every documentation page can be used. You can find more information about contributing to the documentation on the page: https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingDocsOfficial/Index.html

Current behavior

We use news or tea as examples. Therefore, it is not clear how the keys/extension names should be written: my_example, myExample or myexample.

Expected behavior/output

Since the spelling affects the function, examples where this is evident should be used, such as my_example, myExample, or myexample.

Rathch avatar Nov 10 '25 08:11 Rathch

The extension blog_example is actively maintained and is an example how to write things when the key has an underscore.

DavidBruchmann avatar Nov 10 '25 10:11 DavidBruchmann