CMS_INPUT_DOM

CMS_INPUT_DOM

The CMS_INPUT_DOM input component is provided for larger formatted text inputs. Formatting can be defined both for highlighted text fragments and for whole sections. In addition, this input component provides the possibility of inserting references in the text via the screen forms of the CMS_INPUT_LINK component.

Apart from the standard formatting (bold, italic, underline), project-specific formatting can also be defined (see Format templates).

In addition, any nested lists can be generated in the input component. The type of list (listing with bullet points or numbering) can be freely selected by the editor.

Access-API example use case
The exemplary implementation DomEditorValueExample shows some simple examples of use for the reading, writing and creating access to the data object (DomEditorValue) and its inner data container (DomElement) of the input component by means of the FirstSpirit Access-API.

• Example of use: DomEditorValueExample
• Data object: DomEditorValue
• Container type: DomElement

The input component CMS_INPUT_DOM is supported by the WebClient. For restrictions see chapter Restrictions in WebEdit.

Parameter

The following table gives the parameters of the DOM input component.

Overview

name

The attribute "name" is the variable name of an input component with which the the result object of the input component can be used in the templates - with the help of $CMS_VALUE()$ - or the content can be output.

Overview

allowEmpty

The "allowEmpty" parameter is used to specify whether a value has to be entered for an input value or not.

If allowEmpty="YES" input is not mandatory; however, it is if allowEmpty="NO".

Input components with allowEmpty="NO" are also called mandatory input components.

The default value for allowEmpty is YES.

Overview

bold

The bold parameter can be used to overlay or hide the Bold button in the input component.

If the parameter is not given the button is overlaid as a default.

If NO (...bold="NO"...) is specified the button is hidden and if YES is given it is overlaid.

Overview

develop

Enable debug mode using Java-Console for output.

Overview

enableImport

The parameter enableImport is used for enabling the functionality of the module FirstSpirit Office.

By default, this functionality is not active. If the parameter is set to YES the button "Insert Word content from clipboard" will be displayed.

A valid licence for the module FirstSpirit Office is required to be able to use this attribute.

Overview

hFill

An input component is always displayed with a pre-defined width.

However, if the input component is to use the full available display width the parameter hFill must be given with the value YES .

Overview

hidden

With the "hidden" parameter an input component can be hidden from the editor.

If hidden="YES" the input component is not visible for the editor, if hidden="NO" it is visible.

The default value for hidden is NO.

Overview

importRuleset

Using the parameter importRulesets the selectable xml rule sets can be restricted for the respective input component if the functionality of the module FirstSpirit Office is active. For this purpose the parameter importRulesets must be given with the name/s of the desired rule set/s, defined in the server and project properties, in quotation marks and separated by comma.

If the parameter is not given all xml rule sets which are defined for the respective project are offered for selection.

This parameter is only evaluated if the parameter enableImport is set to YES.

For further information about the module FirstSpirit Office please refer to the related module documentation.

Overview

italic

The italic parameter can be used to overlay or hide the Italic button in the input component.

If the parameter is not given the button is overlaid as a default.

If NO (...italic="NO"...) is specified the button is hidden and if YES is given it is overlaid.

Overview

list

The list parameter can be used to overlay or hide the Insert List button in the input component.

If the parameter is not given the button is overlaid as a default.

If NO (...list="NO"...) is specified the button is hidden and if YES is given it is overlaid.

Lists can be configured using the listConfig and listDefaultConfig parameters.

Overview

listConfig

The listConfig parameter can be used to freely configure the list dialog.

Seven key terms are available for the type of input field:

1. text (input field for entry of single line texts)
2. number (input field for the entry of numbers)
3. boolean (selection box which can be activated)
4. choice (combo box from which an entry can be selected)
5. password (input field for encrypted text inputs, e.g. for passwords)
6. color (selection dialog for colour selection)

The syntax for definition of an input field is:

