Greenstone Wiki

User Tools

Site Tools

You are here: index » en » user » configuration_files
en:user:configuration_files

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
en:user:configuration_files [2015/05/27 02:21] – external edit 127.0.0.1en:user:configuration_files [2023/03/13 01:46] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +
 +
 +
 ====== Greenstone Configuration Files ====== ====== Greenstone Configuration Files ======
 There are several important files in your Greenstone installation that you can use There are several important files in your Greenstone installation that you can use
Line 8: Line 11:
 The table below provides some information on important configuration files throughout your Greenstone The table below provides some information on important configuration files throughout your Greenstone
 installation. installation.
-<TABAREA tabs="Greenstone3,Greenstone2"> +<tabbox Greenstone3>
-<TAB>+
 ^**Server Configuration files**^^^ ^**Server Configuration files**^^^
 ^File^Location^Description^ ^File^Location^Description^
Line 17: Line 19:
 |**OAIConfig.xml**|''GSDL3HOME/WEB-INF/classes''|the configuration file for the OAI server| |**OAIConfig.xml**|''GSDL3HOME/WEB-INF/classes''|the configuration file for the OAI server|
 ^**GLI Configuration files**^^^ ^**GLI Configuration files**^^^
-|**config.xml**|Linux: ''<USERHOME>/.gli'' Windows: ''C:\Documents and Settings\<username>\Application Data\Greenstone\GLI''|Configuration file for local GLI - stores settings such as library address, last collection open, warnings activated or deactivated etc.| +|**config.xml**|Linux: ''<USERHOME>/.gli'' \\ Windows: ''C:\Documents and Settings\<username>\Application Data\Greenstone\GLI''|Configuration file for local GLI - stores settings such as library address, last collection open, warnings activated or deactivated etc.| 
-|**configRemote.xml**|Linux: ''<USERHOME>/.gli'' Windows: ''C:\Documents and Settings\<username>\Application Data\Greenstone\GLI''|Separate version for use with GLI client. Basically the same os the local version, but includes gliserver address. Needed so that you can run a local GLI at the same time as running GLI with a remote library server.|+|**configRemote.xml**|Linux: ''<USERHOME>/.gli'' \\ Windows: ''C:\Documents and Settings\<username>\Application Data\Greenstone\GLI''|Separate version for use with GLI client. Basically the same as the local version, but includes gliserver address. Needed so that you can run a local GLI at the same time as running GLI with a remote library server.|
 ^**Collection configuration files**^^^ ^**Collection configuration files**^^^
