Database Reference
In-Depth Information
Rebuilding eXist
If you've found out that the module you needed was not part of the eXist build
because its
include.module
entry was set to
false
in
$EXIST_HOME/extensions/
build.properties
, here is how to change it:
1. Install (if it's not on your system already) the Java SE JDK—that is, the develop‐
ment kit, not the runtime environment. For instructions and downloads, refer to
2. Make sure you have an environment variable called
JAVA_HOME
pointing to the
root directory of your Java installation. If it does not exist, create it.
3. If you haven't done so before, copy
$EXIST_HOME/extensions/build.properties
to
local.build.properties
(in the same directory).
4. Edit
local.build.properties
and set the
include.module
entry for the module you
want to enable to
true
(for instance,
include.module.xslfo = true
).
5. Stop eXist.
6. Open a command window, navigate to
$EXIST_HOME
, and issue the appropri‐
ate build command:
• On Unix-based systems:
./build.sh extension-modules
• On Windows-based systems:
build.bat extension-modules
The build will run. If you examine the output you should see some messages
scroll by regarding your module.
7. Since eXist is still stopped at this point, enable the corresponding
module
element
in the built-in modules list in
$EXIST_HOME/conf.xml
now.
8. Restart eXist.
Now the module is enabled. This not only means that you can use its functions from
within your XQuery code, but also that it should show up in the eXist function docu‐
mentation browser (after a regeneration).
Enabling XQuery Extension Modules
An XQuery extension module is not so different from an XQuery module that you
could write yourself. The real difference is that the extension modules are a part of
the main eXist distribution and are included in one of eXist's JAR files that is present
on the classpath. Paths to a resource on the classpath in
$EXIST_HOME/conf.xml
are
prefixed with
resource:
, like so:
<module
uri=
"http://exist-db.org/xquery/kwic"
src=
"resource:org/exist/xquery/lib/kwic.xql"
/>
Search WWH ::
Custom Search