Sfairadora

  • Reference Guide

Function Editor

The function editor allows you to enter functions (expressions) in the Enki, language or templates in the Enkidu language. A listbox for the selection of the (programming) language is located at the top of the editor. The Enkidu language is available only if the result type can be Rich_text because the output template allows you to create only formatted texts.
If you use a function in a context where parameters and result type are predetermined, the language selection listbox is followed only by information about parameter names and types and about the result type. If parameters and result type are arbitrary (like in the Definition – function document section), you will see a table in which you can enter the list of parameters and specify the result type. The function itself is edited in text editor in case of Enki language and in rich text editor in case of Enkidu language.

Parameter List

Parameters are listed in a table containing the following columns:
Column
Description
Name
Parameter name. It must be an identifier.
Data type
Selection of parameter data type. See the data type editor.
Type details
Additional information for some data types (see the explanation in the preceding section and the data type editor).
Constant
If a parameter is passed by reference, the value of the data item referred by the parameter cannot be modified.
By reference
Parameter is passed by reference rather than by value.
Non-strict
Error value type can be passed instead of a value of the declared type (that is, the parameter is non-strict).

Result

The following items are used to specify the result type:
Item
Description
Constant
If the result is passed by reference, the value of the data item identified by the reference cannot be modified through the resulting reference.
By reference
The result is passed by reference rather than by value.
Data type
Selection of result data type. See the data type editor.

Insert Menu

Whenever you edit the actual function (or template), a list of all language constructs, functions, data types, and constants is available in the Insert menu. Besides, all data items available to the function during evaluation are listed under the Insert|Data menu item.