eFORMz Create an Extension
The option “Install an Extension” in eFORMz can be used to install a directory path for your projects, replacing configuration files, such as fontspec_user.xml, or adding new fonts, translation files, or eFORMz settings.
In this guide we will show an example of how to automate the setup of a folder path when first using eFORMz in a Windows environment. This will be done by using a .zip file.
First create a zip, the extension, that has the desired folder path that you wish to create. For example:
Every file that you wish to process must be in the same directory location, as you see above. All the .efz files are placed in the same InstallFile Source location, but can all be moved to different Destination locations.
This zip file will need to contain a XML file called “Install.xml” in the “root” directory. Naming matters for this file and is case sensitive. The XML file is used to configure the folder path. Here is an example of a XML file.
Below is a description of the following XML tags set.
<Install> describes the package to install. The
<Main> element is nested within
<Main Description="The Main section will need to be installed in all cases."Default="true" Required="true">
<Main> element describes the items being installed. The following tags are nested within the
<InstallDirectory> will install a folder. This may include any of the following descriptors, such as
Destination are file path locations.
Type is a file’s format. For example .efz files are “ASCII” files and the XML attribute “type” should always be set to “ASCII” and PDF files are “BINARY”.
Overwrite is true, an existing file will be replaced by the new file. If Overwrite is false, the new file will be written only if there is no existing file with the same name.
Recursive is true, any sub-directory in the referenced source directory will also be copied to the destination (including contents).
<CreateDirectory> will install a folder that contains a file or a set of files. This may include any of the following descriptors, such as
<InstallFile> is used in conjunction with
<CreateDirectory> to place files in a specific folder. This may include any of the following descriptors, such as
There is also a
<RemoveFile> XML tag that can be used, but isn’t set in our XML example. Below is an example of that.
<RemoveFile> Destination="LabelPM.cfg" ></RemoveFile>
Your zip file should look like this.
The reason why I have my folder path starting with “projects” is because eFORMz’s has default file paths.
Your Windows file path will be “
\minisoft\eFORMZ_6\projects....” if set with the default.