IDENTIFIER:LABELLING[type=TYPE;PARAMETERLIST]

Several input fields are to be given as a list separated by commas.

LABELLING is used to define the labelling of the input field to be displayed in the dialog.

The type parameter is used, with the help of the key word given with TYPE (see list above), to specify which input type is to be displayed.

If the type parameter is not given a single line text field is displayed, unless a list separated by the pipe symbol (|) is transferred as the parameter.
In this case a combobox is displayed.

For most input types (text, number, password, color, choice) the following parameters can be used, whereby it should be noted that not every combination is useful:

1. maxlen: This parameter can be used to specify the maximum input length (in characters). (e.g. maxlen=20)
2. upcase=true: This parameter coverts all input into upper case letters.
3. allowed=character string: All characters which can be used in the input is transferred as the value for this parameter (e.g. allowed=abcdef)

For the input type choice it is absolutely necessary to define a list of the selection options, whereby the individual items are separated by the pipe symbol ("|"). The labelling of the respective selection item can be defined behind the value with a colon. (e.g. choice:Wahl[type=choice;choice1:Auswahl1|choice2:Auswahl2|choice3:Auswahl3]).

...listConfig="
 a:Text[type=text;maxlen=30;upcase=true;
 allowed=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ],
 style:Listenart[4:Großbuchstaben|2:Zahlen|6:römische Zahlen],
 c:Check Box[boolean],
 d:Passwort[password],
 e:Nummer[type=number;maxlen=10],
 f:Farbe[color],
 h:Text,
 i:Text[text]"...

In the format templates with the abbreviations ul and li the stored value is available for an input field with the defined IDENTIFIER .

The stored value can be output with the help of the system object #list and the attr method:

