Start page / Template development / Forms / Input components / LIST (new) / Sample project

Example project

On this page you can download an example project which, among other things, illustrates the following topics:

Exemplary configurations and combinations of tags and parameters for the different DATASOURCE types
Application cases for use of FS_LIST, e.g. creating and managing
- media galleries (with images, image descriptions and categorizations),
- simple product databases (with product name, image, description and categorization)
- complex product databases (with multiple categorization)
Migration from CMS_INPUT input components to FS_LIST
Simple output options

Unlike the standard "Mithras Energy" supplied with FirstSpirit, this example project focuses on the function of FS_LIST and related FirstSpirit features. The Content Schemata and templates used in the application cases are kept as simple as possible to enable the relationships between the functions to be more easily highlighted. The HTML output of the project on the other hand is deliberately kept simple.

This example project is currently being developed and can change at any time. It is not claimed to be complete or exhaustive. It can be individually changed and extended to meet your own needs.

You can download the example project from here:
Example project (Version 5.1.1)

To use FS_LIST in the DATASOURCE type SERVICE (section template FormDataProviderExample in the Form definitions folder / type="SERVICE") the "FirstSpirit FormDataProvider Example" module must also be installed on the FirstSpirit server (file name "fs-example_listprovider.fsm"). You can download this here:
"FirstSpirit FormDataProvider Example" module (Version 5.1.407)

Structure and description of the example project

The example project is adequately and realistically filled in all Stores. The new FS_ components were preferentially used for this. Links of the type "genericLink" are also primarily used. For improved comparability, the corresponding types "internalLink", "externalLink" and "contentLink", which are no longer supported in FirstSpirit Version 5.0 and higher, are also included.

The project is multilingual (German and English). "English" was deliberately chosen as the master language, to take into account increasing internationalization. The display and reference names were assigned for all elements in both languages throughout. The tree labeling can therefore be set to the required display via the "View" / "Preferred display language" menu. A uniform schema was chosen for the reference names. Numbering was also used at special points, in order to specify consistent sorting.

Navigation is implemented in the project. This can be disabled or enabled for each page using the "Only content" and "Content and navigation" radio buttons respectively in the Page Store.

The structure of the project is described in the following. The descriptions are based on the templates used. Their use or effect in the Page or Content Store can be easily determined by using "Show usages" ("Extras" context menu) or Ctrl+U.

Form configurations

FS_LIST provides extensive application and configuration options and is very complex due to the large number of tags and parameters that can be used. Exemplary configurations and combinations are presented in the example project, ordered by DATASOURCE types. The corresponding templates are located in the section templates (Template Store), "Form definitions" folder (reference name: "form_definitions"). Example forms for each DATASOURCE type are grouped together in folders.

The name of the section template indicates the type of configuration. It is formed according to the following schema:
Basic description (Aspect) [Parameter]

For example, "CONTENTLIST → FS_LIST (MediaMode)" refers to a configuration of FS_LIST as a replacement for CMS_INPUT_CONTENTLIST (DATASOURCE type DATABASE) with the MEDIAMODE tag (see also Media Galleries). In addition, various layout variants are implemented (e.g. CONTENTLIST → FS_LIST (StackedView) [Selection: PopUp] or CONTENTLIST → FS_LIST (SimpleView) [Alignment: Right]).

Media gallery

A media gallery is implemented in the example project. The table templates on which the gallery and media table are based are located below the "Media Galleries" database schema (Template Store, "Database schemes" node).

The media gallery function can also be used in the Page Store. The section template based variant is used for this: Section template "CONTENTLIST → FS_LIST (MediaMode)" in the Template Store, "Section Templates" node, "Form definitions" folder, "type="DATABASE"" folder.

The workflow, with which media galleries and the selected media can be simultaneously released, is filed under the workflows in the project and is called "Media dependent content release (Content-Store)" (reference name "media_dependent_content_release"). The integrated script required for this ("Media dependent content release (script)") is located in the "Workflows" folder, under the "Scripts" node.

For further information on the creation and use of media galleries, see separate section.

Product database

The product database originally stems from the "Mithras Energy" demo project, but has been reduced to exemplary functions which such a database requires as a minimum. The corresponding database schema and the table templates and queries are located under the "Products" Database Schema (Template Store, "Database Schemes" node).

Complex product database

A complex product database is implemented under the "Attributed relations" node in the Database schemes. Product data can be entered in a central table ("Product" data source), for which information from two other tables, each linked via a 1:N external key relationship, can be accessed. In this way, multiple categorizations can be made.

Migration

FS_LIST can replace the input components

CMS_INPUT_CONTENTAREALIST,
CMS_INPUT_LINKLIST,
CMS_INPUT_SECTIONLIST,
CMS_INPUT_CONTENTLIST and
CMS_INPUT_TABLIST

and is planned to replace these input components from FirstSpirit Version 5.0 and higher. Therefore, it is advisable to replace the CMS_INPUT components with FS_LIST.

In the "Migration" folder under the section node folder in the Template Store there are templates, with which use of these CMS_INPUT input components and the FS_LIST component is compared, each in the default/minimum configuration and other typical configurations. In the Page Store ("Migration" folder) it is possible to switch from each of these CMS_INPUT components to the correspondingly configured FS_LIST component by means of the tabs.

Apart from the comparison of the forms, it is also possible to compare the HTML output: As a default, both the values entered and saved in the FS_LIST and those in the corresponding CMS_INPUT forms are taken into account in the output. Only the values saved in the FS_LIST components can be displayed, by disabling the "Render values of legacy input components" option in the project settings (Global Store).

Print version | Page start