"Label" and "Extract" fields

The Label field is used to specify the input component that is to be used for the title of the teaser.

The Extract field is used to specify the input component that is to be used for the text extract of the teaser.

If these fields are left empty, the name of the object and the path are displayed as standard; for datasets, the name of the data source and ID of the dataset are displayed, separated by a # symbol, e.g.,“Press releases: #128”

Snippet definition

The snippet definition is generally created via the entry of a variable name for an input component defined in the template.

In order to be able to handle the returned object, methods that can be used with $CMS_VALUE(...)$ can be implemented. The usable methods are dependent on the returned object type. This means that the individual list entries are usually output using the map(String) method (for more information, see the List data type, for example).

Example
of the output of content from an input component of type CMS_INPUT_DOM:

IDENTIFIER.toText(false)

There, IDENTIFIER is the variable name for an input component of CMS_INPUT_DOM type.

Combination

The content of multiple input components can be linked using a plus sign (+).

Static text

Furthermore, static text can be specified between quotation marks (" "). When combining multiple outputs using a plus sign, a separator should be provided (e.g., a blank space: " "). See below for examples.

Examples by component

The following table lists examples of output options for some input components:

Shortening and formatting

By default, if nothing else is specified, all of the content in the “Label” and “Extract” fields is output from the specified input component. Therefore, we recommend, if possible, limiting the number of characters for text input components (e.g., using maxInputLength or maxCharacters; see, for example, CMS_INPUT_TEXT).

Alternatively, the truncate parameter can be used to specify how many characters are to be displayed. If the text saved in the input component has more characters than those specified by truncate, three periods (...) are appended to the output.

truncate(IDENTIFIER, 25)

This specification shortens the text output of the input component with the identifier IDENTIFIER to 25 characters.

Text can be output in bold or italics using the bold(IDENTIFIER) and italic(IDENTIFIER) parameters. The bold parameter has no effect in the “Label” field since the title for output text is generally shown in bold.

Example

italic(truncate(if(!pt_headline.isEmpty, pt_headline), 30) +
    if(!pt_headline.isEmpty && !pt_subheadline.isEmpty, " /  ") +
truncate(if(!pt_subheadline.isEmpty, pt_subheadline), 15))

In this case, the content of the input components pt_headline and pt_subheadline are output in italics (if they are not empty), separated by a slash with spaces:

FirstSpirit Hybrid CMS / Agility enabled by the FirstSpirit Hybrid CMS

Depending on the respective object type, methods can be used to provide additional formatting in addition to these general attributes. The following table lists example formatting options for some input components:

Displays the dataset ID.

In the case of datasets, the dataset ID can also be used for snippet display by entering the

#id

Within the relevant table template, a snippet definition for press releases, including the relevant dataset ID, might look like this:

Label:

"Press release " + italic(#id)

Using labels from (referenced) tables ("label")

If values from a (referenced) table are selectable using CMS_INCLUDE_OPTIONS in CMS_INPUT_COMBOBOX, for instance, the identifier that originated from the (referenced) table can be displayed in the search result using label(#language). (For information on #language / #global.language, refer to this page.)

Form A example

<CMS_INPUT_TEXT name="cs_branch" singleLine="no" useLanguages="no">
    <LANGINFOS>
      <LANGINFO lang="*" label="City"/>
      <LANGINFO lang="DE" label="Stadt"/>
    </LANGINFOS>
</CMS_INPUT_TEXT>

<CMS_INPUT_COMBOBOX name="cs_country_choice" singleLine="no" useLanguages="no">
    <CMS_INCLUDE_OPTIONS type="database">
      <LABELS>
        <LABEL lang="*">#item.Name</LABEL>
      </LABELS>
      <TABLE>country</TABLE>
    </CMS_INCLUDE_OPTIONS>
    <LANGINFOS>
      <LANGINFO lang="*" label="Country"/>
      <LANGINFO lang="DE" label="Land"/>
    </LANGINFOS>
</CMS_INPUT_COMBOBOX>

Where country is a referenced table (see below). City names are saved via cs_branch; a country is selected from the referenced table using the cs_country_choice combo box.

Form B example (country table)

<CMS_INPUT_TEXT name="cs_country" singleLine="no" useLanguages="yes">
     <LANGINFOS>
       <LANGINFO lang="*" label="Country"/>
       <LANGINFO lang="DE" label="Land"/>
     </LANGINFOS>
</CMS_INPUT_TEXT>

Country names are saved under cs_country (Name column).

Snippet example

if(!cs_country_choice.isEmpty, cs_country_choice.label(#language))

With this expression, the text saved in the Name column of Form B for the selected entry is shown as a result when searching for a value that has been selected using the combo box with the identifier cs_country_choice in Form A.

If, for example, the value “Dortmund” is selected for cs_branch in Form A and the value “Germany” is selected via cs_country_choice, the value “Germany” can be displayed as the text excerpt for a search for “Dortmund” instead of the name from data source B.

Outputting of UID, display name or GID via #item

The #item object is available on the “Snippet” tab in the fields “Label” and “Extract”. It returns the respective tree element. Object-specific methods from the interface IDProvider (FirstSpirit Access API, package de.espirit.firstspirit.access.store) can in turn be applied to this.

Note: The #item object is not available in the data type Card.

Outputting UID or display name

#item.getDisplayName(#language)

Outputs the display name of the respective object in the respective language.

#item.Uid 

Outputs the UID of the respective object.

#item.getDisplayName(#language) 
"[UID:" + " " +italic(#item.getUid) + "]" 

Outputting the GID (Datasets)

If the tree element contains further FirstSpirit objects in the form of datasets (e.g. FS_INDEX with a DatasetDataAccessPlugin), the GID (Global ID) of the datasets can be accessed via #item.

The GID of a dataset can be specified using:

#item.getEntity().getGid() 

Outputting the current date via #now

The #now object returns the current date at the time of the query.

"valid " + if(cs_newsdate > #now,"from ","since ") + cs_newsdate.format("MM/dd/yy") 

Compares the current date with the date from an input component CMS_INPUT_DATE.