Dev/Config files

Overview (and disclaimer)

XOWA uses a custom text format called gfs (an acronym for the gfs flexible script). It is a plain-text config file with a Java-like syntax.

Please note that gfs was an early personal project, dating back over five years ago. Although there are considerable flaws in the project, it was incorporated into XOWA for reasons of expedience.

Unfortunately, although the script is flexible for my purposes, the format is very easy to break and the resulting error messages can be cryptic and indecipherable.

As such, please follow these guidelines when working with a gfs file.

• Always have a backup.
• Add changes in small steps.
• Do not stray far from the provided file.
• Do not be clever. You will outsmart the library.

Recommended procedure for changes

Please follow the steps below when changing config files. Windows instructions are provided in parentheses.

Note that you can keep XOWA open while making changes to the .gfs file. (for example, while reading this help page). However, in order for the changes to take effect, you must restart XOWA.

• Open up the config file in a text editor. (launch jEdit or Notepad++).
• Make the desired change. (see Dev/Config_files/Examples for examples.)
• Save and close the file.
• Run XOWA (java -jar xowa_windows.jar)

If it works, then XOWA will launch normally.

If it fails, then a message box will display an error. Note that the log will also have the same information: /xowa/user/anonymous/app/tmp/log/current.