Start page / Template development / Link templates / Configuration / for external links

Configuration for external links (externalLink)

"externalLink" screen form example

The diagram on the left-hand side shows an example of an screen form for an external link. In the example all the possible input fields for this type of link are displayed.

If an explicit configuration is not given for an instance of an external link, as a default all components are displayed with their default values.

The template developer can configure each input field project-specifically by giving the "name" attribute in the <CMS_PARAM> tag (cf. Chapter Configuration). The attribute names, through which the respective input fields or selection lists can be influenced are displayed in the diagram in italics. (To enlarge, please click the diagram!)

The following fields can be used for all instances of the standard link type "externalLink", for configuring external links (outside the project):

Special variables (link type: externalLink)

Variable name	Description
ref	The "ref" field is an input component for entering an external URL. The standard behaviour of the input component can be changed using the configuration of the input component, for example by pre-assigning the component for the input of HTML pages with the value "HTTP://": <CMS_PARAM name="ref" value="http://" default="1"/> The selected reference must be resolved in the source text of the link template by means of $CMS_VALUE(#link.ref)$ .
comment	The "comment" field is an input component for entering a comment. The editor can enter any comment text in the input field which can be displayed, for example, as a "tooltip". The standard behaviour of the input component can be changed via the configuration. Example: <CMS_PARAM name="comment" value="Please click here!"/>
text	The "text" field is an input component for entering a link text. Any text can be entered in the field which is to be linked. The standard behaviour of the input component can be changed via the configuration. Example: <CMS_PARAM name="text" label="Link text"/>
linktemplate:	The "linktemplate" field is a selection list for selecting a link template. As a default the selection list contains all link templates of the current instance of the link template type. (Explication: see Introduction to Link Templates) The editor can select the link template to be used for creating the link from the list. The standard behaviour of the input component can be changed via the configuration of the input component. The selection list can be pre-filled by the template developer, for example with any number of valid link template names, by defining several parameters. The unique identifier must be given for the attribute value. <CMS_PARAM name="linktemplate" value="myInternalLink.standardLink1"/> <CMS_PARAM name="linktemplate" value="myInternalLink.standardLink2" default="1" /> <CMS_PARAM name="linktemplate" value="myInternalLink.standardLink3"/> The elements are displayed in the list in the order configured by the template developer.
mediaref	The "mediaref" field is an input component for the selection of a media object to be linked from the project's Media Store. The standard behaviour of the input component can be changed via the configuration of the input component. Example: <CMS_PARAM name="mediaref" value="media:abc" default="1"/> The selected reference must be resolved in the source text of the link template by means of $CMS_REF(#link.mediaref)$ .
target	The "target" field is an input component for selection of a target frame for the link, for example in the current window or in a popup window. The link is opened in the selected target frame. The standard behaviour of the input component can be changed using the configuration of the input component, for example the template developer can pre-assign multiple default values to the list: <CMS_PARAM name="target" value="_top"/> <CMS_PARAM name="target" value="_self" default="1"/> <CMS_PARAM name="target" value="_blank"/> The "value" attribute can be used to make the usual HTML frame identifiers as well as project-specifically defined frames available to choose from.
remotemedia	The "remotemedia" field defines which remote project is available for selection of a media object from the Media Store. The symbolic name of the remote project must be given for the attribute value. <CMS_PARAM name="remotemedia" value="symbNameRemoteproject"/> If the optional attribute value ="showremotemediastore" is given in the configuration of the "mediaref" field: <CMS_PARAM name="mediaref" value="showremotemediastore"/> , apart from the Media Store of the internal project, the Media Store of the remote project is also displayed to the editor. If the optional attribute value ="remoteonly" is given in the configuration of the "mediaref" field: <CMS_PARAM name="mediaref" value="remoteonly"/> the editor is only displayed the Media Store of the remote project.

Print version | Page start