Page MenuHomec4science
Files F63085425

config.wml
No OneTemporary
Actions

File Metadata

Created
Fri, May 17, 16:34

config.wml
View Options

## $Id$
## This file enables you to configure the parameters of your local CDS
## installation. It should be self-explanatory. Just go ahead and
## change the values within "define-tag" elements according to your
## needs. When done, return to the main CDSware source directory and
## type 'make'.
## This file is part of the CERN Document Server Software (CDSware).
## Copyright (C) 2002 CERN.
##
## The CDSware is free software; you can redistribute it and/or
## modify it under the terms of the GNU General Public License as
## published by the Free Software Foundation; either version 2 of the
## License, or (at your option) any later version.
##
## The CDSware is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with CDSware; if not, write to the Free Software Foundation, Inc.,
## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
## #####################
## About "config.wml" ##
## #####################
## This file ('config.wml') consists of several relatively independent
## configuration parts:
## Part 1: Essential parameters
## Part 2: CDS page elements
## Part 3: CDS navigation bar
## Part 5: WebSearch WML parameters
## Part 4: WebSearch OAI parameters
## Part 6: WebSubmit WML parameters
## Part 7: BibFormat WML parameters
## The configuration is done by editing the content of the "define-tag"
## WML elements below. Feel free to edit as many as you need. When done,
## return to the main CDSware source directory and type 'make'. Good luck! :-)
## Before starting, let's include messages and define available
## languages for the international multi-language interface. (You
## don't want to change these things here, the real language selection
## will be chosen further down.)
#include "messages.wml"
#use wml::std::lang
<lang:new id=de short>
<lang:new id=en short>
<lang:new id=es short>
<lang:new id=pt short>
<lang:new id=fr short>
<lang:new id=it short>
<lang:new id=ru short>
<lang:new id=sk short>
<lang:new id=cz short>
<lang:new id=no short>
###################################
## Part 1: Essential parameters ##
###################################
## This part defines essential CDSware internal parameters that
## everybody should modify, like the name of the server or the email
## address of the local CDSware administrator.
## CDSNAME -- the visible name of your CDSware installation:
## (example: "My Document Server")
<define-tag CDSNAME whitespace=delete>
Atlantis Institute of Fictive Science
</define-tag>
## CDSNAMEINTL -- the international versions of CDSNAME in various
## languages, defined using the standard locale-like language codes.
## (example: "<fr>Mon Serveur des Documents</fr>")
<define-tag CDSNAMEINTL whitespace=delete>
<en>Atlantis Institute of Fictive Science</en>
<fr>Atlantis Institut des Sciences Fictives</fr>
<de>Atlantis Institut der fiktiven Wissenschaft</de>
<es>Atlantis Instituto de la Ciencia Fictive</es>
<pt>Instituto Atlantis de Ciência Fictícia</pt>
<it>Atlantis Istituto di Scienza Fittizia</it>
<ru>Атлантис Институт фиктивных Наук</ru>
<sk>Atlantis Inštitút Fiktívnych Vied</sk>
<cz>Atlantis Institut Fiktivních Věd</cz>
<no>Atlantis Institutt for Fiktiv Vitenskap</no>
</define-tag>
## CDSLANG -- the default language of the interface:
## (example: "en")
<define-tag CDSLANG whitespace=delete>
en
</define-tag>
## CDSLANGS -- list of all languages the user interface should be
## available in, separated by commas. The order specified below will
## be respected on the interface pages. A good default would be to
## use the alphabetical order. Currently supported languages include
## Czech, German, English, Spanish, French, Italian, Norwegian,
## Portuguese, Russian, and Slovak, so that the current eventual
## maximum you can select is "cz,de,en,es,fr,it,no,pt,ru,sk".
## (example: "de,en,fr,it")
<define-tag CDSLANGS whitespace=delete>
cz,de,en,es,fr,it,no,pt,ru,sk
</define-tag>
## ALERTENGINEEMAIL -- the email address from which the alert emails will appear to be send:
## (example: "cds.alert@cdsware.cern.ch")
<define-tag ALERTENGINEEMAIL whitespace=delete>
cds.alert@cdsdev.cern.ch
</define-tag>
## SUPPORTEMAIL -- the email address of the support team for this installation:
## (example: "cds.support@cern.ch")
<define-tag SUPPORTEMAIL whitespace=delete>
cds.support@cern.ch
</define-tag>
## ADMINEMAIL -- the email address of the 'superuser' for this
## installation. Enter your email address below and login with this
## address when using CDSware administration modules. You will then
## be automatically recognized as superuser of the system.
## (example: "cds.support@cern.ch")
<define-tag ADMINEMAIL whitespace=delete>
cds.support@cern.ch
</define-tag>
## CFG_MAX_RECID -- maximum record ID number possible, i.e. the upper
## estimate of the total number of documents in the database. A
## reasonable estimate is: if you have 500,000 records in the database
## now, and the size is growing by 10,000 records per month, then a
## value of 700,000 sounds reasonable, as it should suffice for two
## years. Note that if in 6 months you'll suddenly have to upload a
## lot of new input records, so that it may grow past the present
## CFG_MAX_RECID limit, nothing bad happens: you only have to change
## this parameter and reindex the full database content. Note also
## that the lower CFG_MAX_RECID, the faster the search engine and the
## indexation engines are, so you have interest not to put it
## unnecessarily high. The relation between the speed and the value
## of CFG_MAX_RECID is about linear, so that cutting CFG_MAX_RECID by
## half will speed up the indexation about twice.
## (example: "8000")
<define-tag CFG_MAX_RECID whitespace=delete>
8000
</define-tag>
## CFG_APACHE_PASSWORD_FILE -- where Apache user credentials are stored
<define-tag CFG_APACHE_PASSWORD_FILE whitespace=delete>
/soft/httpd-bis/conf/httpd.password
</define-tag>
## CFG_APACHE_GROUP_FILE -- where Apache user groups are stored
<define-tag CFG_APACHE_GROUP_FILE whitespace=delete>
/soft/httpd-bis/conf/httpd.group
</define-tag>
## CFG_CERN_SITE -- do we want to enable CERN-specific code, like the
## one that proposes links to famous HEP sites such as Spires and KEK?
## Put "1" for "yes" and "0" for "no". (example: "0")
<define-tag CFG_CERN_SITE whitespace=delete>
0
</define-tag>
################################
## Part 2: CDS page elements ##
################################
## This part defines CDS portal-like page style and its elements.
## Here is a schematic overview of all the WML-configurable parts:
##
## +-----------------------------------------------------------------------------------------+
## | CDSPAGEHEADER |
## | (cdspageheaderadd) |
## +-------------------------+------------------------------------+--------------------------+
## | CDSPAGEBOXLEFTTOP | | CDSPAGEBOXRIGHTTOP |
## | (cdspageboxlefttopadd) | | (cdspageboxrighttopadd) |
## | | | |
## | | | |
## | | | |
## | | | |
## | | main page body | |
## | | | |
## | | | |
## | | | |
## | | | |
## | | | |
## | | | |
## |(cdspageboxleftbottomadd)| |(cdspageboxrightbottomadd)|
## | CDSPAGEBOXLEFTBOTTOM | | CDSPAGEBOXRIGHTBOTTOM |
## +-------------------------+------------------------------------+--------------------------+
## | (cdspagefooteradd) |
## | CDSPAGEFOOTER |
## +-----------------------------------------------------------------------------------------+
##
## Here, (i) the upper case elements like CDSPAGEHEADER are globally
## defined in this 'config.wml' file, see below. (ii) the lower case
## elements in parentheses like "(cdspageheaderadd)" are optional
## local add-ons that each WML page can define locally and pass to the
## global WML template as parameters. (iii) Note also that the style
## and colours of all these elements is defined in the cascading style
## sheet in the file 'htdocs/img/cds.css' that you can change at your
## will too.
## CDSPAGEHEADER -- eventual global HTML page header:
## (example: "")
<define-tag CDSPAGEHEADER>
<div style="background-image: url(<WEBURL>/img/header_background.gif);">
<table border="0" cellpadding="0" cellspacing="0" class="headerbox">
<tr>
<td rowspan="2" class="headerboxbodylogo">
<!--CDSNAMEINTL-->
</td>
<td align="right" class="userinfoboxbody">
<!--USERINFOBOX-->
</td>
</tr>
<tr>
<td class="headerboxbody" valign="bottom" align="left">
<table border="0" cellpadding="0" cellspacing="0" class="headermodulebox">
<tr>
<td class="headermoduleboxbodyblank">
&nbsp;
</td>
<td class="headermoduleboxbodyblank">
&nbsp;
</td>
<td class="headermoduleboxbody">
<a class=header href="<WEBURL>/?ln=<!--LN-->"><!--MSGSEARCH--></a>
</td>
<td class="headermoduleboxbodyblank">
&nbsp;
</td>
<td class="headermoduleboxbody">
<a class=header href="<WEBURL>/submit.py?ln=<!--LN-->"><!--MSGSUBMIT--></a>
</td>
<td class="headermoduleboxbodyblank">
&nbsp;
</td>
<td class="headermoduleboxbody">
<a class=header href="<WEBURL>/help/index.<!--LN-->.html"><!--MSGHELP--></a>
</td>
<td class="headermoduleboxbodyblank">
&nbsp;
</td>
</tr>
</table>
</td>
</tr>
</table>
</div>
<table border=0 cellspacing=0 cellpadding=0 class="navtrailbox" width="100%">
<tr>
<td class="navtrailboxbody">
<!--NAVTRAILBOX-->
</td>
</tr>
</table>
</define-tag>
## CDSPAGESTRIPEWIDTH -- width of CDS page stripe (left, right portal stripes)
## (example: "120")
<define-tag CDSPAGESTRIPEWIDTH whitespace=delete>
120
</define-tag>
## CDSPAGEBOXLEFTTOP -- eventual global HTML left top box:
## (example: "")
<define-tag CDSPAGEBOXLEFTTOP>
</define-tag>
## CDSPAGEBOXLEFTBOTTOM -- eventual global HTML left bottom box:
## (example: "")
<define-tag CDSPAGEBOXLEFTBOTTOM>
</define-tag>
## CDSPAGEBOXRIGHTTOP -- eventual global HTML right top box:
## (example: "")
<define-tag CDSPAGEBOXRIGHTTOP>
</define-tag>
## CDSPAGEBOXRIGHTBOTTOM -- eventual global HTML right bottom box:
## (example: "")
<define-tag CDSPAGEBOXRIGHTBOTTOM>
</define-tag>
## CDSPAGEFOOTER -- eventual global HTML page footer:
## (example: "")
<define-tag CDSPAGEFOOTER>
<table cellpadding=0 border=0 cellspacing=0 width="100%" class="footerbox">
<tr valign="top">
<td valign="top">
<!--LANGUAGESELECTIONBOX--><br><!--CDSNAMEINTL-->&nbsp;::&nbsp;<a class=note href="<WEBURL>/?ln=<!--LN-->"><!--MSGSEARCH--></a>&nbsp;::&nbsp;<a class=note href="<WEBURL>/submit.py?ln=<!--LN-->"><!--MSGSUBMIT--></a>&nbsp;::&nbsp;<a class=note href="<WEBURL>/help/index.<!--LN-->.html"><!--MSGHELP--></a>&nbsp;::&nbsp;<a class=note href="<WEBURL>/youraccount.py/display?ln=<!--LN-->"><!--MSGPERSONALIZE--></a><br><!--POWEREDBY--> <a class=note href="http://cdsware.cern.ch/">CDSware</a> v<VERSION>
</td>
<td align="right" valign="top">
<!--LASTUPDATED--><br><!--MAINTAINEDBY--> <a class=note href="mailto:<SUPPORTEMAIL>"><SUPPORTEMAIL></a>
</td>
</tr>
</table>
</define-tag>
################################
## Part 3: CDS navigation bar ##
################################
## The navigation bar and sub-bars are defined in a separate
## "cdsnavbar.wml" file. You may want to modify it now, if you
## really know what you are doing. :-)
######################################
## Part 4: WebSearch WML Parameters ##
######################################
## This section contains some WML-based configuration parameters for
## WebSearch module. Please note that WebSearch is mostly configured
## on run-time via its WebSearch Admin web interface. The parameters
## below are the ones that you do not probably want to modify very
## often during the runtime. (Note that you may modify them
## afterwards too, though.)
## CFG_SEARCH_CACHE_SIZE -- how many queries we want to cache in
## memory per one Apache httpd process? This cache is used mainly for
## "next/previous page" functionality, but it caches also "popular"
## user queries if more than one user happen to search for the same
## thing. Note that large numbers may lead to great memory
## consumption. We recommend a value not greater than 100.
## (example: "100")
<define-tag CFG_SEARCH_CACHE_SIZE whitespace=delete>
100
</define-tag>
## CFG_FIELDS_CONVERT -- if you migrate from an older system, you may
## want to map field codes of your old system (such as 'ti') to
## CDSware/MySQL ("title"). Use Python dictionary syntax for the
## translation table, see the example below. Usually you don't want
## to do that, and would use empty dict {}.
## (example: "{'wau':'author', 'wti':'title'}")
<define-tag CFG_FIELDS_CONVERT whitespace=delete>
{}
</define-tag>
## CFG_GOOGLE_BOX -- on the search results page, do we want propose
## links to other search engines like Google? Put "1" for "yes" and
## "0" for "no".
## (example: "1")
<define-tag CFG_GOOGLE_BOX whitespace=delete>
1
</define-tag>
## CFG_SIMPLESEARCH_PATTERN_BOX_WIDTH -- width of the search pattern
## window in the simple search interface, in characters.
## (example: "50")
<define-tag CFG_SIMPLESEARCH_PATTERN_BOX_WIDTH whitespace=delete>
40
</define-tag>
## CFG_ADVANCEDSEARCH_PATTERN_BOX_WIDTH -- width of the search pattern
## window in the advanced search interface, in characters.
## (example: "50")
<define-tag CFG_ADVANCEDSEARCH_PATTERN_BOX_WIDTH whitespace=delete>
30
</define-tag>
## CFG_NB_RECORDS_TO_SORT -- how many records do we still want to
## sort? For higher numbers we print only a warning and won't perform
## any sorting other than default 'latest records first', as sorting
## would be very time consuming then. We recommend a value of not
## more than a couple of thousands.
## (example: "1000")
<define-tag CFG_NB_RECORDS_TO_SORT whitespace=delete>
1000
</define-tag>
## CFG_CALL_BIBFORMAT -- if "HTML detailed" format is not found, do we
## want to call BibFormat on the fly? Put "1" for "yes" and "0" for
## "no". Usually we want to have "0' here.
## (example: "0")
<define-tag CFG_CALL_BIBFORMAT whitespace=delete>
0
</define-tag>
## CFG_USE_OLD_SYSNOS -- do we want to make old SYSNOs visible rather
## than MySQL's record IDs? You may use this if you migrate from a
## different e-doc system, and you store your old system numbers into
## 909C0o. Put "1" for "yes" and "0" for "no". Usually you don't want
## to do that, though.
## (example: "0")
<define-tag CFG_USE_OLD_SYSNOS whitespace=delete>
0
</define-tag>
## CFG_NB_LATEST_ADDITIONS -- the number of records to display under
## 'Latest Additions' in the web collection pages
## (example: "10")
<define-tag CFG_NB_LATEST_ADDITIONS whitespace=delete>
10
</define-tag>
## CFG_AUTHOR_ET_AL_THRESHOLD -- up to how many author names to print
## explicitely; for more print "et al". Note that this is used in
## default formatting that is seldomly used, as usually BibFormat
## defines all the format. The value below is only used when
## BibFormat fails, for example.
## (example: "3")
<define-tag CFG_AUTHOR_ET_AL_THRESHOLD whitespace=delete>
3
</define-tag>
## CFG_NARROW_SEARCH_SHOW_GRANDSONS -- whether to show or not
## collection grandsons in Narrow Search boxes (sons are shown
## by default, grandsons are configurable here). Use 0 for no
## and 1 for yes.
## (example: "0")
<define-tag CFG_NARROW_SEARCH_SHOW_GRANDSONS whitespace=delete>
1
</define-tag>
######################################
## Part 5: WebSearch OAI parameters ##
######################################
## This part defines OAI parameters for the current installation of
## CDSware OAI repository.
## OAIIDSCHEME -- OAI identifier scheme:
## (example: "oai")
<define-tag OAIIDSCHEME whitespace=delete>
oai
</define-tag>
## OAIIDTAG -- OAI identifier tag:
## (example: "0248_a")
<define-tag OAIIDTAG whitespace=delete>
909COo
</define-tag>
## OAISETTAG -- OAI set tag:
## (example: "0248_p")
<define-tag OAISETTAG whitespace=delete>
909COp
</define-tag>
## OAIDELETEDTAG -- OAI tag for deleted records mark. OAI record is considered deleted if the value of this field is set to "DELETED" and the OAI deleted records policy is set either to ``transient'' or ``persistent''.
## (example: "980__c")
<define-tag OAIDELETEDTAG whitespace=delete>
980__c
</define-tag>
## OAIDELETEDPOLICY -- OAI deletedrecordspolicy
## (example: no/transient/persistent)
<define-tag OAIDELETEDPOLICY whitespace=delete>
no
</define-tag>
## OAIIDPREFIX -- OAI identifier prefix:
## (example: "cds.cern.ch")
<define-tag OAIIDPREFIX whitespace=delete>
atlantis.cern.ch
</define-tag>
## OAISAMPLEIDENTIFIER -- OAI sample identifier:
## (example: "oai:cds.cern.ch:CERN-TH-4036")
<define-tag OAISAMPLEIDENTIFIER whitespace=delete>
<OAIIDSCHEME>:<OAIIDPREFIX>:CERN-TH-4036
</define-tag>
## OAIIDENTIFYDESCRIPTION -- description for the OAI Identify verb (optional):
## (example:"")
<define-tag OAIIDENTIFYDESCRIPTION whitespace=delete>
<description>
<oai-identifier xmlns="http://www.openarchives.org/OAI/2.0/oai-identifier"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai-identifier
http://www.openarchives.org/OAI/2.0/oai-identifier.xsd">
<scheme>
<OAIIDSCHEME>
</scheme>
<repositoryIdentifier>
<OAIIDPREFIX>
</repositoryIdentifier>
<delimiter>
:
</delimiter>
<sampleIdentifier>
<OAISAMPLEIDENTIFIER>
</sampleIdentifier>
</oai-identifier>
</description>
<description>
<eprints xmlns="http://www.openarchives.org/OAI/1.1/eprints"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.openarchives.org/OAI/1.1/eprints
http://www.openarchives.org/OAI/1.1/eprints.xsd">
<content>
<URL>http://<OAIIDPREFIX>/</URL>
</content>
<metadataPolicy>
<text>Free and unlimited use by anybody with obligation to refer to original record</text>
</metadataPolicy>
<dataPolicy>
<text>Full content, i.e. preprints may not be harvested by robots</text>
</dataPolicy>
<submissionPolicy>
<text>Submission restricted. Submitted documents are subject of approval by OAI repository admins.</text>
</submissionPolicy>
</eprints>
</description>
</define-tag>
## OAILOAD -- OAI number of records in a response:
## (example: 1000)
<define-tag OAILOAD whitespace=delete>
1000
</define-tag>
## OAIEXPIRE -- OAI resumptionToken expiration time:
## (example: 1000)
<define-tag OAIEXPIRE whitespace=delete>
90000
</define-tag>
######################################
## Part 6: WebSubmit WML Parameters ##
######################################
## This section contains some WML-based configuration parameters for
## WebSubmit module. Please note that WebSubmit is mostly configured
## on run-time via its WebSubmit Admin web interface. The parameters
## below are the ones that you do not probably want to modify during
## the runtime.
## CFG_SUBMIT_COUNTER -- indicates where the counters used by websubmit
## are stored
<define-tag CFG_SUBMIT_COUNTER whitespace=delete>
<DATADIR>/submit/counters
</define-tag>
## CFG_SUBMIT_DIR -- this indicates where the websubmit system will
## keep each submissions running data
<define-tag CFG_SUBMIT_DIR whitespace=delete>
<DATADIR>/submit/storage
</define-tag>
#############################################
## Part 7: Fulltext Archive WML Parameters ##
#############################################
## This section contains some WML-based configuration parameters for
## fulltext archive.
## CFG_FILE_DIR -- this indicates where the fulltext files will be
## stored
<define-tag CFG_FILE_DIR whitespace=delete>
<DATADIR>/files
</define-tag>
## CFG__FILE_DIR_SIZE -- all attached fulltext files are stored
## under the CFG_FILE_DIR directory, inside subdirectories called gX
## this variable indicates the maximum number of files stored in each
## subdirectories
<define-tag CFG_FILE_DIR_SIZE whitespace=delete>
5000
</define-tag>
######################################
## Part 8: BibFormat WML Parameters ##
######################################
## This section contains some WML-based configuration parameters for
## BibFormat module. Please note that BibFormat is mostly configured
## on run-time via its BibFormat Admin web interface. The parameters
## below are the ones that you do not probably want to modify very
## often during the runtime.
## CFG_BIBFORMAT_TIME_LIMIT -- the time limit of BibFormat process
## after which the task will terminate. This is useful to avoid
## eventual runaways.
## (example: "1000")
<define-tag CFG_BIBFORMAT_TIME_LIMIT whitespace=delete>
1000
</define-tag>
##########################
## THAT's ALL, FOLKS! ##
##########################
## And this is the end of "config.wml" WML configuration phase. Now
## please return to the main CDS source directory and type 'make'.
## (Note: if you have bravely edited the "cdsnavbar.wml" file too,
## then please do "make clean" before doing "make".)

Event Timeline

c4science · Help