Generic link editors

From FirstSpirit Version 4.2, the configuration options of link templates are substantially enhanced by the introduction of so-called "generic link editors". The configuration is now, analogous to page and section templates, created with the help of input components in the form area. All input options for the maintenance of links can be displayed using FirstSpirit's normal form syntax.

The input screen forms of the conventional "static" link editors can also be generated via the new, generic editors. Slight differences can arise in the display and user prompting of the input screens, but the function is retained:

Configuration and use

The separation between definition (form) and output is removed for generic link editors. In order to create a new link template, it is now only necessary for a link configuration (below the "Link Templates" root node or below a folder) to be created and selected as link type "genericLink".

To convert existing link templates into generic link editors, the "Convert link template" option must be selected in the context menu (Extras) of an existing link configuration. The static input fields to date in the form area are then replaced by the new input components. Following automatic migration, it may be necessary to make project-specific manual adjustments to the layout.

The changeover to generic link editors changes the internal data structure of DOM elements. This can potentially lead to problems in existing scripts. The scripts must be adjusted manually, if necessary.

The migration of the link editors must be fully completed in FirstSpirit Version 4.2. Otherwise the projects cannot be migrated to FirstSpirit Version 5.0.

The generic link editors have the following tabs:

• Properties
• Form
• Output channels

Use of generic link editors in input components is analogous to use of the static link editors.

"Properties" tab

This tab can be used to make general settings which are to be valid for the corresponding link template:

• Unique name: Unique name of the link template, under which it is filed in the file system.
• Form: The "Default Values" button can be used to define default values for the input components of the link template, in a pop-up dialog or in the integrated preview, depending on the View configuration.
• Hide in selection list: If this option is selected, when a new link is created in the Page Store, this link template does not appear in the selection list.
• Link text: This Combobox can be used to select the input component whose content is to be used for the link text ("text" field in static link editors). Here, all identifiers of the input components of the type CMS_INPUT_TEXT and CMS_INPUT_NUMBER defined on the "Form" tab are displayed. The text, which is inserted into the input component with the selected identifier, will be used as link text (see figure, opens in this frame). If no appropriate input component is defined, the selection remains empty ("<not assigned>"). If "<not assigned>" is selected, no link text will be displayed.
• Link picture: This Combobox can be used to select the input component whose content is to be used as link picture (media object from the Media Store) e.g. in the DOM-Editor or in the DOM-Table ("mediaref" field in static link editors). Here, all identifiers of the input components of the type CMS_INPUT_PICTURE and FS_REFERENCE defined on the "Form" tab are displayed. The picture which will be selected via the input component selected by the identifier will be used as link picture (see figure, opens in this frame). If no appropriate input component is defined, the selection remains empty ("<not assigned>"). If "<not assigned>" is selected, no link picture will be used.
• External URL: For Generic links which are used for inserting external links this Combobox can be used to select the input component which contains the external link (URL). Here, all identifiers of the input components of the type CMS_INPUT_TEXT and CMS_INPUT_NUMBER defined on the "Form" tab are displayed. The reference graph e.g. of pages or sections, containing a DOM Editor or a DOM Table with this external Generic link will display a dependency to the URL, inserted in the selected input component (see figure, opens in this frame). If no appropriate input component is defined, the selection remains empty ("<not assigned>"). If "<not assigned>" is selected, no dependency to the external URL will be displayed.
• Category: This Combobox can be used to select a category for external references. As a default, "url" and "email" are available. If necessary, an individual category can also be given. To this end, a corresponding identifier must be entered in the field. The categorisation is used, e.g. to search for external references ("Extras" menu). External references with the respective category are displayed here.

"Form" tab

All input components which can also be used for page, section and table templates can be used on the "Form" tab

Example of an internal reference:

<CMS_MODULE>

  <FS_REFERENCE name="sitestoreref" hFill="yes" useLanguages="no">
    <FILTER>
      <ALLOW type="pageref"/>
      <ALLOW type="documentgroup"/>
    </FILTER>
    <LANGINFOS>
      <LANGINFO lang="*" label="Target"/>
      <LANGINFO lang="DE" label="Ziel"/>
    </LANGINFOS>
    <PROJECTS>
      <LOCAL name=".">
        <SOURCES>
          <FOLDER name="root" store="sitestore"/>
        </SOURCES>
      </LOCAL>
    </PROJECTS>
  </FS_REFERENCE>

  <CMS_INPUT_TEXT name="text" hFill="yes" useLanguages="no">
    <LANGINFOS>
      <LANGINFO lang="*" label="Link text"/>
      <LANGINFO lang="DE" label="Verweis-Text"/>    
    </LANGINFOS>
  </CMS_INPUT_TEXT>

  <CMS_INPUT_TEXT name="comment" hFill="yes" hidden="yes" useLanguages="no">
    <LANGINFOS>
      <LANGINFO lang="*" label="Comment"/>
      <LANGINFO lang="DE" label="Kommentar"/>
    </LANGINFOS>
  </CMS_INPUT_TEXT>

  <FS_REFERENCE name="mediaref" hFill="yes" hidden="no" imagePreview="yes" useLanguages="no">
    <FILTER>
      <ALLOW type="picture"/>
      <ALLOW type="file"/>
    </FILTER>
    <LANGINFOS>
      <LANGINFO lang="*" label="Image"/>
      <LANGINFO lang="DE" label="Bild"/>
    </LANGINFOS>
    <PROJECTS>
      <LOCAL name=".">
        <SOURCES>
          <FOLDER name="root" store="mediastore"/>
        </SOURCES>
      </LOCAL>
    </PROJECTS>
  </FS_REFERENCE>

  <CMS_INPUT_TEXT name="target" hFill="yes" hidden="yes" useLanguages="no">
    <LANGINFOS>
      <LANGINFO lang="*" label="Frame"/>
      <LANGINFO lang="DE" label="Frame"/>
    </LANGINFOS>
  </CMS_INPUT_TEXT>

 </CMS_MODULE>

Output channels tab

For information on the output of links in the respective output channel, please refer to the respective input components. In addition, they can also be output like static link editors.