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

Last change on this file since 17562 was 17562, checked in by kjdon, 16 years ago

changed some of the comments to reflect the default value of the option

  • Property svn:keywords set to Author Date Id Revision
File size: 14.5 KB
RevLine 
[7707]1# This file must be utf-8 encoded
2#
[1868]3# This is the main configuration file for configuring
[8116]4# your Greenstone receptionist (the bit responsible for the way
5# things are displayed) and contains information common
6# to the interface of all collections served by the site.
[1868]7
8# Email address of the webmaster of this Greenstone installation
9# If maintainer is set to "NULL" EmailEvents and EmailUserEvents
10# will be disabled.
11maintainer NULL
12
13# Outgoing (SMTP) mail server for this Greenstone installation.
14# This will default to mail.maintainer-domain if it's not set
15# (i.e. if maintainer is [email protected] then MailServer
16# will default to mail.cs.waikato.ac.nz). If MailServer doesn't
17# resolve to a valid SMTP server then the EmailEvents and
18# EmailUserEvents options (see below) won't be functional. Likewise,
19# turning off EmailEvents and EmailUserEvents will remove any
20# reliance on MailServer.
21MailServer NULL
22
[11151]23# Set status to "enabled" if you want the Maintenance and
[1868]24# Administration facility to be available.
[14519]25status disabled
[1868]26
[17562]27# Set collector to "enabled" if you want the "collector"
[1868]28# end-user collection building facility to be available.
[17562]29# This allows creation of new collections via a web interface.
30# No longer maintained.
[9430]31collector disabled
[1868]32
[17562]33# Set depositor to "enabled" if you want the "depositor"
[12009]34# (aka institutional repository) facility to be available.
[17562]35# This enables addition of new documents and metadata to existing collections
[12009]36depositor disabled
37
[17562]38# Set gliapplet to "enabled" if you want remote users
[7764]39# to be able to build collections on your server through an applet
40# version of GLI
41gliapplet disabled
42
[17562]43# Set logcgiargs to "true" to keep a log of usage information in
[1868]44# $GSDLHOME/etc/usage.txt.
[1992]45logcgiargs false
[1868]46
[17562]47# Set usecookies to "true" to use cookies to identify users (cookie
[1868]48# information will be written to the usage log if logcgiargs is
49# true).
[1992]50usecookies false
[1868]51
52# LogDateFormat sets the format that timestamps will be stored in the usage
53# log (i.e. if logcgiargs is enabled). It takes the following values:
[2341]54# LocalTime: (the default) The local time and date in the form
55# "Thu Dec 07 23:47:00 NZDT 2000".
56# UTCTime: Coordinated universal time (GMT) in the same format as LocalTime.
57# Absolute: Integer value representing the number of seconds since
58# 00:00:00 1/1/1970 GMT
[1868]59LogDateFormat LocalTime
60
61# Log any events that Greenstone deems important in
62# $GSDLHOME/etc/events.txt.
63# The only events that are currently implemented come from the
64# collector (e.g. someone just built/deleted the following collection)
65# LogEvents may take values of:
66# AllEvents: All important events
67# CollectorEvents: Just those events originating from the collector
68# (e.g. someone just built a collection)
[1968]69# disabled: Don't log events
70LogEvents disabled
[1868]71
72# Email the maintainer whenever any event occurs. EmailEvents
73# takes the same values as LogEvents.
74# Note that perl must be installed for EmailEvents or
75# EmailUserEvents to work.
[1968]76EmailEvents disabled
[1868]77
78# In some cases it may be appropriate to email the user about a
79# certain event (e.g. notification from the collector that a collection
80# was built successfully)
81EmailUserEvents false
82
83
84# The list of display macro files used by this receptionist
[1942]85macrofiles tip.dm style.dm base.dm query.dm help.dm pref.dm about.dm \
[2405]86 document.dm browse.dm status.dm authen.dm users.dm html.dm \
[12009]87 extlink.dm gsdl.dm extra.dm home.dm collect.dm deposit.dm docs.dm \
[15988]88 bsummary.dm gti.dm gli.dm nav_css.dm languages.dm dynamicclassifier.dm \
[9247]89 english.dm english2.dm french.dm french2.dm spanish.dm \
[11173]90 spanish2.dm russian.dm russian2.dm \
[16270]91 amharic.dm amharic2.dm arabic.dm arabic2.dm armenian.dm armenian2.dm \
92 bengali.dm bulgarian.dm \
[15008]93 catalan.dm catalan2.dm chinese-trad.dm chinese-trad2.dm \
[15009]94 chinese.dm chinese2.dm croatian.dm czech.dm czech2.dm dari.dm \
95 dutch.dm farsi.dm farsi2.dm finnish.dm gaelic.dm \
[15008]96 galician.dm galician2.dm \
97 georgian.dm georgian2.dm german.dm greek.dm hebrew.dm \
98 hindi.dm hungarian.dm hungarian2.dm indo.dm indo2.dm \
99 italian.dm italian2.dm japanese.dm japanese2.dm \
100 kannada.dm kazakh.dm kazakh2.dm kirghiz.dm \
[15009]101 latvian.dm latvian2.dm malayalam.dm maori.dm \
102 marathi.dm marathi2.dm \
[15129]103 mongolian.dm mongolian2.dm nepali.dm polish.dm port-br.dm port-pt.dm \
104 pushto.dm romanian.dm romanian2.dm serbian.dm sinhalese.dm \
[15009]105 slovak.dm slovak2.dm tamil.dm telugu.dm thai.dm thai2.dm \
[15008]106 turkish.dm turkish2.dm ukrainian.dm urdu.dm urdu2.dm \
107 vietnamese.dm vietnamese2.dm
108
[1868]109
110# Define the interface languages and encodings supported by this receptionist
111
[1870]112# An "Encoding" line defines an encoding to be used by the receptionist.
113# Uncomment "Encoding" lines to include an encoding on your "preferences" page.
114# Encoding line options are:
115# shortname -- The standard charset label for the given encoding. The
116# shortname option is mandatory.
[1868]117# longname -- The display name of the given encoding. If longname isn't set
118# it will default to using shortname instead.
[1870]119# map -- The name of the map file (i.e. the .ump file) for use when
120# converting between unicode and the given encoding. The map
121# option is mandatory for all encoding lines except the
122# special case for utf8.
[1927]123# multibyte -- This optional argument should be set for all encodings that use
124# multibyte characters.
[1868]125
[1870]126# The utf8 encoding is handled internally and doesn't require a map file.
127# As a rule the utf8 encoding should always be enabled, especially if you
128# have collections of documents that may not all be in the same
129# language/encoding.
130Encoding shortname=utf-8 "longname=Unicode (UTF-8)"
[1868]131
[7707]132# This is very experimental, and you almost certainly don't need it
[9674]133#Encoding shortname=utf-16be "longname=Unicode (UTF-16BE)"
[7707]134
[1870]135# The ISO-8859 series
136Encoding shortname=iso-8859-1 "longname=Western (ISO-8859-1)" map=8859_1.ump
137#Encoding shortname=iso-8859-2 "longname=Central European (ISO-8859-2)" map=8859_2.ump
138#Encoding shortname=iso-8859-3 "longname=Latin 3 (ISO-8859-3)" map=8859_3.ump
139#Encoding shortname=iso-8859-4 "longname=Latin 4 (ISO-8859-4)" map=8859_4.ump
140#Encoding shortname=iso-8859-5 "longname=Cyrillic (ISO-8859-5)" map=8859_5.ump
141#Encoding shortname=iso-8859-6 "longname=Arabic (ISO-8859-6)" map=8859_6.ump
142#Encoding shortname=iso-8859-7 "longname=Greek (ISO-8859-7)" map=8859_7.ump
143#Encoding shortname=iso-8859-8 "longname=Hebrew (ISO-8859-8)" map=8859_8.ump
144#Encoding shortname=iso-8859-9 "longname=Turkish (ISO-8859-9)" map=8859_9.ump
[3133]145#Encoding shortname=iso-8859-15 "longname=Western (ISO-8859-15)" map=8859_15.ump
[1868]146
[1870]147# Windows codepages
[5629]148Encoding shortname=windows-1250 "longname=Central European (Windows-1250)" map=win1250.ump
[1904]149Encoding shortname=windows-1251 "longname=Cyrillic (Windows-1251)" map=win1251.ump
[1870]150#Encoding shortname=windows-1252 "longname=Western (Windows-1252)" map=win1252.ump
[6225]151Encoding shortname=windows-1253 "longname=Greek (Windows-1253)" map=win1253.ump
[3220]152Encoding shortname=windows-1254 "longname=Turkish (Windows-1254)" map=win1254.ump
[2731]153Encoding shortname=windows-1255 "longname=Hebrew (Windows-1255)" map=win1255.ump
[1870]154Encoding shortname=windows-1256 "longname=Arabic (Windows-1256)" map=win1256.ump
155#Encoding shortname=windows-1257 "longname=Baltic (Windows-1257)" map=win1257.ump
156#Encoding shortname=windows-1258 "longname=Vietnamese (Windows-1258)" map=win1258.ump
157#Encoding shortname=windows-874 "longname=Thai (Windows-874)" map=win874.ump
[1904]158#Encoding shortname=cp866 "longname=Cyrillic (DOS)" map=dos866.ump
[6757]159#Encoding shortname=cp850 "longname=Latin-1 (DOS)" map=dos850.ump
[12602]160#Encoding shortname=cp852 "longname=Central European (DOS)" map=dos852.ump
[1870]161
162# KOI8 Cyrillic encodings
163#Encoding shortname=koi8-r "longname=Cyrillic (KOI8-R)" map=koi8_r.ump
164#Encoding shortname=koi8-u "longname=Cyrillic (KOI8-U)" map=koi8_u.ump
165
166# CJK encodings (note that Shift-JIS Japanese isn't currently supported)
[7707]167Encoding shortname=gbk "longname=汉语 (Chinese Simplified GBK)" map=gbk.ump multibyte
168Encoding shortname=big5 "longname=挢語 (Chinese Traditional Big5)" map=big5.ump multibyte
[1927]169Encoding shortname=euc-jp "longname=Japanese (EUC)" map=euc_jp.ump multibyte
170Encoding shortname=euc-kr "longname=Korean (UHC)" map=uhc.ump multibyte
[1870]171
172
[1868]173# A "Language" line defines an interface language to be used by the
174# interface. Note that it is possible to display only a subset of the
175# specified languages on the preferences page for a given collection by
176# using the "PreferenceLanguages" format option in your collect.cfg
177# configuration file.
[3220]178# Arguments are:
[1868]179# shortname -- ISO 639 two letter language symbol. The shortname
[8449]180# argument is mandatory.
[1868]181# longname -- The display name for the given language. If longname
[8449]182# isn't set it will default to using shortname instead.
[1868]183# default_encoding -- The encoding to use by default when using the given
184# interface language. This should be set to the
185# "shortname" of a valid "Encoding" line
[16270]186Language shortname=am longname=Amharic default_encoding=utf-8
[11173]187Language shortname=ar longname=Arabic default_encoding=windows-1256
[15009]188Language shortname=bg longname=Bulgarian default_encoding=utf-8
[11173]189Language shortname=bn "longname=àŠ¬àŠŸàŠ‚àŠ²àŠŸ (Bengali)" default_encoding=utf-8
190Language shortname=ca "longname=Català (Catalan)" default_encoding=utf-8
191Language shortname=cs "longname=Česky (Czech)" default_encoding=utf-8
192Language shortname=de "longname=Deutsch (German)" default_encoding=utf-8
193Language shortname=el "longname=ΕλληΜικά (Greek)" default_encoding=windows-1253
[3122]194Language shortname=en longname=English default_encoding=utf-8
[7707]195Language shortname=es "longname=Español (Spanish)" \
196 default_encoding=utf-8
[11173]197Language shortname=fa longname=Farsi default_encoding=utf-8
198Language shortname=fi longname=Finnish default_encoding=utf-8
[7707]199Language shortname=fr "longname=Français (French)" \
200 default_encoding=utf-8
[11223]201Language shortname=gd "longname=Gaelic (Scottish)" default_encoding=utf-8
[11173]202Language shortname=gl longname=Galician default_encoding=utf-8
203Language shortname=he longname=Hebrew default_encoding=windows-1255
204Language shortname=hi longname=Hindi default_encoding=utf-8
205Language shortname=hr longname=Croatian default_encoding=windows-1250
[13219]206Language shortname=hu longname=Hungarian default_encoding=utf-8
[11173]207Language shortname=hy longname=Armenian default_encoding=utf-8
208Language shortname=id "longname=Bahasa Indonesia (Indonesian)" default_encoding=utf-8
209Language shortname=it longname=Italiano default_encoding=utf-8
210Language shortname=ja "longname=日本語 (Japanese)" default_encoding=utf-8
211Language shortname=ka longname=Georgian default_encoding=utf-8
212Language shortname=kk "longname=Қазақ (Kazakh)" default_encoding=utf-8
213Language shortname=kn longname=Kannada default_encoding=utf-8
214Language shortname=ky "longname=Кыргызча (Kirghiz)" default_encoding=utf-8
215Language shortname=lv longname=Latvian default_encoding=utf-8
216Language shortname=mi "longname=Māori" default_encoding=utf-8
[15009]217Language shortname=ml "longname=Malayalam" default_encoding=utf-8
[15075]218Language shortname=mr "longname=Marathi" default_encoding=utf-8
[11173]219Language shortname=mn "longname=МПМгПл (Mongolian)" default_encoding=utf-8
[15129]220Language shortname=ne "longname=à€šà¥‡à€ªà€Ÿà€² (Nepali)" default_encoding=utf-8
[11173]221Language shortname=nl "longname=Nederlands (Dutch)" default_encoding=utf-8
[14519]222Language shortname=pl "longname=Polski (Polish)" default_encoding=utf-8
[13986]223Language shortname=prs "longname=Dari" default_encoding=utf-8
[14519]224Language shortname=ps "longname=Pushto" default_encoding=utf-8
225Language shortname=pt-br "longname=Português-BR (Brasil)" \
[11173]226 default_encoding=utf-8
[14519]227Language shortname=pt-pt "longname=Português-PT (Portugal)" \
[11173]228 default_encoding=utf-8
[14876]229Language shortname=ro longname=Romanian default_encoding=utf-8
[8748]230Language shortname=ru "longname=русскОй (Russian)" default_encoding=windows-1251
[15009]231Language shortname=si "longname=සිංහග (Sinhala)" default_encoding=utf-8
[12654]232Language shortname=sk "longname=Slovenčina (Slovak)" default_encoding=utf-8
[11173]233Language shortname=sr longname=Serbian default_encoding=utf-8
[15009]234Language shortname=ta longname=Tamil default_encoding=utf-8
235Language shortname=te longname=Telugu default_encoding=utf-8
[11173]236Language shortname=th longname=Thai default_encoding=utf-8
237Language shortname=tr longname=Turkish default_encoding=windows-1254
238Language shortname=uk longname=Ukrainian default_encoding=utf-8
[15129]239Language shortname=ur longname=Urdu default_encoding=utf-8
[11173]240Language shortname=vi "longname=Tiếng Việt (Vietnamese)" default_encoding=utf-8
[13352]241Language shortname=zh "longname=简䜓䞭文 (Simplified Chinese)" default_encoding=gbk
[11173]242Language shortname=zh-tr "longname=繁體䞭文 (Traditional Chinese)" default_encoding=big5
[1868]243
[8707]244
[1868]245# Define any additional page parameters to be used by the above macro files
246# (the current default page parameters are c (collection) and l (language)
247
248# Define v (version -- text or graphic) page parameter and give it a default
249# value of 0 (0 = text version off)
250pageparam v 0
251
252# Set the precedence given to the page parameters. This effects which macro
253# will be selected for display when there are multiple versions of the same
254# macro with different page parameters.
255# e.g. Given a macroprecedence of "c,v,l" and the following macro definitions:
256# _content_ []
257# _content_ [l=en]
258# _content_ [c=demo]
259# _content_ [v=1]
260# _content_ [l=fr,v=1,c=hdl]
261# If the corresponding cgi arguments were set to l=en&v=1&c=hdl then the
262# _content_[v=1] macro would be selected for display. It would be selected
263# ahead of the _content_[l=en] macro because "v" has a higher precedence
264# than "l". The _content_[l=fr,v=1,c=hdl] macro would not be selected
265# because one of the page parameters is completely wrong ("l").
266macroprecedence c,v,l
267
268
269# Define any additional cgi arguments. Most cgi arguments are built into
270# Greenstone but it's possible to define them here (or set defaults for
271# existing built-in cgi arguments).
272
273# define the "v" cgi argument (to correspond to the "v" page parameter defined
274# above).
275cgiarg shortname=v longname=version multiplechar=false argdefault=0 \
276 defaultstatus=weak savedarginfo=must
277
278# set a default value for the built-in "a" cgi argument
279cgiarg shortname=a argdefault=p
280
281# set a default value for the built-in "p" cgi argument
282cgiarg shortname=p argdefault=home
283
[3121]284# set the default encoding to utf-8
[3153]285cgiarg shortname=w argdefault=utf-8
[14519]286
[17411]287# If you want an intermediate page to warn users that they've clicked on
288# an external link, then uncomment the following line
289#cgiarg shortname=el argdefault=prompt
290
Note: See TracBrowser for help on using the repository browser.