GUI specification files may be written using XMLmind XML Editor (a simple configuration for .xxe_gui
files is included in the distribution of XXE) or using a text editor.
If you use a text editor, do not forget to validate your GUI specification against its schema. This schema is found in
. Unix example:XXE_install_dir
/addon/config/gui/xsd/gui.xsd
~/.xxe/addon$ /opt/xxe/bin/xsdvalid -s /opt/xxe/addon/config/gui/xsd/gui.xsd custom.xxe_gui
There are two ways to deploy a custom GUI specification for XXE:
Set environment variable XXE_GUI
as shown in the introduction of this document.
OR rename your .xxe_gui
file to custom.xxe_gui
(this special name is mandatory).
Then copy this file and all its resources (icons, translations, etc) to one of the addon/
directories scanned by XXE during its startup.
You need to use this second method if you deploy XXE with Java™ Web Start (described in XMLmind XML Editor - Configuration and Deployment). Note that this is consistent with the way all the other configuration files are deployed.
First method applied to the GUI created during this tutorial:
C:\Program Files\XMLmind_XML_Editor\
)Open a command prompt.
Change working directory to C:\Program Files\XMLmind_XML_Editor\doc\gui\tutorial\
.
Set environment variable XXE_GUI
as follows:
C:\...\tutorial> set XXE_GUI=tutorial1.xxe_gui
Start XXE as follows:
C:\...\tutorial> C:\Program Files\XMLmind_XML_Editor\bin\xxe.exe
bash
; assuming that XXE has been installed in /op/xxe/)Open a terminal.
Change working directory to /opt/xxe/doc/gui/tutorial
.
Start XXE as follows:
/opt/xxe/doc/gui/tutorial$ XXE_GUI=tutorial1.xxe_gui /opt/xxe/bin/xxe &
This method works fine with tutorial1.xxe_gui
, but not with tutorial2.xxe_gui
, tutorial3.xxe_gui
, etc. Why? Because the files other than tutorial1.xxe_gui
require XXE to load code found in
.XXE_install_dir
/doc/gui/tutorial/custom_parts.jar
In practice this means that if you want to use this method with a custom GUI making use of custom parts, you'll nevertheless have to deploy the custom code by copying its jar to one of the addon/
directories scanned by XXE during its startup.
Second method applied to the GUI created during this tutorial:
Copy directory
and all its content (which includes XXE_install_dir
/doc/gui/tutorial/custom.xxe_gui
, a file having a content identical to tutorial7.xxe_gui
) to directory
.XXE_user_preferences_dir
/addon/
XXE user preferences directory is:
on Unix,$HOME
/.xxe/
on Windows 2000/XP,%SystemDrive%
\Documents and Settings\%USERNAME%
\Application Data\XMLmind\XMLeditor\
on Windows NT.%SystemDrive%
\winnt\Profiles\%USERNAME%
\Application Data\XMLmind\XMLeditor\
Restart XXE as you usually do it.