.. include:: /Includes.rst.txt
.. _typo3-fluid-link-page:
=========
link.page
=========
A ViewHelper for creating links to TYPO3 pages.
Examples
========
Link to the current page
------------------------
::
page link
Output::
page link
Depending on current page, routing and page path configuration.
Query parameters
----------------
::
page link
Output::
page link
Depending on current page, routing and page path configuration.
Query parameters for extensions
-------------------------------
::
page link
Output::
page link
Depending on current page, routing and page path configuration.
Arguments
=========
.. _link.page_additionalattributes:
additionalAttributes
--------------------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
Additional tag attributes. They will be added directly to the resulting HTML tag.
.. _link.page_data:
data
----
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
Additional data-* attributes. They will each be added with a "data-" prefix.
.. _link.page_class:
class
-----
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
CSS class(es) for this element
.. _link.page_dir:
dir
---
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)
.. _link.page_id:
id
--
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
Unique (in this file) identifier for this HTML element.
.. _link.page_lang:
lang
----
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
Language for this element. Use short names specified in RFC 1766
.. _link.page_style:
style
-----
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
Individual CSS styles for this element
.. _link.page_title:
title
-----
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
Tooltip text of element
.. _link.page_accesskey:
accesskey
---------
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
Keyboard shortcut to access this element
.. _link.page_tabindex:
tabindex
--------
:aspect:`DataType`
integer
:aspect:`Required`
false
:aspect:`Description`
Specifies the tab order of this element
.. _link.page_onclick:
onclick
-------
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
JavaScript evaluated for the onclick event
.. _link.page_target:
target
------
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
Target of link
.. _link.page_rel:
rel
---
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
Specifies the relationship between the current document and the linked document
.. _link.page_pageuid:
pageUid
-------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
Target page. See TypoLink destination
.. _link.page_pagetype:
pageType
--------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
Type of the target page. See typolink.parameter
.. _link.page_nocache:
noCache
-------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
Set this to disable caching for the target page. You should not need this.
.. _link.page_nocachehash:
noCacheHash
-----------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
Set this to suppress the cHash query parameter created by TypoLink. You should not need this.
.. _link.page_section:
section
-------
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
The anchor to be added to the URI
.. _link.page_linkaccessrestrictedpages:
linkAccessRestrictedPages
-------------------------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed.
.. _link.page_additionalparams:
additionalParams
----------------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
Additional query parameters that won't be prefixed like $arguments (overrule $arguments)
.. _link.page_absolute:
absolute
--------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
If set, the URI of the rendered link is absolute
.. _link.page_addquerystring:
addQueryString
--------------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
If set, the current query parameters will be kept in the URI
.. _link.page_argumentstobeexcludedfromquerystring:
argumentsToBeExcludedFromQueryString
------------------------------------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
Arguments to be removed from the URI. Only active if $addQueryString = TRUE
.. _link.page_addquerystringmethod:
addQueryStringMethod
--------------------
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
Set which parameters will be kept. Only active if $addQueryString = TRUE