Link.documentation ViewHelper <be:link.documentation>
Internal
This ViewHelper is marked as internal. It is subject to be changed without notice. Use at your own risk.
Use this ViewHelper to provide a link to the official documentation. The ViewHelper will use the permalink identifier to generate a permalink to the documentation which is a redirect to the actual URI.
The identifier must be given as a string. Be aware that very specific short links into the documentation may change over time.
The link will always lead to the documentation of the corresponding TYPO3 version. This
means in a v12 installation, using foo- as identifier will link to 'foo-bar@12.4',
while in v13 the link will be 'foo-bar@13.4'.
Example
Link to the documentation:
<be:link.documentation identifier="foo-bar">See documentation</be:link.documentation>
Output:
<a href="https://docs.typo3.org/permalink/foo-bar@13.4" target="_blank" rel="noreferrer">
See documentation
</a>Source code
Go to the source code of this ViewHelper: Link\DocumentationViewHelper.php (GitHub).
Arguments
Allows arbitrary arguments
This ViewHelper allows you to pass arbitrary arguments not defined below directly
to the HTML tag created. This includes custom
data- arguments.
The following arguments are available for the link.documentation ViewHelper:
accesskey
-
- Type
- string
Keyboard shortcut to access this element
additionalAttributes
-
- Type
- array
Additional tag attributes. They will be added directly to the resulting HTML tag.
aria
-
- Type
- array
Additional aria-* attributes. They will each be added with a "aria-" prefix.
class
-
- Type
- string
CSS class(es) for this element
data
-
- Type
- array
Additional data-* attributes. They will each be added with a "data-" prefix.
dir
-
- Type
- string
Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)
id
-
- Type
- string
Unique (in this file) identifier for this HTML element.
identifier
-
- Type
- string
- Required
- 1
the documentation permalink identifier as displayed in the modal link popup of any rendered documentation manual
lang
-
- Type
- string
Language for this element. Use short names specified in RFC 1766
onclick
-
- Type
- string
JavaScript evaluated for the onclick event
style
-
- Type
- string
Individual CSS styles for this element
tabindex
-
- Type
- integer
Specifies the tab order of this element
title
-
- Type
- string
Tooltip text of element