$CMS_VALUE(#list.attr("IDENTIFIER"))$

Overview

listDefaultConfig

The template developer can use the listDefaultConfig parameter to assign default values to individual list variables.

To this end, a comma-separated list with all list variable names to be assigned default values (IDENTIFIER) is transferred as the value for the parameter, whereby a value is assigned for each variable. (e.g. listDefaultConfig="mediaref=media:O,pre=%index% von %count%,style=4").

If one of the reserved list variable names is used (see below) the appearance of the list is affected.

style

The reserved list variable name style is used to specify which list types are available for the editor to choose from. The different list types are explained below. (Example: style:Typ[4:Großbuchstaben|2:Zahlen|6:römische Zahlen|3:Kleinbuchstaben|8:Kreis|1:Scheibe|0:Quadrat]).
If the reserved list variable name style is not filled with default values, either all 9 list types are available to the editor once (if there is no listConfig parameter) or no list type (if listConfig has been given).

pre

The reserved list variable name pre is used to define the display of the bullets for list type 8.

The key terms: %index% (number of the current element), %count% (number of elements) and %count2% (number of the last element) can be used in this definition.

start

This reserved list variable name is used to specify the starting point of numbering.

The starting point must always be specified as a number, irrespective of which numbering type is used.

Tip: If the editor is to add entries, use "number" as the type for this input field and assign the default value 1.

mediaref

This reserved list variable name can be used to select a picture from the media store which is displayed in front of the list for list type 1.

List types

The definition of which list types are to be made available for the editor to choose from is specified with the help of the reserved list variable name style .

...style:Typ[2:Buchstaben|6:römische Zahlen]...

The following list types are available:

• Type 0: em-dash; a dash (-) is displayed as the list symbol.
• Type 1: Bullet; a blue triangle or the contents of the list variable mediaref are displayed as the list symbol.
• Type 2: Numbered; Arabic numerals are used as the numbering symbols.
• Type 3: Alphabetical (lower case letters); Latin lower case letters are used as the numbering symbols.
• Type 4: Alphabetical (upper case letters); Latin upper case letters are used as the numbering symbols.
• Type 5: Roman numbers (lower case letters); Roman numbers in lower case letters are used as the numbering symbols.
• Type 6: Roman numbers (upper case letters); Roman numbers in upper case letters are used as the numbering symbols.
• Type 7: Empty (indent only); no list symbols are used; however, the whole list is indented.
• Type 8: User defined; the contents of the reserved "pre" list variable are displayed as the list symbol or numbering symbol.

Access to the information of a list is usually via the system objects #list (whole list) and #listitem (one list item).

Overview

maxCharacters

The maxCharacters parameter can be used to limit the number of characters for input in an input component.

As a default, any number of characters can be entered in an input component.

The parameter expects an integer value.

If a value is specified with maxCharacters it is not possible to enter more than the given number of characters in the input component.

Overview

preset

Using the preset attribute the handling of default values in an input component can defined (see also chapter Default values). If preset="default" is set, the retrieval value defined in the form is used. If this value in the form is changed later on, these changes will be affect all usages of this default value in the input components maintained by the editor, as long as a value will be set manually in the input component. This is the default setting. If preset="copy" is set, the value entered by the editor is copied directly into the input component. Subsequent changes to the default value in the form do not have any effect on the usages of this default value in the input components maintained by the editor.

Overview

rows

The rows parameter can be used to specify the height of the input component.

If the parameter is not given the height of the input component is 4 rows.

...rows="20"...

If the input component is used within a group (CMS_GROUP), the height will comply with the height of the highest input component of the group.

Overview

table

Using the table parameter buttons for including and editing tables can be displayed or hidden in the input component. They are hidden at default. If the parameter is set to YES tables can be inserted into the textflow.

Overview

useLanguages

The useLanguages parameter can be used to specify whether or not an input component is to store different or deviating values for different languages (multi-lingual maintenance).

If the parameter is not given, deviating values are stored for the different languages as a default.

If NO (...useLanguages="NO") is specified, one value is stored for all languages.

Overview

width

The width parameter can be used to specify the display width of the input component in pixels.

The parameter expects an integer value.

If the parameter is not given the default width is 480 pixels.

The parameter does not have any effect if the hFill parameter is used.

Overview

FORMATS

The FORMATS tag can be used to specify the quantity of format templates usable in the input component.

The TEMPLATE tag can be given in the tag.

A usable format template corresponds to a TEMPLATE tag.

If FORMATS is not specified, all format templates existing in the project can be used.

TEMPLATE

A TEMPLATE tag is used to precisely define a format template within the FORMATS tag, which is to be available for use in the input component.

The tag has the mandatory parameter name, which must contain the unique identifier (abbreviation) of the format template.

Overview

name

The name parameter in the TEMPLATE tag is used to given the reference name of the template which is to be available for selection in the input component.

Overview

LANGINFOS

Using the tag LANGINFOS language-dependent information can be defined for each input component, e.g. which title is to be used for the input component in the different project languages (parameter label), which tooltip is to be displayed (parameter description) etc. For reasons of clarity, definitions which are identical in multiple languages will be merged. For example,

<LANGINFOS> 
 <LANGINFO lang="*" label="Datum"/> 
 <LANGINFO lang="DE" label="Datum"/> 
 <LANGINFO lang="EN" label="Datum"/>
</LANGINFOS>

will be merged to

 <LANGINFOS> 
 <LANGINFO lang="*" label="Datum"/> 
</LANGINFOS>

after saving.

Up to and including FirstSpirit version 4.2R2 language definitions will be deleted only in the case if the values are identical in all languages (as in example above). Furthermore, only the parameters lang, description and label are taken into account when merging.

Since FirstSpirit version 4.2R4 all parameters are taken into account (e.g. format and length). Furthermore, language definitions are also merged within LANGINFOS tags, if they are identical in at least two languages. For example,

<LANGINFOS> 
 <LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="DE" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

will become

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

after saving.

The definition for the fallback value (*) will not be deleted in any case. If there are two or more language definitions with identical values the first one will be maintained, the other will be deleted.

IMPORTANT: Up to and including FirstSpirit version 4.2R2 at least one definition for the fallback labelling ("*") must be given:

<LANGINFOS>
 <LANGINFO lang="*" label="TEXT"/>
</LANGINFOS>

From FirstSpirit version 4.2R4 the fallback definition can be omitted. In this case, the language which is defined first will be used automatically as fallback value. For example,

<LANGINFOS>
 <LANGINFO lang="EN" label="Date"/>
 <LANGINFO lang="DE" label="Datum"/> 
</LANGINFOS>

will become

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date"/>
 <LANGINFO lang="DE" label="Datum"/> 
</LANGINFOS>

after saving.

LANGINFO

The LANGINFO tag is used to give values or attributes for a language as well for use as fallback values.

In order to state values or attributes for a language it is necessary to give the abbreviation of the project language in the lang parameter:

...
<LANGINFO lang="DE".../>
...

Fallback values are given with the special language abbreviation * ("for all languages"):

...
<LANGINFO lang="*".../>
...

The lang parameter is a mandatory parameter.

Overview

lang

The lang parameter is used to give the language abbreviation which is entered in the server properties see FirstSpirit Manual for Administrators, Chapter "Language templates") to specify for which project languages the definitions are to apply, e.g. DE for German, EN for English, FR for French etc. The following characters can be used as often as required: -, _, 0-9 and A-Z. Lower case letters are transformed automatically into upper case letters after having saved the template. In addition * can be used for fallback values.

