.. _Neos ViewHelper Reference: Neos ViewHelper Reference ========================= This reference was automatically generated from code on 2014-09-02 neos:backend.configurationCacheVersion -------------------------------------- ViewHelper for rendering the current version identifier for the configuration cache. :Implementation: TYPO3\\Neos\\ViewHelpers\\Backend\\ConfigurationCacheVersionViewHelper neos:backend.container ---------------------- ViewHelper for the backend 'container'. Renders the required HTML to integrate the Neos backend into a website. :Implementation: TYPO3\\Neos\\ViewHelpers\\Backend\\ContainerViewHelper Arguments ********* * ``node`` (TYPO3\TYPO3CR\Domain\Model\NodeInterface): neos:backend.javascriptConfiguration ------------------------------------ ViewHelper for the backend JavaScript configuration. Renders the required JS snippet to configure the Neos backend. :Implementation: TYPO3\\Neos\\ViewHelpers\\Backend\\JavascriptConfigurationViewHelper neos:backend.shouldLoadMinifiedJavascript ----------------------------------------- Returns TRUE if the minified Neos JavaScript sources should be loaded, FALSE otherwise. :Implementation: TYPO3\\Neos\\ViewHelpers\\Backend\\ShouldLoadMinifiedJavascriptViewHelper neos:contentElement ------------------- View helper to wrap nodes for editing in the backend **Deprecated!** This ViewHelper is no longer needed as wrapping is now done with a TypoScript processor. :Implementation: TYPO3\\Neos\\ViewHelpers\\ContentElementViewHelper Arguments ********* * ``additionalAttributes`` (array, *optional*): Additional tag attributes. They will be added directly to the resulting HTML tag. * ``data`` (array, *optional*): Additional data-* attributes. They will each be added with a "data-" prefix. * ``node`` (TYPO3\TYPO3CR\Domain\Model\NodeInterface): * ``page`` (boolean, *optional*): * ``tag`` (string, *optional*): * ``class`` (string, *optional*): CSS class(es) for this element * ``dir`` (string, *optional*): Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) * ``id`` (string, *optional*): Unique (in this file) identifier for this HTML element. * ``lang`` (string, *optional*): Language for this element. Use short names specified in RFC 1766 * ``style`` (string, *optional*): Individual CSS styles for this element * ``title`` (string, *optional*): Tooltip text of element * ``accesskey`` (string, *optional*): Keyboard shortcut to access this element * ``tabindex`` (integer, *optional*): Specifies the tab order of this element * ``onclick`` (string, *optional*): JavaScript evaluated for the onclick event neos:contentElement.editable ---------------------------- Renders a wrapper around the inner contents of the tag to enable frontend editing. The wrapper contains the property name which should be made editable, and is by default a "div" tag. The tag to use can be given as `tag` argument to the ViewHelper. In live workspace this just renders a tag with the specified $tag-name containing the value of the given $property. For logged in users with access to the Backend this also adds required attributes for the RTE to work. Note: when passing a node you have to make sure a metadata wrapper is used around this that matches the given node (see contentElement.wrap - i.e. the WrapViewHelper). :Implementation: TYPO3\\Neos\\ViewHelpers\\ContentElement\\EditableViewHelper Arguments ********* * ``additionalAttributes`` (array, *optional*): Additional tag attributes. They will be added directly to the resulting HTML tag. * ``data`` (array, *optional*): Additional data-* attributes. They will each be added with a "data-" prefix. * ``property`` (string): Name of the property to render. Note: If this tag has child nodes, they overrule this argument! * ``tag`` (string, *optional*): The name of the tag that should be wrapped around the property. By default this is a
* ``node`` (TYPO3\TYPO3CR\Domain\Model\NodeInterface, *optional*): The node of the content element. Optional, will be resolved from the TypoScript context by default. * ``class`` (string, *optional*): CSS class(es) for this element * ``dir`` (string, *optional*): Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) * ``id`` (string, *optional*): Unique (in this file) identifier for this HTML element. * ``lang`` (string, *optional*): Language for this element. Use short names specified in RFC 1766 * ``style`` (string, *optional*): Individual CSS styles for this element * ``title`` (string, *optional*): Tooltip text of element * ``accesskey`` (string, *optional*): Keyboard shortcut to access this element * ``tabindex`` (integer, *optional*): Specifies the tab order of this element * ``onclick`` (string, *optional*): JavaScript evaluated for the onclick event neos:contentElement.wrap ------------------------ A view helper for manually wrapping content editables. Note that using this view helper is usually not necessary as Neos will automatically wrap editables of content elements. By explicitly wrapping template parts with node meta data that is required for the backend to show properties in the inspector, this ViewHelper enables usage of the ``contentElement.editable`` ViewHelper outside of content element templates. This is useful if you want to make properties of a custom document node inline-editable. :Implementation: TYPO3\\Neos\\ViewHelpers\\ContentElement\\WrapViewHelper Arguments ********* * ``node`` (TYPO3\TYPO3CR\Domain\Model\NodeInterface, *optional*): The node of the content element. Optional, will be resolved from the TypoScript context by default. neos:includeJavaScript ---------------------- A View Helper to include JavaScript files inside Resources/Public/JavaScript of the package. :Implementation: TYPO3\\Neos\\ViewHelpers\\IncludeJavaScriptViewHelper Arguments ********* * ``include`` (string): Regular expression of files to include * ``exclude`` (string, *optional*): Regular expression of files to exclude * ``package`` (string, *optional*): The package key of the resources to include or current controller package if NULL * ``subpackage`` (string, *optional*): The subpackage key of the resources to include or current controller subpackage if NULL * ``directory`` (string, *optional*): The directory inside the current subpackage. By default, the "JavaScript" directory will be used. neos:link.module ---------------- A view helper for creating links to modules. :Implementation: TYPO3\\Neos\\ViewHelpers\\Link\\ModuleViewHelper Arguments ********* * ``additionalAttributes`` (array, *optional*): Additional tag attributes. They will be added directly to the resulting HTML tag. * ``data`` (array, *optional*): Additional data-* attributes. They will each be added with a "data-" prefix. * ``path`` (string): Target module path * ``action`` (string, *optional*): Target module action * ``arguments`` (array, *optional*): Arguments * ``section`` (string, *optional*): The anchor to be added to the URI * ``format`` (string, *optional*): The requested format, e.g. ".html * ``additionalParams`` (array, *optional*): additional query parameters that won't be prefixed like $arguments (overrule $arguments) * ``addQueryString`` (boolean, *optional*): If set, the current query parameters will be kept in the URI * ``argumentsToBeExcludedFromQueryString`` (array, *optional*): arguments to be removed from the URI. Only active if $addQueryString = TRUE * ``class`` (string, *optional*): CSS class(es) for this element * ``dir`` (string, *optional*): Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) * ``id`` (string, *optional*): Unique (in this file) identifier for this HTML element. * ``lang`` (string, *optional*): Language for this element. Use short names specified in RFC 1766 * ``style`` (string, *optional*): Individual CSS styles for this element * ``title`` (string, *optional*): Tooltip text of element * ``accesskey`` (string, *optional*): Keyboard shortcut to access this element * ``tabindex`` (integer, *optional*): Specifies the tab order of this element * ``onclick`` (string, *optional*): JavaScript evaluated for the onclick event * ``name`` (string, *optional*): Specifies the name of an anchor * ``rel`` (string, *optional*): Specifies the relationship between the current document and the linked document * ``rev`` (string, *optional*): Specifies the relationship between the linked document and the current document * ``target`` (string, *optional*): Specifies where to open the linked document Examples ******** **Defaults**:: some link Expected result:: some link neos:link.node -------------- A view helper for creating links with URIs pointing to nodes. The target node can be provided as string or as a Node object; if not specified at all, the generated URI will refer to the current document node inside the TypoScript context. When specifying the ``node`` argument as string, the following conventions apply: *``node`` starts with ``/``:* The given path is an absolute node path and is treated as such. Example: ``/sites/acmecom/home/about/us`` *``node`` does not start with ``/``:* The given path is treated as a path relative to the current node. Examples: given that the current node is ``/sites/acmecom/products/``, ``stapler`` results in ``/sites/acmecom/products/stapler``, ``../about`` results in ``/sites/acmecom/about/`` ``./neos/info`` results in ``/sites/acmecom/products/neos/info`` *``node`` starts with a tilde character (``~``):* The given path is treated as a path relative to the current site node. Example: given that the current node is ``/sites/acmecom/products/``, ``~/about/us`` results in ``/sites/acmecom/about/us``. :Implementation: TYPO3\\Neos\\ViewHelpers\\Link\\NodeViewHelper Arguments ********* * ``additionalAttributes`` (array, *optional*): Additional tag attributes. They will be added directly to the resulting HTML tag. * ``data`` (array, *optional*): Additional data-* attributes. They will each be added with a "data-" prefix. * ``node`` (mixed, *optional*): A TYPO3\TYPO3CR\Domain\Model\NodeInterface object or a string node path * ``format`` (string, *optional*): Format to use for the URL, for example "html" or "json * ``absolute`` (boolean, *optional*): If set, an absolute URI is rendered * ``baseNodeName`` (string, *optional*): The name of the base node inside the TypoScript context to use for the ContentContext or resolving relative paths * ``arguments`` (array, *optional*): Additional arguments to be passed to the UriBuilder (for example pagination parameters) * ``section`` (string, *optional*): The anchor to be added to the URI * ``addQueryString`` (boolean, *optional*): If set, the current query parameters will be kept in the URI * ``argumentsToBeExcludedFromQueryString`` (array, *optional*): arguments to be removed from the URI. Only active if $addQueryString = TRUE * ``class`` (string, *optional*): CSS class(es) for this element * ``dir`` (string, *optional*): Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) * ``id`` (string, *optional*): Unique (in this file) identifier for this HTML element. * ``lang`` (string, *optional*): Language for this element. Use short names specified in RFC 1766 * ``style`` (string, *optional*): Individual CSS styles for this element * ``title`` (string, *optional*): Tooltip text of element * ``accesskey`` (string, *optional*): Keyboard shortcut to access this element * ``tabindex`` (integer, *optional*): Specifies the tab order of this element * ``onclick`` (string, *optional*): JavaScript evaluated for the onclick event * ``name`` (string, *optional*): Specifies the name of an anchor * ``rel`` (string, *optional*): Specifies the relationship between the current document and the linked document * ``rev`` (string, *optional*): Specifies the relationship between the linked document and the current document * ``target`` (string, *optional*): Specifies where to open the linked document Examples ******** **Defaults**:: some link Expected result:: some link (depending on current node, format etc.) **Generating a link with an absolute URI**:: bookmark this page Expected result:: bookmark this page (depending on current workspace, current node, format, host etc.) **Target node given as absolute node path**:: Corporate imprint Expected result:: Corporate imprint (depending on current workspace, current node, format etc.) neos:standaloneView ------------------- A View Helper to render a fluid template based on the given template path and filename. This will just set up a standalone Fluid view and render the template found at the given path and filename. Any arguments passed will be assigned to that template, the rendering result is returned. :Implementation: TYPO3\\Neos\\ViewHelpers\\StandaloneViewViewHelper Arguments ********* * ``templatePathAndFilename`` (string): Path and filename of the template to render * ``arguments`` (array, *optional*): Arguments to assign to the template before rendering Examples ******** **Basic usage**:: Expected result:: Expected result:: neos:uri.node ------------- A view helper for creating URIs pointing to nodes. The target node can be provided as string or as a Node object; if not specified at all, the generated URI will refer to the current document node inside the TypoScript context. When specifying the ``node`` argument as string, the following conventions apply: *``node`` starts with ``/``:* The given path is an absolute node path and is treated as such. Example: ``/sites/acmecom/home/about/us`` *``node`` does not start with ``/``:* The given path is treated as a path relative to the current node. Examples: given that the current node is ``/sites/acmecom/products/``, ``stapler`` results in ``/sites/acmecom/products/stapler``, ``../about`` results in ``/sites/acmecom/about/`` ``./neos/info`` results in ``/sites/acmecom/products/neos/info`` *``node`` starts with a tilde character (``~``):* The given path is treated as a path relative to the current site node. Example: given that the current node is ``/sites/acmecom/products/``, ``~/about/us`` results in ``/sites/acmecom/about/us``. :Implementation: TYPO3\\Neos\\ViewHelpers\\Uri\\NodeViewHelper Arguments ********* * ``node`` (mixed, *optional*): A TYPO3\TYPO3CR\Domain\Model\NodeInterface object or a string node path or NULL to resolve the current document node * ``format`` (string, *optional*): Format to use for the URL, for example "html" or "json * ``absolute`` (boolean, *optional*): If set, an absolute URI is rendered * ``baseNodeName`` (string, *optional*): The name of the base node inside the TypoScript context to use for the ContentContext or resolving relative paths * ``arguments`` (array, *optional*): Additional arguments to be passed to the UriBuilder (for example pagination parameters) * ``section`` (string, *optional*): * ``addQueryString`` (boolean, *optional*): If set, the current query parameters will be kept in the URI * ``argumentsToBeExcludedFromQueryString`` (array, *optional*): arguments to be removed from the URI. Only active if $addQueryString = TRUE Examples ******** **Default**:: Expected result:: homepage/about.html (depending on current workspace, current node, format etc.) **Generating an absolute URI**:: Expected result:: http://www.example.org/homepage/about.html (depending on current workspace, current node, format, host etc.) **Target node given as absolute node path**:: Expected result:: about/us.html (depending on current workspace, current node, format etc.)