root/gsdl/trunk/perllib/strings.properties @ 19014

Revision 19014, 73.1 KB (checked in by anna, 11 years ago)

Added several option descriptions for List classifier.

  • Property svn:keywords set to Author Date Id Revision
Line 
1#
2# Resource bundle description
3#
4
5Language.code:en
6Language.name:English
7
8OutputEncoding.unix:iso_8859_1
9OutputEncoding.windows:iso_8859_1
10
11
12#
13# Common output messages and strings
14#
15
16common.cannot_create_file:ERROR: Can't create file %s
17
18common.cannot_find_cfg_file:ERROR: Can't find the configuration file %s
19
20common.cannot_open:ERROR: Can't open %s
21
22common.cannot_open_fail_log:ERROR: Can't open fail log %s
23
24common.cannot_open_output_file:ERROR: Can't open output file %s
25
26common.cannot_read:ERROR: Can't read %s
27
28common.cannot_read_file:ERROR: Can't read file %s
29
30common.general_options:general options (for %s)
31
32common.must_be_implemented:function must be implemented in sub-class
33
34common.options:options
35
36common.processing:processing
37
38common.specific_options:specific options
39
40common.usage:Usage
41
42common.info:info
43
44common.invalid_options:Invalid arguments: %s
45
46common.true:true
47
48common.false:false
49
50common.deprecated: DEPRECATED
51#
52# Script option descriptions and output messages
53#
54
55scripts.language:Language to display option descriptions in (eg. 'en_US' specifies American English). Requires translations of the option descriptions to exist in the perllib/strings_language-code.rb file.
56
57scripts.xml:Produces the information in an XML form, without 'pretty' comments but with much more detail.
58
59scripts.listall:Lists all items known about.
60
61scripts.describeall:Display options for all items known about
62
63scripts.both_old_options:WARNING: -removeold was specified with -keepold or -incremental, defaulting to -removeold. Current contents of %s directory will be deleted.
64
65scripts.no_old_options:WARNING: None of -removeold, -keepold or -incremental were specified, defaulting to -removeold. Current contents of %s directory will be deleted.
66
67scripts.gli:A flag set when running this script from gli, enables output specific for gli.
68
69# -- buildcol.pl --
70
71buildcol.archivedir:Where the archives live.
72
73buildcol.builddir:Where to put the built indexes.
74
75buildcol.cachedir:Collection will be temporarily built here before being copied to the build directory.
76
77buildcol.cannot_open_cfg_file:WARNING: Can't open config file for updating: %s
78
79buildcol.collectdir:The path of the "collect" directory.
80
81buildcol.copying_back_cached_build:Copying back the cached build
82
83buildcol.create_images:Attempt to create default images for new collection. This relies on the Gimp being installed along with relevant perl modules to allow scripting from perl.
84
85buildcol.debug:Print output to STDOUT.
86
87buildcol.desc:PERL script used to build a greenstone collection from archive documents.
88
89buildcol.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed.
90
91buildcol.incremental_default_builddir:WARNING: The building directory has defaulted to 'building'. If you want to incrementally add to the index directory, please use the "-builddir index" option to buildcol.pl.
92
93buildcol.index:Index to build (will build all in config file if not set).
94
95buildcol.incremental:Only index documents which have not been previously indexed. Implies -keepold. Relies on the lucene indexer.
96
97buildcol.keepold:Will not destroy the current contents of the building directory.
98
99buildcol.maxdocs:Maximum number of documents to build.
100buildcol.maxnumeric:The maximum nuber of digits a 'word' can have in the index dictionary. Large numbers are split into several words for indexing. For example, if maxnumeric is 4, "1342663" will be split into "1342" and "663".
101buildcol.mode:The parts of the building process to carry out.
102buildcol.mode.all:Do everything.
103buildcol.mode.build_index:Just index the text.
104buildcol.mode.compress_text:Just compress the text.
105buildcol.mode.infodb:Just build the metadata database.
106
107buildcol.no_default_images:Default images will not be generated.
108
109buildcol.no_image_script:WARNING: Image making script could not be found: %s
110
111buildcol.no_strip_html:Do not strip the html tags from the indexed text (only used for mgpp collections).
112
113buildcol.no_text:Don't store compressed text. This option is useful for minimizing the size of the built indexes if you intend always to display the original documents at run time (i.e. you won't be able to retrieve the compressed text version).
114
115buildcol.sections_index_document_metadata:Index document level metadata at section level
116buildcol.sections_index_document_metadata.never:Don't index any document metadata at section level.
117buildcol.sections_index_document_metadata.always:Add all specified document level metadata even if section level metadata of that name exists.
118buildcol.sections_index_document_metadata.unless_section_metadata_exists:Only add document level metadata if no section level metadata of that name exists.
119
120buildcol.out:Filename or handle to print output status to.
121
122buildcol.params:[options] collection-name
123
124buildcol.remove_empty_classifications:Hide empty classifiers and classification nodes (those that contain no documents).
125
126buildcol.removeold:Will remove the old contents of the building directory.
127
128buildcol.unlinked_col_images:Collection images may not be linked correctly.
129
130buildcol.unknown_mode:Unknown mode: %s
131
132buildcol.updating_archive_cache:Updating archive cache
133
134buildcol.verbosity:Controls the quantity of output. 0=none, 3=lots.
135
136
137# -- classinfo.pl --
138
139classinfo.collection:Giving a collection name will make classinfo.pl look in collect/collection-name/perllib/classify first. If the classifier is not found there it will look in the general perllib/classify directory.
140
141classinfo.desc:Prints information about a classifier.
142
143classinfo.general_options:General options are inherited from parent classes of the classifier.
144
145classinfo.info:info
146
147classinfo.no_classifier_name:ERROR: You must provide a classifier name.
148
149classinfo.option_types:Classifiers may take two types of options
150
151classinfo.params:[options] classifier-name
152
153classinfo.passing_options:Options may be passed to any classifier by including them in your collect.cfg configuration file.
154
155classinfo.specific_options:Specific options are defined within the classifier itself, and are available only to this particular classifier.
156
157# -- downloadfrom.pl --
158downloadfrom.cache_dir:The location of the cache directory
159downloadfrom.desc:Downloads files from an external server
160downloadfrom.download_mode:The type of server to download from
161downloadfrom.download_mode.Web:HTTP 
162downloadfrom.download_mode.MediaWiki:MediaWiki website
163downloadfrom.download_mode.OAI: Open Archives Initiative
164downloadfrom.download_mode.z3950:z3950 server
165downloadfrom.download_mode.SRW:SearchRetrieve Webservice
166downloadfrom.incorrect_mode:download_mode parameter was incorrect.
167downloadfrom.info:Print information about the server, rather than downloading
168downloadfrom.params:[general options] [specific download options]
169
170# -- downloadinfo.pl --
171
172downloadinfo.desc:Prints information about a download module
173downloadinfo.collection:Giving a collection name will make downloadinfo.pl look in collect/collection-name/perllib/downloaders first. If the module is not found there it will look in the general perllib/downloaders directory.
174downloadinfo.params:[options] [download-module]
175downloadinfo.general_options:General options are inherited from parent classes of the download modules.
176downloadinfo.specific_options:Specific options are defined within the download module itself, and are available only to this particular downloader.
177downloadinfo.option_types:Download modules may take two types of options
178
179# -- explode_metadata_database.pl --
180explode.desc:Explode a metadata database
181
182explode.collection:The collection name. Some plugins look for auxiliary files in the collection folder.
183 
184explode.document_field:The metadata element specifying the file name of documents to obtain and include in the collection.
185
186explode.document_prefix:A prefix for the document locations (for use with the document_field option).
187
188explode.document_suffix:A suffix for the document locations (for use with the document_field option).
189
190explode.encoding:Encoding to use when reading in the database file
191explode.metadata_set:Metadata set (namespace) to export all metadata as
192explode.plugin: Plugin to use for exploding
193explode.plugin_options:Options to pass to the plugin before exploding. Option nmaes must start with -. Separate option names and values with space. Cannot be used with -use_collection_plugin_options.
194explode.use_collection_plugin_options: Read the collection configuration file and use the options for the specified plugin. Requires the -collection option. Cannot be used with -plugin_options.
195explode.params: [options] filename
196explode.records_per_folder: The number of records to put in each subfolder.
197
198# -- replace_srcdoc_with_html.pl --
199srcreplace.desc: Replace source document with the generated HTML file when rebuilding
200srcreplace.params: [options] filename
201srcreplace.plugin: Plugin to use for converting the source document
202
203# -- exportcol.pl --
204
205exportcol.out:Filename or handle to print output status to.
206exportcol.cddir:The name of the directory that the CD contents are exported to.
207exportcol.cdname:The name of the CD-ROM -- this is what will appear in the start menu once the CD-ROM is installed.
208exportcol.desc:PERL script used to export one or more collections to a Windows CD-ROM.
209exportcol.noinstall:Create a CD-ROM where the library runs directly off the CD-ROM and nothing is installed on the host computer.
210exportcol.params:[options] collection-name1 collection-name2 ...
211exportcol.coll_not_found:Ignoring invalid collection %s: collection not found at %s.
212exportcol.coll_dirs_not_found:Ignoring invalid collection %s: one of the following directories not found:
213exportcol.fail:exportcol.pl failed:
214exportcol.no_valid_colls:No valid collections specified to export.
215exportcol.couldnt_create_dir:Could not create directory %s.
216exportcol.couldnt_create_file:Could not create %s.
217exportcol.instructions:To create a self-installing Windows CD-ROM, write the contents of this folder out to a CD-ROM.
218exportcol.non_exist_files:One or more of the following necessary files and directories does not exist:
219exportcol.success:exportcol.pl succeeded:
220exportcol.output_dir:The exported collections (%s) are in %s.
221exportcol.export_coll_not_installed:The Export to CD-ROM functionality has not been installed.
222
223# -- import.pl --
224
225import.archivedir:Where the converted material ends up.
226
227import.manifest:An XML file that details what files are to be imported. Used instead of recursively descending the import folder, typically for incremental building.
228
229import.cannot_open_stats_file:WARNING: Couldn't open stats file %s.
230
231import.cannot_open_fail_log:ERROR: Couldn't open fail log %s
232
233import.cannot_sort:WARNING: import.pl cannot sort documents when groupsize > 1. sortmeta option will be ignored.
234
235import.collectdir:The path of the "collect" directory.
236
237import.complete:Import complete
238
239import.debug:Print imported text to STDOUT (for GreenstoneXML importing)
240
241import.desc:PERL script used to import files into a format (GreenstoneXML or GreenstoneMETS) ready for building.
242
243import.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed.
244
245import.groupsize:Number of import documents to group into one XML file.
246
247import.gzip:Use gzip to compress resulting xml documents (don't forget to include ZIPPlugin in your plugin list when building from compressed documents).
248
249import.importdir:Where the original material lives.
250
251import.incremental:Only import documents which are newer (by timestamp) than the current archives files. Implies -keepold.
252
253import.keepold:Will not destroy the current contents of the archives directory.
254
255import.maxdocs:Maximum number of documents to import.
256
257import.no_import_dir:Error: Import dir (%s) not found.
258
259import.no_plugins_loaded:ERROR: No plugins loaded.
260
261import.OIDtype:The method to use when generating unique identifiers for each document.
262import.OIDtype.hash:Hash the contents of the file. Document identifiers will be the same every time the collection is imported.
263
264import.OIDtype.incremental:Use a simple document count. Significantly faster than "hash", but does not assign the same identifier to the same document content, and further documents cannot be added to existing archives.
265
266import.OIDtype.assigned:Use the metadata value given by the OIDmetadata option (preceded by 'D'); if unspecified, for a particular document a hash is used instead. These identifiers should be unique.
267
268import.OIDtype.dirname:Use the parent directory name (preceded by 'J'). There should only be one document per directory, and directory names should be unique. E.g. import/b13as/h15ef/page.html will get an identifier of Jh15ef.
269
270import.OIDmetadata:Specifies the metadata element that hold's the document's unique identifier, for use with -OIDtype=assigned.
271
272import.saveas:Format that the archive files should be saved as.
273
274import.out:Filename or handle to print output status to.
275
276import.params:[options] collection-name
277
278import.removeold:Will remove the old contents of the archives directory.
279
280import.removing_archives:Removing current contents of the archives directory...
281
282import.removing_tmpdir:Removing contents of the collection "tmp" directory...
283
284import.reversesort:Sort in reverse order. Used with the -sortmeta option.
285
286import.site:Site to find collect directory in (for Greenstone 3 installation).
287
288import.sortmeta:Sort documents alphabetically by metadata for building. Search results for boolean queries will be displayed in this order. This will be disabled if groupsize > 1. May be a commma separated list to sort by more than one metadata value.
289
290import.statsfile:Filename or handle to print import statistics to.
291
292import.stats_backup:Will print stats to STDERR instead.
293
294import.verbosity:Controls the quantity of output. 0=none, 3=lots.
295
296# -- schedule.pl --
297schedule.deleted:Scheduled execution deleted for collection
298schedule.scheduled:Execution script created for collection
299schedule.cron:Scheduled execution set up for collection
300schedule.params:[options]
301schedule.error.email:-email requires -smtp -toaddr and -fromaddr to be specified.
302schedule.error.importbuild:-import and -build must be specified.
303schedule.error.colname:Collection using -colname must be specified.
304schedule.gli:Running from the GLI
305schedule.frequency:How often to automatically re-build the collection
306schedule.frequency.hourly:Re-build every hour
307schedule.frequency.daily:Re-build every day
308schedule.frequency.weekly:Re-build every week
309schedule.action:How to set up automatic re-building
310schedule.action.add:Schedule automatic re-building
311schedule.action.update:Update existing scheduling
312schedule.action.delete:Delete existing scheduling
313schedule.email:Send email notification
314schedule.schedule:Select to set up scheduled automatic collection re-building
315schedule.colname:The colletion name for which scheduling will be set up
316schedule.import:The import command to be scheduled
317schedule.build:The buildcol command to be scheduled
318schedule.toaddr:The email address to send scheduled build notifications to
319schedule.toaddr.default:Specify User's Email in File->Preferences
320schedule.fromaddr:The sender email address
321schedule.fromaddr.default:Specify maintainer in main.cfg
322schedule.smtp:The mail server that sendmail must contact to send email
323schedule.smtp.default:Specify MailServer in main.cfg
324schedule.out:Filename or handle to print output status to.
325# -- export.pl --
326
327export.exportdir:Where the export material ends up.
328
329export.cannot_open_stats_file:WARNING: Couldn't open stats file %s.
330
331export.cannot_open_fail_log:ERROR: Couldn't open fail log %s
332
333export.cannot_sort:WARNING: export.pl cannot sort documents when groupsize > 1. sortmeta option will be ignored.
334
335export.collectdir:The path of the "collect" directory.
336
337export.complete:Export complete
338
339export.debug:Print exported text to STDOUT (for GreenstoneXML exporting)
340
341export.desc:PERL script used to export files in a Greenstone collection to another format.
342
343export.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed. (Default: collectdir/collname/etc/fail.log)
344
345export.groupsize:Number of documents to group into one XML file.
346
347export.gzip:Use gzip to compress resulting xml documents (don't forget to include ZIPPlugin in your plugin list when building from compressed documents).
348
349export.importdir:Where the original material lives.
350
351export.keepold:Will not destroy the current contents of the export directory.
352
353export.maxdocs:Maximum number of documents to export.
354
355export.listall:List all the saveas formats
356
357export.saveas:Format to export documents as.
358
359export.saveas.DSpace:DSpace Archive format.
360
361export.saveas.GreenstoneMETS:METS format using the Greenstone profile.
362export.saveas.FedoraMETS:METS format using the Fedora profile.
363
364export.saveas.GreenstoneXML:Greenstone XML Archive format
365
366export.saveas.MARCXML:MARC XML format (an XML version of MARC 21)
367
368export.out:Filename or handle to print output status to.
369
370export.params:[options] collection-name
371
372export.removeold:Will remove the old contents of the export directory.
373
374export.removing_export:Removing current contents of the export directory...
375
376export.sortmeta:Sort documents alphabetically by metadata for building. This will be disabled if groupsize > 1.
377
378export.statsfile:Filename or handle to print export statistics to.
379
380export.stats_backup:Will print stats to STDERR instead.
381
382export.verbosity:Controls the quantity of output. 0=none, 3=lots.
383
384
385
386# -- mkcol.pl --
387
388mkcol.about:The about text for the collection.
389
390mkcol.bad_name_cvs:ERROR: No collection can be named CVS as this may interfere with directories created by the CVS versioning system.
391
392mkcol.bad_name_svn:ERROR: No collection can be named .svn as this may interfere with directories created by the SVN versioning system.
393
394mkcol.bad_name_modelcol:ERROR: No collection can be named modelcol as this is the name of the model collection.
395
396mkcol.cannot_find_modelcol:ERROR: Cannot find the model collection %s
397
398mkcol.col_already_exists:ERROR: This collection already exists.
399
400mkcol.collectdir:Directory where new collection will be created.
401
402mkcol.group_not_valid_in_gs3:The group option is not valid in Greenstone 3 mode (-gs3mode).
403mkcol.creating_col:Creating the collection %s
404
405mkcol.creator:The collection creator's e-mail address.
406
407mkcol.creator_undefined:ERROR: The creator was not defined. This variable is needed to recognise duplicate collection names.
408
409mkcol.desc:PERL script used to create the directory structure for a new Greenstone collection.
410
411mkcol.doing_replacements:doing replacements for %s
412
413mkcol.group:Create a new collection group instead of a standard collection.
414
415mkcol.gs3mode:Mode for Greenstone 3 collections.
416
417mkcol.long_colname:ERROR: The collection name must be less than 8 characters so compatibility with earlier filesystems can be maintained.
418
419mkcol.maintainer:The collection maintainer's email address (if different from the creator).
420
421mkcol.no_collectdir:ERROR: The collect dir doesn't exist: %s
422
423mkcol.no_collectdir_specified:ERROR: No collect dir was specified. In gs3mode, either the -site or -collectdir option must be specified.
424
425mkcol.no_colname:ERROR: No collection name was specified.
426
427mkcol.optionfile:Get options from file, useful on systems where long command lines may cause problems.
428
429mkcol.params:[options] collection-name
430
431mkcol.plugin:Perl plugin module to use (there may be multiple plugin entries).
432
433mkcol.public:If this collection has anonymous access.
434mkcol.public.true:Collection is public
435mkcol.public.false:Collection is private
436
437mkcol.quiet:Operate quietly.
438
439mkcol.site:In gs3mode, uses this site name with the GSDL3HOME environment variable to determine collectdir, unless -collectdir is specified.
440
441mkcol.success:The new collection was created successfully at %s
442
443mkcol.title:The title of the collection.
444
445mkcol.win31compat:Whether or not the named collection directory must conform to Windows 3.1 file conventions or not (i.e. 8 characters long).
446mkcol.win31compat.true:Directory name 8 characters or less
447mkcol.win31compat.false:Directory name any length
448
449# -- pluginfo.pl --
450
451pluginfo.collection:Giving a collection name will make pluginfo.pl look in collect/collection-name/perllib/plugins first. If the plugin is not found there it will look in the general perllib/plugins directory.
452
453pluginfo.desc:Prints information about a plugin.
454
455pluginfo.general_options:General options are inherited from parent classes of the plugin.
456
457pluginfo.info:info
458
459pluginfo.no_plugin_name:ERROR: You must provide a plugin name.
460
461pluginfo.option_types:Plugins may take two types of options
462
463pluginfo.params:[options] plugin-name
464
465pluginfo.passing_options:Options may be passed to any plugin by including them in your collect.cfg configuration file.
466
467pluginfo.specific_options:Specific options are defined within the plugin itself, and are available only to this particular plugin.
468
469
470# -- plugoutinfo.pl --
471
472plugoutinfo.collection:Giving a collection name will make plugoutinfo.pl look in collect/collection-name/perllib/plugouts first. If the plugout is not found there it will look in the general perllib/plugouts directory.
473
474plugoutinfo.desc:Prints information about a plugout.
475
476plugoutinfo.general_options:General options are inherited from parent classes of the plugout.
477
478plugoutinfo.info:info
479
480plugoutinfo.no_plugout_name:ERROR: You must provide a plugout name.
481
482plugoutinfo.option_types:Plugouts may take two types of options
483
484plugoutinfo.params:[options] plugout-name
485
486plugoutinfo.passing_options:Options may be passed to any plugout by including them in your collect.cfg configuration file.
487
488plugoutinfo.specific_options:Specific options are defined within the plugout itself, and are available only to this particular plugout.
489
490
491
492#
493# Classifier option descriptions
494#
495
496AllList.desc:Creates a single list of all documents. Use by the oaiserver.
497
498AZCompactList.allvalues:Use all metadata values found.
499
500AZCompactList.desc:Classifier plugin for sorting alphabetically (on a-zA-Z0-9). Produces a horizontal A-Z list, then a vertical list containing documents, or bookshelves for documents with common metadata.
501
502AZCompactList.doclevel:Level to process document at.
503AZCompactList.doclevel.top:Whole document.
504AZCompactList.doclevel.section:By sections.
505
506AZCompactList.firstvalueonly:Use only the first metadata value found.
507
508AZCompactList.freqsort:Sort by node frequency rather than alpha-numeric.
509
510AZCompactList.maxcompact:Maximum number of documents to be displayed per page.
511
512AZCompactList.metadata:A single Metadata field, or a comma separated list of Metadata fields, used for classification. If a list is specified, the first metadata type that has values will be used. May be used in conjunction with the -firstvalueonly and -allvalues flags, to select only the first value, or all metadata values from the list.
513
514AZCompactList.mincompact:Minimum number of documents to be displayed per page.
515
516AZCompactList.mingroup:The smallest value that will cause a group in the hierarchy to form.
517
518AZCompactList.minnesting:The smallest value that will cause a list to be converted into a nested list.
519
520AZCompactList.recopt:Used in nested metadata such as -metadata Year/Organisation.
521AZCompactList.sort:Metadata field to sort the leaf nodes by.
522
523AZCompactSectionList.desc:Variation on AZCompactList that classifies sections rather than documents. Entries are sorted by section-level metadata.
524
525AZList.desc:Classifier plugin for sorting alphabetically (on a-zA-Z0-9). Produces a horizontal A-Z list, with documents listed underneath.
526
527AZList.metadata:A single Metadata field or a comma separated list of Metadata fields used for classification. Following the order indicated by the list, the first field that contains a Metadata value will be used. List will be sorted by this element.
528
529AZSectionList.desc:Variation on AZList that classifies sections rather that documents. Entries are sorted by section-level metadata.
530
531BasClas.bad_general_option:The %s classifier uses an incorrect option. Check your collect.cfg configuration file.
532
533BasClas.builddir:Where to put the built indexes.
534
535BasClas.buttonname:The label for the classifier screen and button in navigation bar. The default is the metadata element specified with -metadata.
536
537BasClas.desc:Base class for all the classifiers.
538
539BasClas.no_metadata_formatting:Don't do any automatic metadata formatting (for sorting.)
540
541BasClas.outhandle:The file handle to write output to.
542
543BasClas.removeprefix:A prefix to ignore in metadata values when sorting.
544
545BasClas.removesuffix:A suffix to ignore in metadata values when sorting.
546
547BasClas.verbosity:Controls the quantity of output. 0=none, 3=lots.
548
549Browse.desc:A fake classifier that provides a link in the navigation bar to a prototype combined browsing and searching page. Only works for mgpp collections, and is only practical for small collections.
550
551DateList.bymonth:Classify by year and month instead of only year.
552
553DateList.desc:Classifier plugin for sorting by date. By default, sorts by 'Date' metadata. Dates are assumed to be in the form yyyymmdd or yyyy-mm-dd.
554
555DateList.metadata:The metadata that contains the dates to classify by. The format is expected to be yyyymmdd or yyyy-mm-dd. Can be a comma separated list, in which case the first date found will be used.
556
557DateList.reverse_sort:Sort the documents in reverse chronological order (newest first).
558
559DateList.nogroup:Make each year an individual entry in the horizontal list, instead of spanning years with few entries. (This can also be used with the -bymonth option to make each month a separate entry instead of merging).
560
561DateList.no_special_formatting:Don't display Year and Month information in the document list.
562
563DateList.sort:An extra metadata field to sort by in the case where two documents have the same date.
564
565GenericList.classify_sections:Classify sections instead of documents.
566GenericList.desc:A general and flexible list classifier with most of the abilities of AZCompactList, but with better Unicode, metadata and sorting capabilities.
567GenericList.metadata:Metadata fields used for classification. Use '/' to separate the levels in the hierarchy and ';' to separate metadata fields within each level.
568GenericList.partition_name_length:The length of the partition name; defaults to a variable length from 1 up to 3 characters, depending on how many are required to distinguish the partition start from its end. This option only applies when partition_type_within_level is set to 'constant_size'.
569GenericList.partition_size_within_level:The number of items in each partition (only applies when partition_type_within_level is set to 'constant_size').
570GenericList.partition_type_within_level:The type of partitioning done: either 'per_letter', 'constant_size', or 'none'.
571GenericList.sort_leaf_nodes_using:Metadata fields used for sorting the leaf nodes. Use '|' to separate the metadata groups to stable sort and ';' to separate metadata fields within each group.
572GenericList.sort_using_unicode_collation:Sort using the Unicode Collation Algorithm. Requires http://www.unicode.org/Public/UCA/latest/allkeys.txt file to be downloaded into perl's lib/Unicode/Collate folder.
573GenericList.use_hlist_for:Metadata fields to use a hlist rather than a vlist. Use ',' to separate the metadata groups and ';' to separate the metadata fields within each group.
574
575HFileHierarchy.desc:Classifier plugin for generating hierarchical classifications based on a supplementary structure file.
576
577Hierarchy.desc:Classifier plugin for generating a hierarchical classification. This may be based on structured metadata, or may use a supplementary structure file (use the -hfile option).
578
579Hierarchy.documents_last:Display document nodes after classifier nodes.
580
581Hierarchy.hfile:Use the specified classification structure file.
582
583Hierarchy.hlist_at_top:Display the first level of the classification horizontally.
584
585Hierarchy.reverse_sort:Sort leaf nodes in reverse order (use with -sort).
586
587Hierarchy.separator:Regular expression used for the separator, if using structured metadata.
588
589Hierarchy.sort:Metadata field to sort leaf nodes by. Leaves will not be sorted if not specified.
590
591Hierarchy.suppressfirstlevel:Ignore the first part of the metadata value. This is useful for metadata where the first element is common, such as the import directory in gsdlsourcefilename.
592
593Hierarchy.suppresslastlevel:Ignore the final part of the metadata value. This is useful for metadata where each value is unique, such as file paths.
594
595HTML.desc:Creates an empty classification that's simply a link to a web page.
596
597HTML.url:The url of the web page to link to.
598
599List.bookshelf_type.always:Create a bookshelf icon even if there is only one item in each group at the leaf nodes.
600List.bookshelf_type.never:Never create a bookshelf icon even if there are more than one item in each group at the leaf nodes.
601List.bookshelf_type.duplicate_only:Create a bookshelf icon only when there are more than one item in each group at the leaf nodes.
602
603List.desc:Simple list classifier plugin.
604
605List.level_partition.per_letter:Create a partition for each letter.
606List.level_partition.constant_size:Create partition with constant size.
607List.level_partition.per_letter_fixed_size:Create a partition per letter with approximately fixed size.
608
609List.metadata:A single Metadata field or a comma separated list of Metadata fields used for classification. Following the order indicated by the list, the first field that contains a Metadata value will be used. List will be sorted by this element, unless -sort is used. If no metadata is specified, then all documents will be included in the list, otherwise only documents that contain a metadata value will be included.
610
611List.sort:Metadata field to sort by. Use '-sort nosort' for no sorting.
612
613Phind.desc:Produces a hierarchy of phrases found in the text, which is browsable via an applet.
614
615Phind.language:Language or languages to use building hierarchy. Languages are identified by two-letter country codes like en (English), es (Spanish), and fr (French). Language is a regular expression, so 'en|fr' (English or French) and '..' (match any language) are valid.
616
617Phind.min_occurs:The minimum number of times a phrase must appear in the text to be included in the phrase hierarchy.
618
619Phind.savephrases:If set, the phrase infomation will be stored in the given file as text. It is probably a good idea to use an absolute path.
620
621Phind.suffixmode:The smode parameter to the phrase extraction program. A value of 0 means that stopwords are ignored, and of 1 means that stopwords are used.
622
623Phind.text:The text used to build the phrase hierarchy.
624
625Phind.thesaurus:Name of a thesaurus stored in Phind format in the collection's etc directory.
626
627Phind.title:The metadata field used to describe each document.
628
629Phind.untidy:Don't remove working files.
630
631RecentDocumentsList.desc:Classifier that gives a list of newly added or modified documents.
632
633RecentDocumentsList.include_docs_added_since:Include only documents modified or added after the specified date (in yyyymmdd or yyyy-mm-dd format).
634
635RecentDocumentsList.include_most_recently_added:Include only the specified number of most recently added documents. Only used if include_docs_added_since is not specified.
636
637RecentDocumentsList.sort:Metadata to sort List by. If not specified, list will be sorted by date of modification/addition.
638
639SectionList.desc:Same as List classifier but includes all sections of document (excluding top level) rather than just top level document itself.
640
641Collage.desc:An applet is used to display a collage of images found in the collection.
642
643Collage.geometry:The dimensions of the Collage canvas. For a canvas 600 pixels wide by 400 pixels high, for example, specify geometry as 600x400
644
645Collage.maxDepth:Images for collaging are drawn from mirroring the underlying browse classifier. This controls the maximum depth of the mirroring process.
646
647Collage.maxDisplay:The maximum number of images to show in the collage at any one time.
648
649Collage.imageType:Used to control, by expressing file name extensions, which file types are used in the collage.  A list of file name extensions is separated by the percent (%%) symbol.
650
651Collage.bgcolor:The background color of the collage canvas, specified in hexadecimal form (for example #008000 results in a forest green background).
652
653Collage.buttonname:The label for the classifier screen and button in navigation bar.
654
655Collage.refreshDelay:Rate, in milliseconds, that the collage canvas is refreshed.
656
657Collage.isJava2:Used to control which run-time classes of Java are used. More advanced version of Java (i.e. Java 1.2 onwards) include more sophisticated support for controlling transparency in images, this flag helps control what happens, however the built-in Java runtime for some browsers is version 1.1.  The applet is designed to, by default, auto-detect which version of Java the browser is running and act accordingly.
658
659Collage.imageMustNotHave:Used to suppress images that should not appear in the collage, such as image buttons that make up the navigation bar.
660
661Collage.caption:Optional captions to display below the collage canvas.
662
663
664#
665# Plugin option descriptions
666#
667AcronymExtractor.adding:adding
668
669AcronymExtractor.already_seen:already seen
670
671AcronymExtractor.desc:Helper extractor plugin for location and marking up acronyms in text.
672
673AcronymExtractor.done_acronym_extract:done extracting acronyms.
674
675AcronymExtractor.done_acronym_markup:done acronym markup.
676
677AcronymExtractor.extract_acronyms:Extract acronyms from within text and set as metadata.
678
679AcronymExtractor.extracting_acronyms:extracting acronyms
680
681AcronymExtractor.marking_up_acronyms:marking up acronyms
682
683AcronymExtractor.markup_acronyms:Add acronym metadata into document text.
684
685ArchivesInfPlugin.desc:Plugin which reads through an archives.inf file (i.e. the file generated in the archives directory when an import is done), processing each file it finds.
686
687AutoExtractMetadata.desc: Base plugin that brings together all the extractor functionality from the Extractor plugins.
688
689AutoExtractMetadata.extracting:extracting
690
691AutoExtractMetadata.first:Comma separated list of first sizes to extract from the text into a metadata field. The field is called 'FirstNNN'.
692
693BaseMediaConverter.desc:Helper plugin that provides base functionality for media converter plugins such as ImageConverter and video converters.
694
695BasePlugin.associate_ext:Causes files with the same root filename as the document being processed by the plugin AND a filename extension from the comma separated list provided by this argument to be associated with the document being processed rather than handled as a separate list.
696
697BasePlugin.associate_tail_re:A regular expression to match filenames against to find associated files. Used as a more powerful alternative to associate_ext.
698
699BasePlugin.block_exp:Files matching this regular expression will be blocked from being passed to any later plugins in the list. This has no real effect other than to prevent lots of warning messages about input files you don't care about. Each plugin might have a default block_exp. e.g. by default HTMLPlugin blocks any files with .gif, .jpg, .jpeg, .png or .css file extensions.
700
701BasePlugin.desc:Base class for all the import plugins.
702
703BasePlugin.dummy_text:This document has no text.
704
705BasePlugin.encoding.ascii:Plain 7 bit ascii. This may be a bit faster than using iso_8859_1. Beware of using this when the text may contain characters outside the plain 7 bit ascii set though (e.g. German or French text containing accents), use iso_8859_1 instead.
706
707BasePlugin.encoding.unicode:Just unicode.
708
709BasePlugin.encoding.utf8:Either utf8 or unicode -- automatically detected.
710
711BasePlugin.filename_encoding:The encoding of the source file filenames.
712
713BasePlugin.filename_encoding.auto:Automatically detect the encoding of the filename.
714
715BasePlugin.filename_encoding.auto_language_analysis:Auto-detect the encoding of the filename by analysing it.
716
717BasePlugin.filename_encoding.auto_filesystem_encoding:Auto-detect the encoding of the filename using filesystem encoding.
718
719BasePlugin.filename_encoding.auto_fl:Uses filesystem encoding then language analysis to detect the filename encoding.
720
721BasePlugin.filename_encoding.auto_lf:Uses language analysis then filesystem encoding to detect the filename encoding.
722
723BasePlugin.no_blocking:Don't do any file blocking. Any associated files (e.g. images in a web page) will be added to the collection as documents in their own right.
724
725BasePlugin.no_cover_image:Do not look for a prefix.jpg file (where prefix is the same prefix as the file being processed) and associate it as a cover image.
726
727BasePlugin.OIDtype.auto:Use OIDtype set in import.pl
728
729BasePlugin.process_exp:A perl regular expression to match against filenames. Matching filenames will be processed by this plugin. For example, using '(?i).html?\$' matches all documents ending in .htm or .html (case-insensitive).
730
731BasePlugin.smart_block:Block files in a smarter way than just looking at filenames.
732
733BasePlugin.stems:stems
734
735BasePlugin.file_rename_method:The method to be used in renaming the copy of the imported file and associated files.
736
737BasePlugin.rename_method.url:Use url encoding in renaming imported files and associated files.
738
739BasePlugin.rename_method.base64:Use base64 encoding in renaming imported files and associated files.
740
741BasePlugin.rename_method.none:Don't rename imported files and associated files.
742
743BibTexPlugin.desc:BibTexPlugin reads bibliography files in BibTex format. BibTexPlugin creates a document object for every reference in the file. It is a subclass of SplitTextFile, so if there are multiple records, all are read.
744
745BookPlugin.desc:Creates multi-level document from document containing <<TOC>> level tags. Metadata for each section is taken from any other tags on the same line as the <<TOC>>. e.g. <<Title>>xxxx<</Title>> sets Title metadata. Everything else between TOC tags is treated as simple html (i.e. no processing of html links or any other HTMLPlugin type stuff is done). Expects input files to have a .hb file extension by default (this can be changed by adding a -process_exp option a file with the same name as the hb file but a .jpg extension is taken as the cover image (jpg files are blocked by this plugin). BookPlugin is a simplification (and extension) of the HBPlugin used by the Humanity Library collections. BookPlugin is faster as it expects the input files to be cleaner (The input to the HDL collections contains lots of excess html tags around <<TOC>> tags, uses <<I>> tags to specify images, and simply takes all text between <<TOC>> tags and start of text to be Title metadata). If you're marking up documents to be displayed in the same way as the HDL collections, use this plugin instead of HBPlugin.
746
747CONTENTdmPlugin.desc:Plugin that processes RDF files in exported CONTENTdm collections.
748
749ConvertBinaryFile.apply_fribidi:Run the "fribidi" Unicode Bidirectional Algorithm program over the converted file (for right-to-left text).
750
751ConvertBinaryFile.convert_to:Plugin converts to TEXT or HTML or various types of Image (e.g. JPEG, GIF, PNG).
752
753ConvertBinaryFile.convert_to.auto:Automatically select the format converted too.  Format chosen depends on input document type, for example Word will automatically be converted to HTML, whereas PowerPoint will be converted to Greenstone's PagedImage format.
754
755ConvertBinaryFile.convert_to.html:HTML format.
756
757ConvertBinaryFile.convert_to.text:Plain text format.
758
759ConvertBinaryFile.convert_to.pagedimg:A series of images.
760
761ConvertBinaryFile.convert_to.pagedimg_jpg:A series of images in JPEG format.
762
763ConvertBinaryFile.convert_to.pagedimg_gif:A series of images in GIF format.
764
765ConvertBinaryFile.convert_to.pagedimg_png:A series of images in PNG format.
766
767ConvertBinaryFile.desc:This plugin is inherited by such plugins as WordPlugin, PowerPointPlugin, PostScriptPlugin, RTFPlugin and PDFPlugin. It facilitates the conversion of these document types to either HTML, TEXT or a series of images. It works by dynamically loading an appropriate secondary plugin (HTMLPlugin, StructuredHTMLPlugin, PagedImagePlugin or TextPlugin) based on the plugin argument 'convert_to'.
768
769ConvertBinaryFile.keep_original_filename:Keep the original filename for the associated file, rather than converting to doc.pdf, doc.doc etc.
770
771ConvertBinaryFile.use_strings:If set, a simple strings function will be called to extract text if the conversion utility fails.
772
773ConvertToRogPlugin.desc:A plugin that inherits from RogPlugin.
774
775CSVPlugin.desc:A plugin for files in comma-separated value format. A new document will be created for each line of the file.
776
777DateExtractor.desc:Helper extractor plugin for extracting historical date information from text.
778
779DateExtractor.extract_historical_years:Extract time-period information from historical documents.  This is stored as metadata with the document. There is a search interface for this metadata, which you can include in your collection by adding the statement, "format QueryInterface DateSearch" to your collection configuration file.
780
781DateExtractor.maximum_century:The maximum named century to be extracted as historical metadata (e.g. 14 will extract all references up to the 14th century).
782
783DateExtractor.maximum_year:The maximum historical date to be used as metadata (in a Common Era date, such as 1950).
784
785DateExtractor.no_bibliography:Do not try to block bibliographic dates when extracting historical dates.
786
787DirectoryPlugin.desc:A plugin which recurses through directories processing each file it finds.
788
789DirectoryPlugin.recheck_directories:After the files in an import directory have been processed, re-read the directory to discover any new files created.
790
791DirectoryPlugin.use_metadata_files:(DEPRECATED - Add MetadataXMLPlugin to the list of plugins instead) Read metadata from metadata XML files.
792
793DatabasePlugin.desc:A plugin that imports records from a database. This uses perl's DBI module, which includes back-ends for mysql, postgresql, comma separated values (CSV), MS Excel, ODBC, sybase, etc... Extra modules may need to be installed to use this. See <GSDLHOME>/etc/packages/example.dbi for an example config file.
794
795DSpacePlugin.desc:A plugin that takes a collection of documents exported from DSpace and imports them into Greenstone.
796   
797DSpacePlugin.first_inorder_ext: This is used to identify the primary stream of DSpace collection document. With this option, the system will treat the defined ext types of document in sequence to look for the possible primary stream.
798
799DSpacePlugin.first_inorder_mime:This is used to identify the primary data stream of DSpace collection document.With this option, the system will treat the defined mime types of document in sequence to look for the possible primary stream.
800
801DSpacePlugin.only_first_doc:This is used to identify the primary data stream of DSpace collection document.With this option, the system will treat the first document in dublic_core metadata file as the possible primary stream.
802
803EmailAddressExtractor.desc:Helper extractor plugin for discovering email addresses in text.
804
805EmailAddressExtractor.done_email_extract:done extracting e-mail addresses.
806
807EmailAddressExtractor.extracting_emails:extracting e-mail addresses
808
809EmailAddressExtractor.extract_email:Extract email addresses as metadata.
810
811EmailPlugin.desc:A plugin that reads email files.  These are named with a simple number (i.e. as they appear in maildir folders) or with the extension .mbx (for mbox mail file format).\nDocument text: The document text consists of all the text after the first blank line in the document.\nMetadata (not Dublin Core!):\n\t\$Headers      All the header content (optional, not stored by default)\n\t\$Subject      Subject: header\n\t\$To           To: header\n\t\$From         From: header\n\t\$FromName     Name of sender (where available)\n\t\$FromAddr     E-mail address of sender\n\t\$DateText     Date: header\n\t\$Date         Date: header in GSDL format (eg: 19990924)
812
813EmailPlugin.no_attachments:Do not save message attachments.
814
815EmailPlugin.headers:Store email headers as "Headers" metadata.
816
817EmailPlugin.OIDtype.message_id:Use the message identifier as the document OID. If no message identifier is found, then will use a hash OID.
818
819EmailPlugin.split_exp:A perl regular expression used to split files containing many messages into individual documents.
820
821ExcelPlugin.desc:A plugin for importing Microsoft Excel files (versions 95 and 97).
822
823FavouritesPlugin.desc:Plugin to process Internet Explorer Favourites files.
824
825FOXPlugin.desc:Plugin to process a Foxbase dbt file. This plugin provides the basic functionality to read in the dbt and dbf files and process each record. This general plugin should be overridden for a particular database to process the appropriate fields in the file.
826
827GreenstoneXMLPlugin.desc:Processes Greenstone Archive XML documents. Note that this plugin does no syntax checking (though the XML::Parser module tests for well-formedness). It's assumed that the Greenstone Archive files conform to their DTD.
828
829GISExtractor.desc:Helper extractor plugin for extracting placenames from text. Requires GIS extension to Greenstone.
830
831GISExtractor.extract_placenames:Extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
832
833GISExtractor.gazetteer:Gazetteer to use to extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
834
835GISExtractor.place_list:When extracting placements, include list of placenames at start of the document. Requires GIS extension to Greenstone.
836
837HBPlugin.desc:Plugin which processes an HTML book directory. This plugin is used by the Humanity Library collections and does not handle input encodings other than ascii or extended ascii. This code is kind of ugly and could no doubt be made to run faster, by leaving it in this state I hope to encourage people to make their collections use BookPlugin instead ;-)\n\nUse BookPlugin if creating a new collection and marking up files like the Humanity Library collections. BookPlugin accepts all input encodings but expects the marked up files to be cleaner than those used by the Humanity Library collections
838
839HBPlugin.encoding.iso_8859_1:Latin1 (western languages)
840
841HTMLImagePlugin.aggressiveness:Range of related text extraction techniques to use.
842HTMLImagePlugin.aggressiveness.1:Filename, path, ALT text only.
843HTMLImagePlugin.aggressiveness.2:All of 1, plus caption where available.
844HTMLImagePlugin.aggressiveness.3:All of 2, plus near paragraphs where available.
845HTMLImagePlugin.aggressiveness.4:All of 3, plus previous headers (<h1>, <h2>...) where available.
846HTMLImagePlugin.aggressiveness.5:All of 4, plus textual references where available.
847HTMLImagePlugin.aggressiveness.6:All of 4, plus page metatags (title, keywords, etc).
848HTMLImagePlugin.aggressiveness.7:All of 6, 5 and 4 combined.
849HTMLImagePlugin.aggressiveness.8:All of 7, plus repeat caption, filename, etc (raise ranking of more relevant results).
850HTMLImagePlugin.aggressiveness.9:All of 1, plus full text of source page.
851
852HTMLImagePlugin.caption_length:Maximum length of captions (in characters).
853
854HTMLImagePlugin.convert_params:Additional parameters for ImageMagicK convert on thumbnail creation. For example, '-raise' will give a three dimensional effect to thumbnail images.
855
856HTMLImagePlugin.desc:A plugin for extracting images and associated text from webpages.
857
858HTMLImagePlugin.document_text:Add image text as document:text (otherwise IndexedText metadata field).
859
860HTMLImagePlugin.index_pages:Index the pages along with the images. Otherwise reference the pages at the source URL.
861
862HTMLImagePlugin.max_near_text:Maximum characters near images to extract.
863
864HTMLImagePlugin.min_height:Pixels. Skip images shorter than this.
865
866HTMLImagePlugin.min_near_text:Minimum characters of near text or caption to extract.
867
868HTMLImagePlugin.min_size:Bytes. Skip images smaller than this.
869
870HTMLImagePlugin.min_width:Pixels. Skip images narrower than this.
871
872HTMLImagePlugin.neartext_length:Target length of near text (in characters).
873
874HTMLImagePlugin.no_cache_images:Don't cache images (point to URL of original).
875
876HTMLImagePlugin.smallpage_threshold:Images on pages smaller than this (bytes) will have the page (title, keywords, etc) meta-data added.
877
878HTMLImagePlugin.textrefs_threshold:Threshold for textual references. Lower values mean the algorithm is less strict.
879
880HTMLImagePlugin.thumb_size:Max thumbnail size. Both width and height.
881
882HTMLPlugin.assoc_files:Perl regular expression of file extensions to associate with html documents.
883
884HTMLPlugin.desc:This plugin processes HTML files
885
886HTMLPlugin.description_tags:Split document into sub-sections where <Section> tags occur. '-keep_head' will have no effect when this option is set.
887
888HTMLPlugin.extract_style:Extract style and script information from the HTML <head> tag and save as DocumentHeader metadata. This will be set in the document page as the _document:documentheader_ macro.
889
890HTMLPlugin.file_is_url:Set if input filenames make up url of original source documents e.g. if a web mirroring tool was used to create the import directory structure.
891
892HTMLPlugin.hunt_creator_metadata:Find as much metadata as possible on authorship and place it in the 'Creator' field.
893
894HTMLPlugin.keep_head:Don't remove headers from html files.
895
896HTMLPlugin.metadata_fields:Comma separated list of metadata fields to attempt to extract. Use 'tag<tagname>' to have the contents of the first <tagname> pair put in a metadata element called 'tagname'. Capitalise this as you want the metadata capitalised in Greenstone, since the tag extraction is case insensitive.
897
898HTMLPlugin.no_metadata:Don't attempt to extract any metadata from files.
899
900HTMLPlugin.no_strip_metadata_html:Comma separated list of metadata names, or 'all'. Used with -description_tags, it prevents stripping of HTML tags from the values for the specified metadata.
901
902HTMLPlugin.nolinks:Don't make any attempt to trap links (setting this flag may improve speed of building/importing but any relative links within documents will be broken).
903
904HTMLPlugin.no_image_links:Don't make any attempt to trap image links to allow view images.
905
906HTMLPlugin.rename_assoc_files:Renames files associated with documents (e.g. images). Also creates much shallower directory structure (useful when creating collections to go on cd-rom).
907
908HTMLPlugin.sectionalise_using_h_tags:Automatically create a sectioned document using h1, h2, ... hX tags.
909
910HTMLPlugin.title_sub:Substitution expression to modify string stored as Title. Used by, for example, PDFPlugin to remove "Page 1", etc from text used as the title.
911
912HTMLPlugin.tidy_html:If set, converts an HTML document into a well-formed XHTML to enable users view the document in the book format.
913
914HTMLPlugin.old_style_HDL:To mark whether the file in this collection used the old HDL document's tags style.
915
916BaseMediaConverter.enable_cache:Cache automatically generated files (such as thumbnails and screen-size images) so they don't need to be repeatedly generated.
917
918ImageConverter.converttotype:Convert main image to format 's'.
919
920ImageConverter.create_screenview:If set to true, create a screen sized image, and set Screen, ScreenType, screenicon, ScreenWidth, ScreenHeight metadata.
921
922ImageConverter.create_thumbnail:If set to true, create a thumbnail version of each image, and add Thumb, ThumbType, thumbicon, ThumbWidth, ThumbHeight metadata.
923ImageConverter.desc:Helper plugin for image conversion using ImageMagick.
924
925ImageConverter.imagemagicknotinstalled:Image Magick not installed
926
927ImageConverter.minimumsize:Ignore images smaller than n bytes.
928
929ImageConverter.noconversionavailable:Image conversion not available
930
931ImageConverter.noscaleup:Don't scale up small images when making thumbnails.
932
933ImageConverter.screenviewsize:Make screenview images of size nxn.
934
935ImageConverter.screenviewtype:Make screenview images in format 's'.
936
937ImageConverter.thumbnailsize:Make thumbnails of size nxn.
938
939ImageConverter.thumbnailtype:Make thumbnails in format 's'.
940
941ImageConverter.win95notsupported: Image Magick not supported on Win95/98
942
943ImagePlugin.desc:This plugin processes images, adding basic metadata
944
945IndexPlugin.desc:This recursive plugin processes an index.txt file. The index.txt file should contain the list of files to be included in the collection followed by any extra metadata to be associated with each file.\n\nThe index.txt file should be formatted as follows: The first line may be a key (beginning with key:) to name the metadata fields (e.g. key: Subject Organization Date). The following lines will contain a filename followed by the value that metadata entry is to be set to. (e.g. 'irma/iw097e 3.2 unesco 1993' will associate the metadata Subject=3.2, Organization=unesco, and Date=1993 with the file irma/iw097e if the above key line was used)\n\nNote that if any of the metadata fields use the Hierarchy classifier plugin then the value they're set to should correspond to the first field (the descriptor) in the appropriate classification file.\n\nMetadata values may be named separately using a tag (e.g. <Subject>3.2) and this will override any name given to them by the key line. If there's no key line any unnamed metadata value will be named 'Subject'.
946
947ISISPlugin.desc:This plugin processes CDS/ISIS databases. For each CDS/ISIS database processed, three files must exist in the collection's import folder: the Master file (.mst), the Field Definition Table (.fdt), and the Cross-Reference File (.xrf).
948
949ISISPlugin.subfield_separator:The string used to separate subfields in CDS/ISIS database records.
950
951ISISPlugin.entry_separator:The string used to separate multiple values for single metadata fields in CDS/ISIS database records.
952
953KeyphraseExtractor.desc:Helper extractor plugin for generating keyphrases from text. Uses Kea keyphrase extraction system.
954
955KeyphraseExtractor.extract_keyphrases:Extract keyphrases automatically with Kea (default settings).
956
957KeyphraseExtractor.extract_keyphrases_kea4:Extract keyphrases automatically with Kea 4.0 (default settings). Kea 4.0 is a new version of Kea that has been developed for controlled indexing of documents in the domain of agriculture.
958
959KeyphraseExtractor.extract_keyphrase_options:Options for keyphrase extraction with Kea. For example: mALIWEB - use ALIWEB extraction model; n5 - extract 5 keyphrase;, eGBK - use GBK encoding.
960
961KeyphraseExtractor.keyphrases:keyphrases
962
963KeyphraseExtractor.missing_kea:Error: The Kea software could not be found at %s. Please download Kea %s from http://www.nzdl.org/Kea and install it in this directory.
964
965LaTeXPlugin.desc:Plugin for LaTeX documents.
966
967LOMPlugin.desc:Plugin for importing LOM (Learning Object Metadata) files.
968
969LOMPlugin.root_tag:The DocType of the XML file (or a regular expression that matches the root element).
970
971LOMPlugin.check_timestamp:Check timestamps of previously downloaded files, and only download again if source file is newer.
972
973LOMPlugin.download_srcdocs:Download the source document if one is specified (in general^identifier^entry or technical^location). This option should specify a regular expression to match filenames against before downloading. Note, this currently doesn't work for documents outside a firewall.
974
975MARCPlugin.desc:Basic MARC plugin.
976
977MARCPlugin.metadata_mapping:Name of file that includes mapping details from MARC values to Greenstone metadata names. Defaults to 'marc2dc.txt' found in the site's etc directory.
978
979MARCXMLPlugin.desc:MARCXML plugin.
980
981MARCXMLPlugin.metadata_mapping_file:Name of file that includes mapping details from MARC values to Greenstone metadata names. Defaults to 'marc2dc.txt' found in the site's etc directory.
982
983MediaWikiPlugin.desc:Plugin for importing MediaWiki web pages
984
985MediaWikiPlugin.show_toc: Add to the collection's About page the 'table of contents' on the MediaWiki website's main page. Needs to specify a Perl regular expression in toc_exp below to match the 'table of contents' section.
986
987MediaWikiPlugin.delete_toc:Delete the 'table of contents' section on each HTML page. Needs to specify a Perl regular expression in toc_exp below to match the 'table of contents' section.
988
989MediaWikiPlugin.toc_exp:A Perl regular expression to match the 'table of contents'. The default value matches common MediaWiki web pages.
990
991MediaWikiPlugin.delete_nav:Delete the navigation section. Needs to specify a Perl regular expression in nav_div_exp below.
992
993MediaWikiPlugin.nav_div_exp:A Perl regular expression to match the navigation section. The default value matches common MediaWiki web pages.
994
995MediaWikiPlugin.delete_searchbox:Delete the searchbox section. Needs to specify a Perl regular expression in searchbox_div_exp below.
996
997MediaWikiPlugin.searchbox_div_exp:A Perl regular expression to match the searchbox section. The default value matches common MediaWiki web pages.
998
999MediaWikiPlugin.remove_title_suffix_exp:A Perl regular expression to trim the extracted title. For example, \\s-(.+) will trim title contents after "-".
1000
1001MetadataCSVPlugin.desc:A plugin for metadata in comma-separated value format. The Filename field in the CSV file is used to determine which document the metadata belongs to.
1002
1003MetadataPass.desc:On-the-side base class to BasePlugin that supports metadata plugins utilise metadata_read pass of import.pl
1004
1005MetadataXMLPlugin.desc:Plugin that processes metadata.xml files.
1006
1007MetadataEXIFPlugin.desc:Plugin that extracts EXIF metadata from images, audio and video.  More specifically, it is based on the CPAN module 'ExifTool'. This actually supports many more formats then the name suggests (e.g. GPS, XMP, FlashPix, ID3, Vorbis).  The plugin benefits from this, and has been designed to support all the formats ExifTool supports. See ExifTool documentation for the file types and metadata schemes supported.
1008
1009GreenstoneMETSPlugin.desc:Process Greenstone-style METS documents
1010
1011MP3Plugin.desc:Plugin for processing MP3 files.
1012
1013MP3Plugin.assoc_images:Use Google image search to locate images related to MP3 file based on ID3 Title and Artist metadata.
1014
1015MP3Plugin.applet_metadata:Used to store [applet] metadata for each document that contains the necessary HTML for an MP3 audio player applet to play that file.
1016
1017MP3Plugin.metadata_fields:Comma separated list of metadata fields to extract (assuming present) in an MP3 file. Use \"*\" to extract all the fields.
1018
1019NulPlugin.desc:Dummy (.nul) file plugin. Used with the files produced by exploding metadata database files.
1020
1021NulPlugin.assoc_field:Name of a metadata field that will be set for each nul file.
1022NulPlugin.add_metadata_as_text:Add a table of metadata as the text of the document, rather than "This document has no text".
1023
1024NulPlugin.remove_namespace_for_text:Remove namepsaces from metadata names in the document text (if add_metadata_as_text is set).
1025
1026OAIPlugin.desc:Basic Open Archives Initiative (OAI) plugin.
1027
1028OAIPlugin.document_field:The metadata element specifying the file name of documents to attach the metadata to.
1029
1030OAIPlugin.metadata_set:Metadata set (namespace prefix) to import all metadata as
1031OAIPlugin.metadata_set.auto:Use the prefixes specified in the OAI record
1032OAIPlugin.metadata_set.dc: Use the dc prefix. Will map qualified dc elements into their Greenstone form, eg spatial becomes dc.Coverage^spatial.
1033
1034OggVorbisPlugin.add_technical_metadata:Add technical (eg. bitrate) metadata.
1035
1036OggVorbisPlugin.desc:A plugin for importing Ogg Vorbis audio files.
1037
1038OpenDocumentPlugin.desc:Plugin for OASIS OpenDocument format documents (used by OpenOffice 2.0)
1039
1040PagedImagePlugin.desc:Plugin for documents made up of a sequence of images, with optional OCR text for each image. This plugin processes .item files which list the sequence of image and text files, and provide metadata.
1041
1042PagedImagePlugin.documenttype:Set the document type (used for display)
1043
1044PagedImagePlugin.documenttype.paged:Paged documents have next and previous arrows and a 'go to page X' box
1045
1046PagedImagePlugin.documenttype.hierarchy:Hierarchical documents have a table of contents
1047
1048PagedImagePlugin.headerpage:Add a top level header page (that contains no image) to each document.
1049
1050PDFPlugin.allowimagesonly:Allow PDF files with no extractable text. Avoids the need to have -complex set. Only useful with convert_to html.
1051
1052PDFPlugin.complex:Create more complex output. With this option set the output html will look much more like the original PDF file. For this to function properly you Ghostscript installed (for *nix gs should be on your path while for windows you must have gswin32c.exe on your path).
1053
1054PDFPlugin.desc:Plugin that processes PDF documents.
1055
1056PDFPlugin.nohidden:Prevent pdftohtml from attempting to extract hidden text. This is only useful if the -complex option is also set.
1057
1058PDFPlugin.noimages:Don't attempt to extract images from PDF.
1059
1060PDFPlugin.use_sections:Create a separate section for each page of the PDF file.
1061
1062PDFPlugin.zoom:The factor by which to zoom the PDF for output (this is only useful if -complex is set).
1063
1064PostScriptPlugin.desc:This is a \"poor man's\" ps to text converter. If you are serious, consider using the PRESCRIPT package, which is available for download at http://www.nzdl.org/html/software.html
1065
1066PostScriptPlugin.extract_date:Extract date from PS header.
1067
1068PostScriptPlugin.extract_pages:Extract pages from PS header.
1069
1070PostScriptPlugin.extract_title:Extract title from PS header.
1071
1072PowerPointPlugin.desc:A plugin for importing Microsoft PowerPoint files.
1073
1074PowerPointPlugin.windows_scripting:Use MicroSoft Windows scripting technology (Visual Basic for Applications) to get PPT to convert document to various image types (e.g. JPEG,PNG,GIF) rather than rely on the open source package ppttohtml.
1075
1076PrintInfo.bad_general_option:The %s plugin uses an incorrect option. Check your collect.cfg configuration file.
1077
1078PrintInfo.desc:Most base plugin, handles printing info (using pluginfo.pl) and parsing of the arguments.
1079
1080ProCitePlugin.desc:A plugin for (exported) ProCite databases
1081
1082ProCitePlugin.entry_separator:The string used to separate multiple values for single metadata fields in ProCite database records.
1083
1084ReadTextFile.could_not_extract_encoding:WARNING: encoding could not be extracted from %s - defaulting to %s
1085
1086ReadTextFile.could_not_extract_language:WARNING: language could not be extracted from %s - defaulting to %s
1087
1088ReadTextFile.could_not_open_for_reading:could not open %s for reading
1089
1090ReadTextFile.default_encoding:Use this encoding if -input_encoding is set to 'auto' and the text categorization algorithm fails to extract the encoding or extracts an encoding unsupported by Greenstone. This option can take the same values as -input_encoding.
1091
1092ReadTextFile.default_language:If Greenstone fails to work out what language a document is the 'Language' metadata element will be set to this value. The default is 'en' (ISO 639 language symbols are used: en = English). Note that if -input_encoding is not set to 'auto' and -extract_language is not set, all documents will have their 'Language' metadata set to this value.
1093
1094ReadTextFile.desc:Base plugin for files that are plain text.
1095
1096ReadTextFile.empty_file:file contains no text
1097
1098ReadTextFile.extract_language:Identify the language of each document and set 'Language' metadata. Note that this will be done automatically if -input_encoding is 'auto'.
1099
1100ReadTextFile.file_has_no_text:ERROR: %s contains no text
1101
1102ReadTextFile.input_encoding:The encoding of the source documents. Documents will be converted from these encodings and stored internally as utf8.
1103
1104ReadTextFile.input_encoding.auto:Use text categorization algorithm to automatically identify the encoding of each source document. This will be slower than explicitly setting the encoding but will work where more than one encoding is used within the same collection.
1105
1106ReadTextFile.read_denied:Read permission denied for %s
1107
1108ReadTextFile.separate_cjk:Insert spaces between Chinese/Japanese/Korean characters to make each character a word. Use if text is not segmented.
1109
1110ReadTextFile.unsupported_encoding:WARNING: %s appears to be encoded in an unsupported encoding (%s) - using %s
1111
1112ReadTextFile.wrong_encoding:WARNING: %s was read using %s encoding but appears to be encoded as %s.
1113
1114ReadXMLFile.desc:Base class for XML plugins.
1115
1116ReadXMLFile.xslt:Transform a matching input document with the XSLT in the named file.  A relative filename is assumed to be in the collection's file area, for instance etc/mods2dc.xsl.
1117
1118RealMediaPlugin.desc:A plugin for processing Real Media files.
1119
1120ReferPlugin.desc:ReferPlugin reads bibliography files in Refer format.
1121
1122RogPlugin.desc:Creates simple single-level documents from .rog or .mdb files.
1123
1124RTFPlugin.desc:Plugin for importing Rich Text Format files.
1125
1126SourceCodePlugin.desc:Filename is currently used for Title ( optionally minus some prefix ). Current languages:\ntext: READMEs/Makefiles\nC/C++   (currently extracts #include statements and C++ class decls)\nPerl    (currently only done as text)\nShell   (currently only done as text)
1127
1128SourceCodePlugin.remove_prefix:Remove this leading pattern from the filename (eg -remove_prefix /tmp/XX/src/). The default is to remove the whole path from the filename.
1129
1130SplitTextFile.desc:SplitTextFile is a plugin for splitting input files into segments that will then be individually processed. This plugin should not be called directly.  Instead, if you need to process input files that contain several documents, you should write a plugin with a process function that will handle one of those documents and have it inherit from SplitTextFile.  See ReferPlugin for an example.
1131
1132SplitTextFile.split_exp:A perl regular expression to split input files into segments.
1133
1134StructuredHTMLPlugin.desc:A plugin to process structured HTML documents, splitting them into sections based on style information.
1135
1136StructuredHTMLPlugin.delete_toc:Remove any table of contents, list of figures etc from the converted HTML file. Styles for these are specified by the toc_header option.
1137
1138StructuredHTMLPlugin.title_header:possible user-defined styles for the title header.
1139
1140StructuredHTMLPlugin.level1_header:possible user-defined styles for the level1 header in the HTML document (equivalent to <h1>).
1141
1142StructuredHTMLPlugin.level2_header:possible user-defined styles for the level2 header in the HTML document (equivalent to <h2>).
1143
1144StructuredHTMLPlugin.level3_header:possible user-defined styles for the level3 header in the HTML document (equivalent to <h3>).
1145
1146StructuredHTMLPlugin.toc_header:possible user-defined header styles for the table of contents, table of figures etc, to be removed if delete_toc is set.
1147
1148TextPlugin.desc:Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).
1149
1150TextPlugin.title_sub:Substitution expression to modify string stored as Title. Used by, for example, PostScriptPlugin to remove "Page 1" etc from text used as the title.
1151
1152UnknownPlugin.assoc_field:Name of the metadata field that will hold the associated file's name.
1153
1154UnknownPlugin.desc:This is a simple Plugin for importing files in formats that Greenstone doesn't know anything about.  A fictional document will be created for every such file, and the file itself will be passed to Greenstone as the \"associated file\" of the document.
1155
1156UnknownPlugin.file_format:Type of the file (e.g. MPEG, MIDI, ...)
1157
1158UnknownPlugin.mime_type:Mime type of the file (e.g. image/gif).
1159
1160UnknownPlugin.process_extension:Process files with this file extension. This option is an alternative to process_exp that is simpler to use but less flexible.
1161
1162UnknownPlugin.srcicon:Specify a macro name (without underscores) to use as srcicon metadata.
1163
1164WordPlugin.desc:A plugin for importing Microsoft Word documents.
1165
1166WordPlugin.windows_scripting:Use MicroSoft Windows scripting technology (Visual Basic for Applications) to get Word to convert document to HTML rather than rely on the open source package WvWare.  Causes Word application to open on screen if not already running.
1167
1168WordPlugin.metadata_fields: This is to retrieve metadata from the HTML document converted by VB scripting. It allows users to define comma separated list of metadata fields to attempt to extract. Use 'tag<tagname>' to have the contents of the first <tagname> pair put in a metadata element called 'tagname'. Capitalise this as you want the metadata capitalised in Greenstone, since the tag extraction is case insensitive
1169
1170ZIPPlugin.desc:Plugin which handles compressed and/or archived input formats currently handled formats and file extensions are:\ngzip (.gz, .z, .tgz, .taz)\nbzip (.bz)\nbzip2 (.bz2)\nzip (.zip .jar)\ntar (.tar)\n\nThis plugin relies on the following utilities being present (if trying to process the corresponding formats):\ngunzip (for gzip)\nbunzip (for bzip)\nbunzip2 \nunzip (for zip)\ntar (for tar)
1171
1172#
1173# Download module option descriptions
1174#
1175
1176BaseDownload.desc:Base class for Download modules
1177BaseDownload.bad_general_option:The %s download module uses an incorrect option.
1178MediaWikiDownload.desc:A module for downloading from MediaWiki websites
1179MediaWikiDownload.reject_filetype:Ignore url list, separate by comma, e.g.*cgi-bin*,*.ppt ignores hyperlinks that contain either 'cgi-bin' or '.ppt'
1180MediaWikiDownload.reject_filetype_disp:Ignore URL patterns
1181MediaWikiDownload.exclude_directories:List of exclude directories (must be absolute path to the directory), e.g. /people,/documentation will exclude the 'people' and 'documentation' subdirectory under the currently crawling site.
1182MediaWikiDownload.exclude_directories_disp:Exclude directories
1183
1184OAIDownload.desc:A module for downloading from OAI repositories
1185OAIDownload.url_disp:Source URL
1186OAIDownload.url:OAI repository URL
1187OAIDownload.set_disp:Restrict to set
1188OAIDownload.set:Restrict the download to the specified set in the repository
1189OAIDownload.metadata_prefix_disp:Metadata prefix
1190OAIDownload.metadata_prefix:The metadata format used in the exported, e.g. oai_dc, qdc, etc. Press the <Server information> button to find out what formats are supported.
1191OAIDownload.get_doc_disp:Get document
1192OAIDownload.get_doc:Download the source document if one is specified in the record
1193OAIDownload.get_doc_exts_disp:Only include file types
1194OAIDownload.get_doc_exts:Permissible filename extensions of documents to get
1195OAIDownload.max_records_disp:Max records
1196OAIDownload.max_records:Maximum number of records to download
1197
1198SRWDownload.desc:A module for downloading from SRW (Search/Retrieve Web Service) repositories
1199
1200WebDownload.desc:A module for downloading from the Internet via HTTP or FTP
1201WebDownload.url:Source URL. In case of http redirects, this value may change
1202WebDownload.url_disp:Source URL
1203WebDownload.depth:How many hyperlinks deep to go when downloading
1204WebDownload.depth_disp:Download Depth
1205WebDownload.below:Only mirror files below this URL
1206WebDownload.below_disp:Only files below URL
1207WebDownload.within:Only mirror files within the same site
1208WebDownload.within_disp:Only files within site
1209WebDownload.html_only:Download only HTML files, and ignore associated files e.g images and stylesheets
1210WebDownload.html_only_disp:Only HTML files
1211
1212WgetDownload.desc: Base class that handles calls to wget
1213WgetDownload.proxy_on:Proxy on
1214WgetDownload.proxy_host:Proxy host
1215WgetDownload.proxy_port:Proxy port
1216WgetDownload.user_name:User name
1217WgetDownload.user_password:User password
1218
1219Z3950Download.desc:A module for downloading from Z3950 repositories
1220Z3950Download.host:Host URL
1221Z3950Download.host_disp:Host
1222Z3950Download.port:Port number of the repository
1223Z3950Download.port_disp:Port
1224Z3950Download.database:Database to search for records in
1225Z3950Download.database_disp:Database
1226Z3950Download.find:Retrieve records containing the specified search term
1227Z3950Download.find_disp:Find
1228Z3950Download.max_records:Maximum number of records to download
1229Z3950Download.max_records_disp:Max Records
1230
1231
1232#
1233#Plugout option descriptions
1234#
1235
1236BasPlugout.bad_general_option:The %s plugout uses an incorrect option.
1237BasPlugout.debug:set debugging mode
1238BasPlugout.desc:Base class for all the export plugouts.
1239BasPlugout.group_size:Number of documents to group into one XML file.
1240BasPlugout.gzip_output:Use gzip to compress resulting xml documents (don't forget to include ZIPPlugin in your plugin list when building from compressed documents).
1241BasPlugout.output_handle: the file descriptor used to send output information
1242BasPlugout.output_info:the reference to an arcinfo object used to store information about the archives.
1243BasPlugout.verbosity:Controls the quantity of output. 0=none, 3=lots.
1244BasPlugout.xslt_file:Transform a document with the XSLT in the named file. 
1245
1246DSpacePlugout.desc:DSpace Archive format.
1247
1248FedoraMETSPlugout.desc:METS format using the Fedora profile.
1249FedoraMETSPlugout.fedora_namespace:The prefix used in Fedora for process ids (PIDS) e.g. greenstone:HASH0122efe4a2c58d0
1250
1251GreenstoneXMLPlugout.desc:Greenstone XML Archive format.
1252
1253GreenstoneMETSPlugout.desc:METS format using the Greenstone profile.
1254
1255MARCXMLPlugout.desc:MARC xml format.
1256MARCXMLPlugout.group:Output the marc xml records into a single file.
1257MARCXMLPlugout.mapping_file:Use the named mapping file for the transformation.
1258
1259METSPlugout.desc:Superclass plugout for METS format.  Provides common functionality for profiles such as GreenstoneMETS and FedoraMETS and key abstract methods.
1260METSPlugout.xslt_txt:Transform a mets's doctxt.xml with the XSLT in the named file. 
1261METSPlugout.xslt_mets:Transform a mets's docmets.xml with the XSLT in the named file. 
1262
1263#
1264# Perl module strings
1265#
1266
1267classify.could_not_find_classifier:ERROR: Could not find classifier \"%s\"
1268
1269download.could_not_find_download:ERROR: Could not find download module \"%s\"
1270
1271plugin.could_not_find_plugin:ERROR: Could not find plugin \"%s\"
1272
1273plugin.including_archive:including the contents of 1 ZIP/TAR archive
1274
1275plugin.including_archives:including the contents of %d ZIP/TAR archives
1276
1277plugin.kill_file:Process killed by .kill file
1278
1279plugin.n_considered:%d documents were considered for processing
1280
1281plugin.n_included:%d were processed and included in the collection
1282
1283plugin.n_rejected:%d were rejected
1284
1285plugin.n_unrecognised:%d were unrecognised
1286
1287plugin.no_plugin_could_process:WARNING: No plugin could process %s
1288
1289plugin.no_plugin_could_recognise:WARNING: No plugin could recognise %s
1290
1291plugin.no_plugin_could_process_this_file:no plugin could process this file
1292
1293plugin.no_plugin_could_recognise_this_file:no plugin could recognise this file
1294
1295plugin.one_considered:1 document was considered for processing
1296
1297plugin.one_included:1 was processed and included in the collection
1298
1299plugin.one_rejected:1 was rejected
1300
1301plugin.one_unrecognised:1 was unrecognised
1302
1303plugin.see_faillog:See %s for a list of unrecognised and/or rejected documents
1304
1305PrintUsage.default:Default
1306
1307PrintUsage.required:REQUIRED
1308
1309plugout.could_not_find_plugout:ERROR: Could not find plugout \"%s\"
Note: See TracBrowser for help on using the browser.