# <script_name>.properties contains settings to run the executable programs
# (or scripts) under GEDI.


# You must create separate *.properties file for each Script.
# Place all *.properties file into "GEDI\lib\Scripts" directory.
# Log file will be created in this directory and named as *.log.

# Add below listed parameters to run your Script using the format: key = value

# Please do not rename the current file name.

# To disable use a # sign to comment out the line.

# If all Keys are commented out, the Script Properties file is considered
# empty and will not be added to GEDI interface.

# Please note that GEDI uses "Image Directory" and "Xml Directory" that
# may be different. The working directory for the process is "Image Directory".
# If your executable program is located in the "Image Directory", just
# provide name (or relative path) of the program.

# The rest of the current file is the list of available Script settings:

##################################################################

! NAME = <name of script to appear in the GEDI menu>

! COMMAND = <the string to run the script using below listed parameters >
# You can provide relative path to executable program.

! SHOW_DIALOG = <determines whether to show dialog to monitor script runs>
! true = show dialog; default value
! false = do not show dialog

! APPEND_LOG = <determines whether to append Script outputs to the Log file>
! true = append to the existing Log file
! false = do not append (overwrite) existing Log file; default value

# Default values are used if you not set up variables.

####################################################################

# Parameters for the COMMAND:

# %img         -- absolute path to the currently opened image in GEDI
# %img-root    -- the "root" name of the currently opened image (i.e. if
#           	  you have an image "a.b.c.tiff", the "root" name is "a.b.c")
# %img-ext     -- extension of the currently opened image (i.e. tiff, jpg)
# %img-dir     -- absolute path to the current Image directory
# %img-dir-name-- name of the current Image directory

# %xml         -- absolute path to the currently opened Xml in GEDI
# %xml-root    -- the "root" name of the currently opened Xml (i.e. if
#           	  you have an "someName.xml", the "root" name is "someName")
# %xml-ext     -- extension of the currently opened image (i.e. xml, XML)
# %xml-dir     -- absolute path to the current Xml directory
# %xml-dir-name-- name of the current Xml directory
# %gedi-dir    -- directory where GEDI is installed. 


# Square brackets are optional and can be used to simplify visual string reading.

# Example of the string to run script:

# COMMAND = "C\\:\\Scripts\\TextMerge.exe" -x -e -box "%img" -outXml "[%xml-dir]\\[%img-root].merge[%xml-ext]" -inTxt "[%xml-dir]\\[%xml-dir-name].txt"

# Absolute path to the executable program is provided.
# Current image (its absolute path) is used as an input parameter.
# "-x -e -box" are custome parameters.
# "-outXml" is also custom parameter and determines output Xml that will be placed into
# current Xml directory and named "a.b.c.merge.xml".
# "-inTxt" is one more input parameter specifying input text file. Text file is located in
# the current Xml directory and named as directory name.