Overview

description

The description parameter can be used to give a description which is used to display a tool tip (mouse-over).

Overview

label

The label parameter is used to give the surface labelling for input and visualisation components.

Overview

LINKEDITORS

The LINKEDITORS tag can be used to specify the quantity of link templates usable in the input component.

The LINKEDITOR tag can be given in the tag.

A usable link template corresponds to a LINKEDITOR tag.

LINKEDITOR

A LINKEDITOR tag is used to precisely define a link template within the LINKEDITORS tag, which is to be available for use in the input component.

The tag has the mandatory parameter name, which must contain the reference name of the link template.

Overview

name

The name parameter in the LINKEDITOR tag is used to given the reference name of the link configuration which is to be available for selection in the input component.

Overview

LanguageAbbreviation	Language abbreviation, e.g. DE, EN, FR or * for return values
PositiveInteger	Positive integer
YesNo	Switch to apply an attribute or not NO Do not apply attribute YES Apply attribute
String	A random character string
Preset	Define the general preset modes. Default Retrieve default from definition, if no value is set. Copy Copy default from definition and save automatically.
Designator	Unique identifier of variable length; must start with a letter or underscore and may only contain the characters "A-Z", "a-z", "0-9" and "_", e.g. "fr_st_varName"

Example

An example of the input component "CMS_INPUT_DOM":

<CMS_INPUT_DOM hFill="YES" rows="10" name="IDENTIFIER" useLanguages="YES">
  <LANGINFOS>
    <LANGINFO lang="*" label="TEXT" description="TEXT"/>
    <LANGINFO lang="DE" label="TEXT" description="TEXT"/>
    <LANGINFO lang="EN" label="TEXT" description="TEXT"/>
  </LANGINFOS>
  <FORMATS>
    <TEMPLATE name="IDENTIFIER"/>
    <TEMPLATE name="IDENTIFIER"/>
    <TEMPLATE name="IDENTIFIER"/>
  </FORMATS>
</CMS_INPUT_DOM>

Example of use in the template syntax

The content of a DOM input component can be output via a $CMS_VALUE(...)$instruction.

$CMS_VALUE(st_dom)$

The result would then be the output:

<p>
  That is a 
  <b>Dummy Text.</b> 
  That is a dummy text. That is a dummy text. That is a dummy text. That is a 
  <i>Dummy Text.</i> 
  That is a 
  <strong style="color:#ff0;">Dummy Text.</strong> 
  That is a dummy text. That is a dummy text. 
</p>