DocumentationViewHelper extends AbstractTagBasedViewHelper
This class is the implementation of a Fluid ViewHelper.
View this class in the TYPO3 ViewHelper reference: <backend:link.documentation>
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-bar 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::
See documentationnot part of TYPO3 Core API.
Table of Contents
Properties
- $tagName : mixed
- $urlPattern : string
Methods
- initializeArguments() : void
- render() : string
Properties
$tagName
protected
mixed
$tagName
= 'a'
$urlPattern
protected
string
$urlPattern
= 'https://docs.typo3.org/permalink/%s@%s'
Methods
initializeArguments()
public
initializeArguments() : void
render()
public
render() : string