-|**collectionConfig.xml**|''GSDL3HOME/sites/<site-name>/collect/<collname>/etc''|Collection design file. Greenstone3 equivalent to collect.cfg. Can be edited by hand, or is automatically generated by the GLI| +|**[[en:user:gs3_collection_configuration_files#collectionconfigxml |collectionConfig.xml]]**|''GSDL3HOME/sites/<site-name>/collect/<collname>/etc''|Collection design file. Greenstone3 equivalent to collect.cfg. Can be edited by hand, or is automatically generated by the GLI| 
-|**buildConfig.xml**|''GSDL3HOME/sites/<site-name>/collect/<collname>/index''|Generated automatically by collection building process. Greenstone3 equivalent to build.cfg. Includes build statistics, and information about indexes that have been built.|+|**[[en:user:gs3_collection_configuration_files#collectioninitxml |collectionInit.xml]]**|''GSDL3HOME/sites/<site-name>/collect/<collname>/etc''|If you want to use a custom Java class for the Collection object, it can be specified in this file.| 
 +|**[[en:user:gs3_collection_configuration_files#buildconfigxml | buildConfig.xml]]**|''GSDL3HOME/sites/<site-name>/collect/<collname>/index''|Generated automatically by collection building process. Greenstone3 equivalent to build.cfg. Includes build statistics, and information about indexes that have been built.|
 ^**Admin Configuration files**^^^ ^**Admin Configuration files**^^^
 |**build.xml**|''GSDL3SRCHOME''|Ant build file for compilation, installation and running Greenstone3.| |**build.xml**|''GSDL3SRCHOME''|Ant build file for compilation, installation and running Greenstone3.|
Line 30: Line 33:
  
  
-</TAB> +<tabbox Greenstone2>
-<!-- ##################################################################################### +
-######################################################################################### +
-####################################################################################### --> +
-<TAB> +
  
 ^**Server Configuration files**^^^ ^**Server Configuration files**^^^
Line 43: Line 41:
 |**oai.cfg**|GSDLHOME/etc|OAI server configuration file| |**oai.cfg**|GSDLHOME/etc|OAI server configuration file|
 ^**GLI Configuration files**^^^ ^**GLI Configuration files**^^^
-|**config.xml**|Linux: ''<USERHOME>/.gli'' Windows: ''C:\Documents and Settings\<username>\Application Data\Greenstone\GLI''|Configuration file for local GLI - stores settings such as library address, last collection open, warnings activated or deactivated etc.| +|**config.xml**|Linux: ''<USERHOME>/.gli'' \\ Windows: ''C:\Documents and Settings\<username>\Application Data\Greenstone\GLI''|Configuration file for local GLI - stores settings such as library address, last collection open, warnings activated or deactivated etc.| 
-|**configRemote.xml**|Linux: ''<USERHOME>/.gli'' Windows: ''C:\Documents and Settings\<username>\Application Data\Greenstone\GLI''|Separate version for use with GLI client. Basically the same os the local version, but includes gliserver address. Needed so that you can run a local GLI at the same time as running GLI with a remote library server.|+|**configRemote.xml**|Linux: ''<USERHOME>/.gli'' \\ Windows: ''C:\Documents and Settings\<username>\Application Data\Greenstone\GLI''|Separate version for use with GLI client. Basically the same as the local version, but includes gliserver address. Needed so that you can run a local GLI at the same time as running GLI with a remote library server.|
 ^**Collection configuration files**^^^ ^**Collection configuration files**^^^
-|** gli.col **|''GSDLHOME/collect/<collname>''|GLI configuration file specific to a collection. Includes information about whether the colleciton has been previously imported or built, and stores the import and build options specified in the Create panel for that collection.|+|** gli.col **|''GSDLHOME/collect/<collname>''|GLI configuration file specific to a collection. Includes information about whether the collection has been previously imported or built, and stores the import and build options specified in the Create panel for that collection.|
 |**collect.cfg**|''GSDLHOME/collect/<collname>/etc''|Collection design file. Can be edited by hand, or is automatically generated by the GLI| |**collect.cfg**|''GSDLHOME/collect/<collname>/etc''|Collection design file. Can be edited by hand, or is automatically generated by the GLI|
 |**build.cfg**|''GSDLHOME/collect/<collname>/index''|Generated automatically by collection building process. Includes build statistics, and information about indexes that have been built.| |**build.cfg**|''GSDLHOME/collect/<collname>/index''|Generated automatically by collection building process. Includes build statistics, and information about indexes that have been built.|
Line 53: Line 51:
  
  
-</TAB> +</tabbox>
-</TABAREA>+
  
 ===== Example collection configuration file ===== ===== Example collection configuration file =====
Line 60: Line 57:
 The collection configuration file (collectionConfig.xml for Greenstone 3, or collect.cfg for Greenstone 2) is the main file for customising the collection. The collection configuration file (collectionConfig.xml for Greenstone 3, or collect.cfg for Greenstone 2) is the main file for customising the collection.
  
-<TABAREA tabs="Greenstone3,Greenstone2"> +<tabbox Greenstone3>
-<TAB>+
 The collectionConfig.xml file should look something like the following,  The collectionConfig.xml file should look something like the following, 
 which shows the collection configuration file that was created by using the command ''perl —S mkcol.pl -site localsite —creator [email protected] dlpeople''. which shows the collection configuration file that was created by using the command ''perl —S mkcol.pl -site localsite —creator [email protected] dlpeople''.
Line 303: Line 299:
  
  
-</TAB> +<tabbox Greenstone2>
-<!-- ##################################################################################### +
-######################################################################################### +
-####################################################################################### --> +
-<TAB> +
  
 The collect.cfg file should look something like the following, The collect.cfg file should look something like the following,
Line 367: Line 358:
  
  
-</TAB> +</tabbox>
-</TABAREA>+
  
 ===== Sample Collection Configuration Files ===== ===== Sample Collection Configuration Files =====
Line 374: Line 364:
 The configuration files of some of the collections on [[http://www.nzdl.org]] are made available here. The configuration files of some of the collections on [[http://www.nzdl.org]] are made available here.
  
-<TABAREA tabs="Greenstone3,Greenstone2"> +<tabbox Greenstone3> 
-<TAB> +<tabbox Greenstone2>
-</TAB> +
-<TAB>+
 |[[http://www.nzdl.org/cgi-bin/library?a=p&amp;p=about&amp;c=acrodemo|Acronym Extraction Demo]] |[[http://www.nzdl.org/gsdl/collect/acrodemo/etc/collect.cfg|collect.cfg file]]| |[[http://www.nzdl.org/cgi-bin/library?a=p&amp;p=about&amp;c=acrodemo|Acronym Extraction Demo]] |[[http://www.nzdl.org/gsdl/collect/acrodemo/etc/collect.cfg|collect.cfg file]]|
 |[[http://www.nzdl.org/cgi-bin/library?a=p&amp;p=about&amp;c=aginfo|Agricultural Information Modules]] |[[http://www.nzdl.org/gsdl/collect/aginfo/etc/collect.cfg|collect.cfg file]]| |[[http://www.nzdl.org/cgi-bin/library?a=p&amp;p=about&amp;c=aginfo|Agricultural Information Modules]] |[[http://www.nzdl.org/gsdl/collect/aginfo/etc/collect.cfg|collect.cfg file]]|
Line 409: Line 397:
 |[[http://www.nzdl.org/cgi-bin/library?a=p&amp;p=about&amp;c=ohist|Youth Oral History]] |[[http://www.nzdl.org/gsdl/collect/ohist/etc/collect.cfg|collect.cfg file]]| |[[http://www.nzdl.org/cgi-bin/library?a=p&amp;p=about&amp;c=ohist|Youth Oral History]] |[[http://www.nzdl.org/gsdl/collect/ohist/etc/collect.cfg|collect.cfg file]]|
  
-</TAB></TABAREA>+</tabbox>
  
 ===== Additional Resources ===== ===== Additional Resources =====
  
-**Inside Greenstone Collections** +  * **[[http://files.greenstone.org/technical/inside_greenstone.pdf|Inside Greenstone Collections]]** (Greenstone 2, written for 2.40) This document presents and explains the configuration files for a few actual Greenstone collections, and also gives an example of how Greenstone's appearance can be customized. (Note, this document is intended to be used with Greenstone version 2.40 and higher.)
- +
-[[http://www.cs.waikato.ac.nz/~ihw/greenstone/inside.htm|English (HTML)]] [[http://www.greenstone.org/docs/inside_greenstone.pdf|English (PDF)]] +
- +
-The document presents and explains the configuration files for a few actual Greenstone collections, and also gives an example of how Greenstone's appearance can be customized. (Note, this document is intended to be used with Greenstone version 2.40 and higher.) +
  
en/user/configuration_files.1432693274.txt.gz · Last modified: 2017/03/08 21:20 (external edit)