Item
|
Description
|
Manipulator name
|
The name that will be displayed in the File|New menu and in the Files of
type listbox in the open file window.
|
Current manipulator
|
This field is read-only and is filled out in documents opened by means of the file manipulator. It contains
the full name of the file manipulator file that has been used to open the document.
|
Current format
|
Similar to the Current manipulator field; it contains the extension of the file opened
by the file manipulator.
|
File formats
|
Table containing file formats managed by the file manipulator. It may be useful to include multiple formats
if a single logical data type tends to be stored in different formats (e.g. images can be in JPEG,
PNG, etc.). If the different formats lack a common uniting substance, you should create
multiple file manipulators.
If multiple formats are defined, then it is entirely up to the creator of the file manipulator whether
and how potential format conversions or other operations will be performed. Information about the current
format is available in the Enki
language through the following item:
document.settings.file_manipulator_info.current_format
See the
file_manipulator_info item
in the document.settings .
|
Name
|
Format name displayed to the user.
|
Main
|
If multiple file manipulators are associated with a particular extension, preference is given to the
one that has this option checked. If there is more than one, the selection is random. The Main
option should be used only with those file manipulators that process the respective format in an exhaustive
manner in some sense.
|
File extensions
|
A list of extensions associated with the format. The column contains a list, therefore you have to enter
one extension without the initial dot per row. You should enter multiple extensions if the given format
occurs with multiple extensions (such as the JPEG format, which occurs with the jpg,
jpe, and jpeg extensions). If the formats are not identical,
you have to fill in multiple rows with formats rather than just multiple extensions.
|
File open function
|
An Enki
language function executed when the file is loaded. The function is specified in the function
editor. The parameter of the function is the
file_name
string containing the full path to the file that is being opened. You must use Enki
language functions for file
manipulation to open and load a file.
|
File save functions
|
Analogical to the file open function.
|
New document initialization
|
An Enki
language function executed when a new file is created by means of a file manipulator (from the File|New
menu). This function may perform a necessary initialization of the document. If no initialization
is necessary, the function is not needed.
|