You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
PHP domain
In order to describe PHP code in TYPO3’s documentation, the Sphinx extension sphinxcontrib-phpdomain is integrated into the rendering process.
That is a bit difficult to understand if one is not familiar with these terms. What is "PHP domain"?
This section is not entirely clear to me at first. I think you can figure this out, but might be helpful to explain it more.
"Linking to PHP entities" - what are PHP entitites? We use that term here, but it is not used or explained above
The title is "linking to", there are links generated but these are not styled as links, so visually it actually looks like inline code. Maybe explain that.
We used to use :php: as inline code roles for classes, methods etc. What is the difference here, why use the new markup and what is the result?
Also add TABs so you have 2 views: code and how it looks
when should :php:any: be used?
In the example, we have both :any: and :php:class: with the same class:
sometimes double \ (esacaped ) are used in the class names, sometimes not - maybe explain where and why (everything you understand, you don't have to memorize)
The text was updated successfully, but these errors were encountered:
About the page in general
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingReST/Phpdomain.html
That is a bit difficult to understand if one is not familiar with these terms. What is "PHP domain"?
About the section "Linking to PHP entities"
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingReST/Phpdomain.html#linking-to-php-entities
This section is not entirely clear to me at first. I think you can figure this out, but might be helpful to explain it more.
:php:
as inline code roles for classes, methods etc. What is the difference here, why use the new markup and what is the result?:php:any:
be used?In the example, we have both
:any:
and:php:class:
with the same class:That might be confusing
The text was updated successfully, but these errors were encountered: