Besides defining the Keystone portal root, the file tkl.config
plays the role of the master portal configuration file.
Using tkl.config as a configuration file is
not required. If there is no XML header in the beginning of
tkl.config, it will not be treated as a
configuration file, and the default settings will be used instead.
If, on the other hand, there is an XML header in the beginning of
tkl.config, the configuration file parser
expects an XML structure like this:
<?xml version="1.0"?>
<config>
<!-- Simple setting -->
<setting name="setting_name1" value="setting_value1" />
<!-- Complex setting -->
<setting name="setting_name2">
<setting name="sub_setting_a" value="value A" />
<setting name="sub_setting_b" value="value B" />
</setting>
<!-- Another simple setting -->
<setting name="setting_name2" value="setting_value2" />
</config>
Let's run through the configuration settings currently
supported by the system:
-
base_url - The public base URL of the Keystone portal.
-
from - The "from" email address used by various
robots attempting to send email to users.
-
userlang - Default user interface language.
This language will be used, if (a) no explicit language is
specified as a URL parameter lang=xx, and
(b) no language is stored in the session variables.
-
cache_dir - Use this directory (under the
portal root directory) for the caching. If this directory
exists, caching will take place. NB: This feature is only
experimental!
-
cache_expires - Number of seconds after
which a cached version of a portal web page expires.
-
allow_symlinks - This setting can be set to
"yes" or "no" depending on whether you want to allow users to
make symlinks between tkl files. Default is "yes".
-
languages - List of languages in which
you want to keep language dependent fields. You must
specify your language list using this pattern:
<setting name="languages">
<lang name="da" value="Danish"/>
<lang name="en" value="English"/>
<lang name="xx" value="My language"/>
</setting>
-
xform_xsl - Here you can specify a stylesheet - as
usual relative to the Keystone portal root - which over-writes the
built-in Keystone xml editor display stylesheet
(xform2.xsl).
Normally, you would like to xsl:import the built-in version of the
stylesheet and only overwrite on a template basis. This should be
done in your stylesheet using this instruction:
<xsl:import href="xform-xsl:"/>
Some of the settings can be overwritten by dedicated config files,
for instance, urlcheck.tkl which is the config
file for the Keystone urlchecker. Confirm man-pages for the Keystone run-time
environment.