TSref/typolink

-

-

-

The [SYS][encryptionKey] is included in the hash in order to make it unique for the server and non-predictable.

-

Example:

'&print=1'

'&sword_list[]=word1&sword_list[]=word2'

Applications:

This is very useful when linking to pages from a searchresult. The searchwords are stored in the register-key SWORD_PARAMS and can be insert directly like this:

.additionalParams.data = register:SWORD_PARAMS

NOTE: This is only active for internal links!

-

.method: If set to to GET or POST then then the parsed query arguments (GET or POST data) will be used. This settings are useful if you use URL processing extensions like Real URL, which translate part of the path into query arguments.

.exclude: List of query arguments to exclude from the link (eg L or cHash).

-

-

-

The input is parsed like this:

First the parameter is splitted by character-space. This provides a way to pass more parameters. See "target" below here.

If a "@" is in the string, it's an email

If a period (.) is in the string AND if the period (.) is found before a slash (/) is found OR if a doubleslash is found, then it's a URL

If a slash (/) is found, it's a filereference. If the file/directory does not exist on the server, the link is NOT made!

Now the input can be an alias or page-id. If the input is an integer it's a page-id, if it's two comma separated integers, it's a id/type pair, else it's an alias. For page-id's or aliases you can prepend a "#" mark with a number indication tt_content record number on the page to jump to! (if .section-property is present, it overrides this).

If you insert only "#234" where "234" is the tt_content record number, it links to the current page-id

Target

Target is normally defined by the "extTarget" and "target" properties of typolink. But you may override this target by adding the new target after the parameter separated by a whitespace. Thus the target becomes the second parameter.

If the “Target” parameter is set to the “-” character, then it's the same as no target passed to the function. This feature enables you to still pass a class as third parameter and title as fourth parameter without setting the target also.

Open in windows with fixed dimensions (JavaScript)

It is possible to open the link in a window opened by JavaScript (with “window.open”). For this, just set the target value to “123x456” where 123 is the window width and 456 is the window height. You can also specify additional parameters to the function by entering them separated from the width and height with a colon “:”. For instance “230x450:resizable=0,location=1” will disable resizing of the window and enable the location bar.

Also see property “JSwindow”.

Class

If you specify a third parameter separated by whitespace in the parameter value this becomes the class-parameter of the link. This class parameter is inserted in the link-tag before any values from .ATagParams which means this class value will override any class value set in ATagParams (at least for MSIE). If set to “-”, then it's the same as no class passed to the function. This feature enables you to still pass a title as fourth parameter without setting the class also.

Title

The title attribute is normally specified via .ATagParams or directly via the .title property. But you may override this value by adding the desired title as the fourth parameter (parameters separated by whitespace) to typolink.

Examples of multiparameters:

Consider this .parameter value passed to this function:

51 _blank blueLink

This would result in a link approx like this:

<A href=”?id=51” target=”_blank” class=”blueLink”>

</nowiki>

-

-

Preset values for opening the window. This example lists almost all possible attributes:

status=1,menubar=1,scrollbars=1,resizable=1,location=1,directories=1,toolbar=1

-

If set to "url" then it will return the URL of the link ($this->lastTypoLinkUrl)

If set to "target" it will return the target of the link.

So, in these two cases you will not get the value wrapped but the url or target value returned!

-

This is used create a link, which jumps from one page directly the section on another page.

-

Additional parameters

Example:

class=”board”

-

This passes the link-data compiled by the typolink function to a user-defined function for final manipulation. The $content variable passed to the user-function (first parameter) is an array with the keys “TYPE”, “TAG”, “url”, “targetParams” and “aTagParams”. TYPE is an indication of link-kind: mailto, url, file, page TAG is the full <A>-tag as generated and ready from the typolink function. The latter three is combined into the 'TAG' value after this formula: <A HREF="'.$finalTagParts["url"].'"'.$finalTagParts["targetParams"].$finalTagParts["aTagParams"].'> The userfunction must return an <A>-tag.

-