.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../../Includes.txt

Link
^^^^

Link relies upon TextShort (so the form element is an input box) but the output, of couse, is a hyperlink.

**Keep in mind** that you also have *sWrap* as always available to completely surround your link.

sLink
-----

String. This is how the link itself is created. You have two types of markers you may use here:

==========================  =====================
Marker                      Translation
==========================  =====================
###                         original database-value of this column/field
###config:dbal/sTable###    configuration value with the path given; allows you to re-use param-driven configuration values
==========================  =====================

Example: ::

    ?id=###

Example 2: ::

    ?id=###&tx_mhomsqlio_pi1[table]=###config:dbal/sTable###

bUseTypolinkFunction
--------------------

Boolean. If set, TYPO3's link function is used (recommended).

bTypolinkIncludeCHash
---------------------

Boolean. Only works if bUseTypolinkFunction is set. If true, a cHash value will be included.

aTypolinkAdditionalParams
-------------------------

Array. Only works if bUseTypolinkFunction is set. Holds additional params you want to set as key-value pairs.

Example: ::

    'aTypolinkAdditionalParams' => array(
        'foo' => 'bar',
        'no_cache' => 1,
        'type' => 99
    )

sShow
-----

String. What to display (as the link). Translated to HTML this is what is between the <a ...> and </a> tags. Might hold single *###* marker that gets translated to the original database value of this column/field.

Example: ::

    Show ###

sTarget
-------

String. Target of the link. For new window, use *_blank*.

sTitle
------

String. Title to show on mouse-over. Use single *###* marker to include current original database value.

Example: ::

    Open page ### in new window