source: trunk/gsdl/etc/main.cfg@ 1856

Last change on this file since 1856 was 1856, checked in by sjboddie, 23 years ago

Added Encoding and Language options to main.cfg configuration file so
it's now hopefully a little easier to add new languages and encodings
to the interface. Each interface language also now has a default encoding
so that changing languages from the preferences page causes the encoding
to change to a value reasonable for the selected language.

  • Property svn:keywords set to Author Date Id Revision
File size: 7.9 KB
Line 
1# This is the main configuration file for configuring
2# your Greenstone receptionist (i.e. the bit responsible
3# for the way things are displayed).
4
5# Email address of the webmaster of this Greenstone installation
6# If maintainer is set to "NULL" EmailEvents and EmailUserEvents
7# will be disabled.
8maintainer NULL
9
10# Outgoing (SMTP) mail server for this Greenstone installation.
11# This will default to mail.maintainer-domain if it's not set
12# (i.e. if maintainer is [email protected] then MailServer
13# will default to mail.cs.waikato.ac.nz). If MailServer doesn't
14# resolve to a valid SMTP server then the EmailEvents and
15# EmailUserEvents options (see below) won't be functional. Likewise,
16# turning off EmailEvents and EmailUserEvents will remove any
17# reliance on MailServer.
18MailServer NULL
19
20# Set status to "disabled" if you don't want the Maintenance and
21# Administration facility to be available.
22status enabled
23
24# Set collector to "disabled" if you don't want the "collector"
25# end-user collection building facility to be available.
26collector enabled
27
28# Set logcgiargs to true to keep a log of usage information in
29# $GSDLHOME/etc/usage.txt.
30logcgiargs true
31
32# Set usecookies to true to use cookies to identify users (cookie
33# information will be written to the usage log if logcgiargs is
34# true).
35usecookies true
36
37# LogDateFormat sets the format that timestamps will be stored in the usage
38# log (i.e. if logcgiargs is enabled). It takes the following values:
39LocalTime: (the default) The local time and date in the form
40 "Thu Dec 07 23:47:00 NZDT 2000".
41UTCTime: Coordinated universal time (GMT) in the same format as LocalTime.
42Absolute: Integer value representing the number of seconds since
43 00:00:00 1/1/1970 GMT
44LogDateFormat LocalTime
45
46# Log any events that Greenstone deems important in
47# $GSDLHOME/etc/events.txt.
48# The only events that are currently implemented come from the
49# collector (e.g. someone just built/deleted the following collection)
50# LogEvents may take values of:
51# AllEvents: All important events
52# CollectorEvents: Just those events originating from the collector
53# (e.g. someone just built a collection)
54# Disabled: Don't log events
55LogEvents Disabled
56
57# Email the maintainer whenever any event occurs. EmailEvents
58# takes the same values as LogEvents.
59# Note that perl must be installed for EmailEvents or
60# EmailUserEvents to work.
61EmailEvents Disabled
62
63# In some cases it may be appropriate to email the user about a
64# certain event (e.g. notification from the collector that a collection
65# was built successfully)
66EmailUserEvents false
67
68
69# The list of display macro files used by this receptionist
70macrofiles tip.dm style.dm base.dm query.dm help.dm pref.dm \
71 about.dm document.dm status.dm authen.dm \
72 users.dm html.dm extlink.dm delhistory.dm \
73 gsdl.dm english.dm chinese.dm french.dm german.dm maori.dm \
74 english2.dm french2.dm arabic.dm spanish.dm dutch.dm \
75 port.dm home.dm collect.dm
76
77
78# Define the interface languages and encodings supported by this receptionist
79
80# An "Encoding" line defines an encoding to be used by the receptionist
81# options are:
82# shortname -- Identifier for the given encoding. The shortname option is
83# mandatory and must be unique for each "Encoding" line.
84# longname -- The display name of the given encoding. If longname isn't set
85# it will default to using shortname instead.
86
87# type -- The type of encoding. Note that for most encodings this
88# value is the directory name under which the map file for
89# this encoding resides in the Greenstone unicode/MAPPINGS
90# directory (e.g. 'WINDOWS', 'ISO_8859' etc.). It may also
91# take the values 'GB' and 'UTF8'.
92# mapfile -- The name of the map file for use when converting between
93# utf8 and the given encoding. The mapfile option is mandatory
94# for all encoding types with the exception of GB and UTF8.
95# label -- The standard label to which you must set the value of
96# "charset" within http headers or html meta tags to get a web
97# browser to use the given encoding. The label option is
98# mandatory.
99Encoding shortname=utf8 "longname=Unicode (UTF-8)" type=UTF8 label=UTF-8
100Encoding shortname=iso1 "longname=Western (ISO-8859-1)" type=ISO_8859 mapfile=1.TXT label=ISO-8859-1
101Encoding shortname=w1251 "longname=Cyrillic (Windows-1251)" type=WINDOWS mapfile=1251.TXT label=windows-1251
102Encoding shortname=w1256 "longname=Arabic (Windows-1256)" type=WINDOWS mapfile=1256.TXT label=windows-1256
103Encoding shortname=gb "longname=Simplified Chinese (GBK)" type=GB label=GBK
104Encoding shortname=koi8r "longname=Cyrillic (KOI8-R)" type=CYRILLIC mapfile=koi8_r.txt label=koi8-r
105
106
107# A "Language" line defines an interface language to be used by the
108# interface. Note that it is possible to display only a subset of the
109# specified languages on the preferences page for a given collection by
110# using the "PreferenceLanguages" format option in your collect.cfg
111# configuration file.
112# options are:
113# shortname -- ISO 639 two letter language symbol. The shortname
114 option is mandatory.
115# longname -- The display name for the given language. If longname
116 isn't set it will default to using shortname instead.
117# default_encoding -- The encoding to use by default when using the given
118# interface language. This should be set to the
119# "shortname" of a valid "Encoding" line
120Language shortname=en longname=English default_encoding=iso1
121Language shortname=fr longname=French default_encoding=iso1
122Language shortname=zh longname=Chinese default_encoding=gb
123Language shortname=de longname=German default_encoding=iso1
124Language shortname=es longname=Spanish default_encoding=iso1
125Language shortname=mi longname=Maori default_encoding=iso1
126Language shortname=ar longname=Arabic default_encoding=w1256
127Language shortname=pt longname=Portuguese default_encoding=iso1
128Language shortname=nl longname=Dutch default_encoding=iso1
129
130
131# Define any additional page parameters to be used by the above macro files
132# (the current default page parameters are c (collection) and l (language)
133
134# Define v (version -- text or graphic) page parameter and give it a default
135# value of 0 (0 = text version off)
136pageparam v 0
137
138# Set the precedence given to the page parameters. This effects which macro
139# will be selected for display when there are multiple versions of the same
140# macro with different page parameters.
141# e.g. Given a macroprecedence of "c,v,l" and the following macro definitions:
142# _content_ []
143# _content_ [l=en]
144# _content_ [c=demo]
145# _content_ [v=1]
146# _content_ [l=fr,v=1,c=hdl]
147# If the corresponding cgi arguments were set to l=en&v=1&c=hdl then the
148# _content_[v=1] macro would be selected for display. It would be selected
149# ahead of the _content_[l=en] macro because "v" has a higher precedence
150# than "l". The _content_[l=fr,v=1,c=hdl] macro would not be selected
151# because one of the page parameters is completely wrong ("l").
152macroprecedence c,v,l
153
154
155# Define any additional cgi arguments. Most cgi arguments are built into
156# Greenstone but it's possible to define them here (or set defaults for
157# existing built-in cgi arguments).
158
159# define the "v" cgi argument (to correspond to the "v" page parameter defined
160# above).
161cgiarg shortname=v longname=version multiplechar=false argdefault=0 \
162 defaultstatus=weak savedarginfo=must
163
164# set a default value for the built-in "a" cgi argument
165cgiarg shortname=a argdefault=p
166
167# set a default value for the built-in "p" cgi argument
168cgiarg shortname=p argdefault=home
169
Note: See TracBrowser for help on using the repository browser.