Start page
Start page
Start page

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

Configuration for links to a data record (contentLink) Available up to FirstSpirit Version 5.0

"contentLink" (1) screen form example

The two diagrams on the left-hand side show an example of a screen form for a link to a data record.

The screen form is divided into two tabs:

  1. The first tab, labelled with "Content link" in the diagram, is structured analogous to the internal link
    (cf. Figure: "contentLink" (1) screen form example).
  2. The second tab is used for data search within the Content and Site Store
    (cf. Figure: "contentLink" (2) screen form example).

"contentLink" (2) screen form example

The two diagrams show all the possible input fields for this type of link.

If an explicit configuration is not given for an instance of a data 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 variables an be used for all instances of the standard "contentLink" link type for configuring links to a data record (from the Content Store).

Special "data link" (content) variables (link type: contentLink)

Field name

Description

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"/>

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!"/>

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.

language

The "language" field is an input component for selecting a language for the link. As a default, all the project's languages are displayed in the selection list.
The standard behaviour of the input component can be changed using the configuration of the input component, for example the template developer can preselect a language:
<CMS_PARAM name="language" value="DE" default="1"/>


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.

   

Special "data search" variables (link type: contentLink)

Field name

Description

contentSource

The contentSource field is a selection list for selecting a data source from the project's Content Store.

For this purpose the value of the parameter value must be set to the reference name of the data source of the Content Store. In addition, the parameter default must be set to 1:

<CMS_PARAM name="contentSource" value="REFERENCENAME" default="1" />

Important: The parameter contentSource does not control the selection set of the data sources, i.e. the editor can still select from all data sources. The parameter contentSources is used for restraining the selection set.

contentSources

The parameter contentSources restricts the selection set of the data sources, i.e. only the data sources defined here can be selected in the field contentSource in the selection dialog.

One <CMS_PARAM>-Tag corresponds to an admitted data source:
<CMS_PARAM name="contentSources" value="REFERENCENAME1" />
<CMS_PARAM name="contentSources" value="REFERENCENAME2" />
<CMS_PARAM name="contentSources" value="REFERENCENAME3" />

The reference name of the data source from the Content Store must be given as value for the parameter value.

Important: The parameter default and hidden are not available for contentSources because the value of contentSources is not stored in a link.

contentID

Click the anchor symbol to open a window with the table view of the selected data source (content).

sitestoreref

The anchor symbol can be used to select a page or folder from the Site Store to be used as the starting point for the search for the given data record.

sectiontemplate

One table in a schema of the Template Store can be represented by more than one table template.
If the field contentSource a data source has been selected or pre-filled all table templates are displayed in the field sectiontemplate which represent the same table.

   

© 2005 - 2012 e-Spirit AG | All rights reserved. | Last change: 15.12.2010