root/main/trunk/greenstone2/perllib/strings.properties @ 31957

Revision 31957, 86.6 KB (checked in by ak19, 2 years ago)

Tidying up. 1. Shifting informative error message to strings.properties. 2. Commenting out unnecessary message that was printed out for debugging when things went well. 3. To use gsprintf passing in STDERR/STDOUT as a parameter when use strict is on, need to make some exceptions to strict.

  • Property svn:keywords set to Author Date Id Revision
RevLine 
[11633]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#
[17144]13# Common output messages and strings
[11633]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
[11788]42common.info:info
[11633]43
[12617]44common.invalid_options:Invalid arguments: %s
[12692]45
[16017]46common.true:true
47
48common.false:false
49
[19315]50common.deprecated: SUPERSEDED
[11633]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.
[17144]60
[11788]61scripts.describeall:Display options for all items known about
[11633]62
[12967]63scripts.both_old_options:WARNING: -removeold was specified with -keepold or -incremental, defaulting to -removeold. Current contents of %s directory will be deleted.
[11633]64
[12967]65scripts.no_old_options:WARNING: None of -removeold, -keepold or -incremental were specified, defaulting to -removeold. Current contents of %s directory will be deleted.
[11633]66
[17144]67scripts.gli:A flag set when running this script from gli, enables output specific for gli.
[20541]68scripts.gai:A flag set when running this script from gai (greenstone administration tool), enables output specific for gai.
[17144]69
[20541]70scripts.verbosity:Controls the quantity of output. 0=none, 3=lots.
71scripts.out:Filename or handle to print output status to.
72
[11633]73# -- buildcol.pl --
[14252]74
[25573]75buildcol.activate:Run activate.pl after buildcol has finished, which will move building to index.
76
[11633]77buildcol.archivedir:Where the archives live.
78
79buildcol.builddir:Where to put the built indexes.
80
81buildcol.cachedir:Collection will be temporarily built here before being copied to the build directory.
82
83buildcol.cannot_open_cfg_file:WARNING: Can't open config file for updating: %s
84
[12409]85buildcol.collectdir:The path of the "collect" directory.
[11633]86
87buildcol.copying_back_cached_build:Copying back the cached build
88
[28087]89buildcol.copying_rss_items_rdf:Copying rss-items.rdf file from %s to %s
[26976]90
[11633]91buildcol.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.
92
93buildcol.debug:Print output to STDOUT.
94
[17748]95buildcol.desc:PERL script used to build a greenstone collection from archive documents.
[11633]96
97buildcol.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed.
98
[17586]99buildcol.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.
100
[11633]101buildcol.index:Index to build (will build all in config file if not set).
102
[27300]103buildcol.indexname:Name of index to build (will build all in config file if not set).
104
105buildcol.indexlevel:Level of indexes to build (will build all in config file if not set).
106
[13193]107buildcol.incremental:Only index documents which have not been previously indexed. Implies -keepold. Relies on the lucene indexer.
[12967]108
[11633]109buildcol.keepold:Will not destroy the current contents of the building directory.
110
[31754]111buildcol.library_url:Provide the full URL of the greenstone digital library to be (de)activated
112buildcol.library_name:For GS3, provide the library name (servlet name) of the library to be (de)activated in the current running Greenstone
113
[11633]114buildcol.maxdocs:Maximum number of documents to build.
[12339]115buildcol.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".
[11633]116buildcol.mode:The parts of the building process to carry out.
117buildcol.mode.all:Do everything.
118buildcol.mode.build_index:Just index the text.
119buildcol.mode.compress_text:Just compress the text.
120buildcol.mode.infodb:Just build the metadata database.
[28801]121buildcol.mode.extra:Skip the main indexing stages, and just build the extra (orthogonal) passes
[11633]122
123buildcol.no_default_images:Default images will not be generated.
124
125buildcol.no_image_script:WARNING: Image making script could not be found: %s
126
127buildcol.no_strip_html:Do not strip the html tags from the indexed text (only used for mgpp collections).
128
[24754]129buildcol.store_metadata_coverage:Include statistics about which metadata sets are used in a collection, including which actual metadata terms are used.  This is useful in the built collection if you want the list the metadata values that are used in a particular collection.
130
[11633]131buildcol.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).
132
[27563]133buildcol.sections_index_document_metadata:Add document level metadata at section level for indexing
134buildcol.sections_sort_on_document_metadata:(Lucene only) Add document level metadata at section level for sorting
135buildcol.sections_index_document_metadata.never:Don't add any document metadata at section level.
[11633]136buildcol.sections_index_document_metadata.always:Add all specified document level metadata even if section level metadata of that name exists.
137buildcol.sections_index_document_metadata.unless_section_metadata_exists:Only add document level metadata if no section level metadata of that name exists.
138
139buildcol.out:Filename or handle to print output status to.
140
141buildcol.params:[options] collection-name
142
143buildcol.remove_empty_classifications:Hide empty classifiers and classification nodes (those that contain no documents).
144
145buildcol.removeold:Will remove the old contents of the building directory.
146
[31754]147buildcol.skipactivation:Pass this along with the activate flag to run every task of the activate script except any actual (de)activating steps
148
[11633]149buildcol.unlinked_col_images:Collection images may not be linked correctly.
150
151buildcol.unknown_mode:Unknown mode: %s
152
153buildcol.updating_archive_cache:Updating archive cache
154
155buildcol.verbosity:Controls the quantity of output. 0=none, 3=lots.
156
157
158# -- classinfo.pl --
159
[12639]160classinfo.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.
[11633]161
162classinfo.desc:Prints information about a classifier.
163
164classinfo.general_options:General options are inherited from parent classes of the classifier.
165
166classinfo.info:info
167
168classinfo.no_classifier_name:ERROR: You must provide a classifier name.
169
170classinfo.option_types:Classifiers may take two types of options
171
172classinfo.params:[options] classifier-name
173
174classinfo.passing_options:Options may be passed to any classifier by including them in your collect.cfg configuration file.
175
176classinfo.specific_options:Specific options are defined within the classifier itself, and are available only to this particular classifier.
177
[11788]178# -- downloadfrom.pl --
179downloadfrom.cache_dir:The location of the cache directory
180downloadfrom.desc:Downloads files from an external server
181downloadfrom.download_mode:The type of server to download from
182downloadfrom.download_mode.Web:HTTP 
[14252]183downloadfrom.download_mode.MediaWiki:MediaWiki website
[11788]184downloadfrom.download_mode.OAI: Open Archives Initiative
185downloadfrom.download_mode.z3950:z3950 server
186downloadfrom.download_mode.SRW:SearchRetrieve Webservice
187downloadfrom.incorrect_mode:download_mode parameter was incorrect.
188downloadfrom.info:Print information about the server, rather than downloading
189downloadfrom.params:[general options] [specific download options]
190
191# -- downloadinfo.pl --
192
193downloadinfo.desc:Prints information about a download module
[12639]194downloadinfo.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.
[11788]195downloadinfo.params:[options] [download-module]
196downloadinfo.general_options:General options are inherited from parent classes of the download modules.
197downloadinfo.specific_options:Specific options are defined within the download module itself, and are available only to this particular downloader.
198downloadinfo.option_types:Download modules may take two types of options
199
[11633]200# -- explode_metadata_database.pl --
201explode.desc:Explode a metadata database
202
[17029]203explode.collection:The collection name. Some plugins look for auxiliary files in the collection folder.
204 
[11633]205explode.document_field:The metadata element specifying the file name of documents to obtain and include in the collection.
206
207explode.document_prefix:A prefix for the document locations (for use with the document_field option).
208
209explode.document_suffix:A suffix for the document locations (for use with the document_field option).
210
211explode.encoding:Encoding to use when reading in the database file
212explode.metadata_set:Metadata set (namespace) to export all metadata as
213explode.plugin: Plugin to use for exploding
[18915]214explode.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.
215explode.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.
[11633]216explode.params: [options] filename
[12706]217explode.records_per_folder: The number of records to put in each subfolder.
218
[15118]219# -- replace_srcdoc_with_html.pl --
220srcreplace.desc: Replace source document with the generated HTML file when rebuilding
221srcreplace.params: [options] filename
222srcreplace.plugin: Plugin to use for converting the source document
223
[11633]224# -- exportcol.pl --
225
226exportcol.out:Filename or handle to print output status to.
227exportcol.cddir:The name of the directory that the CD contents are exported to.
228exportcol.cdname:The name of the CD-ROM -- this is what will appear in the start menu once the CD-ROM is installed.
[22849]229exportcol.collectdir:The path of the "collect" directory.
[11633]230exportcol.desc:PERL script used to export one or more collections to a Windows CD-ROM.
[11945]231exportcol.noinstall:Create a CD-ROM where the library runs directly off the CD-ROM and nothing is installed on the host computer.
[11633]232exportcol.params:[options] collection-name1 collection-name2 ...
233exportcol.coll_not_found:Ignoring invalid collection %s: collection not found at %s.
234exportcol.coll_dirs_not_found:Ignoring invalid collection %s: one of the following directories not found:
235exportcol.fail:exportcol.pl failed:
236exportcol.no_valid_colls:No valid collections specified to export.
237exportcol.couldnt_create_dir:Could not create directory %s.
238exportcol.couldnt_create_file:Could not create %s.
239exportcol.instructions:To create a self-installing Windows CD-ROM, write the contents of this folder out to a CD-ROM.
240exportcol.non_exist_files:One or more of the following necessary files and directories does not exist:
241exportcol.success:exportcol.pl succeeded:
242exportcol.output_dir:The exported collections (%s) are in %s.
243exportcol.export_coll_not_installed:The Export to CD-ROM functionality has not been installed.
244
245# -- import.pl --
246
247import.archivedir:Where the converted material ends up.
248
[11997]249import.manifest:An XML file that details what files are to be imported. Used instead of recursively descending the import folder, typically for incremental building.
250
[11633]251import.cannot_open_stats_file:WARNING: Couldn't open stats file %s.
252
253import.cannot_open_fail_log:ERROR: Couldn't open fail log %s
254
[23946]255import.cannot_read_OIDcount:Warning: unable to read document OID count from %s.\nSetting value to 0.
256
[30618]257# import.cannot_read_earliestdatestamp:Warning: unable to read collection's earliestDatestampcount from %s.\nSetting value to 0.
[23946]258
[11633]259import.cannot_sort:WARNING: import.pl cannot sort documents when groupsize > 1. sortmeta option will be ignored.
260
[23946]261import.cannot_write_earliestdatestamp:Warning: unable to store collection's earliestDatestamp in %s.
262
263import.cannot_write_OIDcount:Warning: unable to store document OID count in %s.
264
[12409]265import.collectdir:The path of the "collect" directory.
[11633]266
267import.complete:Import complete
268
[17748]269import.debug:Print imported text to STDOUT (for GreenstoneXML importing)
[11633]270
[17748]271import.desc:PERL script used to import files into a format (GreenstoneXML or GreenstoneMETS) ready for building.
[11633]272
273import.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed.
274
275import.groupsize:Number of import documents to group into one XML file.
276
[17068]277import.gzip:Use gzip to compress resulting xml documents (don't forget to include ZIPPlugin in your plugin list when building from compressed documents).
[11633]278
279import.importdir:Where the original material lives.
280
[12967]281import.incremental:Only import documents which are newer (by timestamp) than the current archives files. Implies -keepold.
282
[11633]283import.keepold:Will not destroy the current contents of the archives directory.
284
285import.maxdocs:Maximum number of documents to import.
286
[31131]287import.NO_IMPORT:Prevents import.pl from running. Set this in the collection's config file if you are using web document editing, to prevent import.pl from being run and deleting all your edits.
288
289import.NO_IMPORT_set:Not continuing with import as -NO_IMPORT is set.
290
[12398]291import.no_import_dir:Error: Import dir (%s) not found.
292
[11633]293import.no_plugins_loaded:ERROR: No plugins loaded.
294
295import.OIDtype:The method to use when generating unique identifiers for each document.
[12817]296import.OIDtype.hash:Hash the contents of the file. Document identifiers will be the same every time the collection is imported.
[24291]297import.OIDtype.hash_on_ga_xml:Hash the contents of the Greenstone Archive XML file. Document identifiers will be the same every time the collection is imported as long as the metadata does not change.
[26536]298import.OIDtype.hash_on_full_filename:Hash on the full filename to the document within the 'import' folder (and not its contents).  Helps make document identifiers more stable across upgrades of the software, although it means that duplicate documents contained in the collection are no longer detected automatically.
[11633]299
[22804]300import.OIDtype.incremental:Use a simple document count. Significantly faster than "hash", but does not necessarily assign the same identifier to the same document content if the collection is reimported.
[11633]301
[27353]302import.OIDtype.assigned:Use the metadata value given by the OIDmetadata option; if unspecified, for a particular document a hash is used instead. These identifiers should be unique. Numeric identifiers will be preceded by 'D'.
[11633]303
[27353]304import.OIDtype.dirname:Use the immediate parent directory name. 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 h15ef. Numeric identifiers will be preceded by 'D'.
[11633]305
[27353]306import.OIDtype.filename:Use the tail file name (without the file extension). Requires every filename across all the folders within 'import' to be unique. Numeric identifiers will be preceded by 'D'.
[26536]307
308import.OIDtype.full_filename:Use the full file name within the 'import' folder as the identifier for the document (with _ and - substitutions made for symbols such as directory separators and the fullstop in a filename extension)
309
[12817]310import.OIDmetadata:Specifies the metadata element that hold's the document's unique identifier, for use with -OIDtype=assigned.
[12267]311
[17748]312import.saveas:Format that the archive files should be saved as.
[11633]313
314import.out:Filename or handle to print output status to.
315
316import.params:[options] collection-name
317
318import.removeold:Will remove the old contents of the archives directory.
319
320import.removing_archives:Removing current contents of the archives directory...
321
322import.removing_tmpdir:Removing contents of the collection "tmp" directory...
323
[17756]324import.site:Site to find collect directory in (for Greenstone 3 installation).
325
[27697]326import.sortmeta:Sort documents alphabetically by metadata for building (specifying -sortmeta as 'OID' is a special case, and instructs Greenstone to use the document identifier for ordering). Search results for boolean queries will be displayed in the order determined by sortmeta. This will be disabled if groupsize > 1. May be a commma separated list to sort by more than one metadata value.
[11633]327
[27698]328import.sortmeta_paired_with_ArchivesInfPlugin:Detected -sortmeta. To effect the stipulated sorting by metadata (or OID) remember this option should be paired with either the '-reversesort' or '-sort' option to ArchivesInfPlugin.
329
[11633]330import.statsfile:Filename or handle to print import statistics to.
331
332import.stats_backup:Will print stats to STDERR instead.
333
334import.verbosity:Controls the quantity of output. 0=none, 3=lots.
335
[20541]336# -- csv-usernames-to-db.pl
[21568]337cu2db.desc:A simple script to batch add users to the greenstone users database. Takes a comma-separated value (csv) file as input. Each line represents one user, and consists of username,password,groups,comment. If the user belongs ot more than one group, then groups will be a comma-separated list, and you'll need to use a different field separator for the file (along with the field-separator option).
[20728]338 
339cu2db.params:[options] csv-filename
[20541]340
341cu2db.field-separator:Controls which character is used to separate the fields in the CSV file
342
343cu2db.already-encrypted:Use this if the passwords in the CSV file are already encrypted
344
345
346
[16136]347# -- schedule.pl --
348schedule.deleted:Scheduled execution deleted for collection
349schedule.scheduled:Execution script created for collection
350schedule.cron:Scheduled execution set up for collection
351schedule.params:[options]
352schedule.error.email:-email requires -smtp -toaddr and -fromaddr to be specified.
353schedule.error.importbuild:-import and -build must be specified.
354schedule.error.colname:Collection using -colname must be specified.
355schedule.gli:Running from the GLI
356schedule.frequency:How often to automatically re-build the collection
357schedule.frequency.hourly:Re-build every hour
358schedule.frequency.daily:Re-build every day
359schedule.frequency.weekly:Re-build every week
[24829]360schedule.filepath_warning:**** Warning: schedule.pl may not work when Greenstone is installed in a path containing brackets and/or spaces: %s.
[16136]361schedule.action:How to set up automatic re-building
362schedule.action.add:Schedule automatic re-building
363schedule.action.update:Update existing scheduling
364schedule.action.delete:Delete existing scheduling
365schedule.email:Send email notification
366schedule.schedule:Select to set up scheduled automatic collection re-building
367schedule.colname:The colletion name for which scheduling will be set up
368schedule.import:The import command to be scheduled
369schedule.build:The buildcol command to be scheduled
370schedule.toaddr:The email address to send scheduled build notifications to
371schedule.toaddr.default:Specify User's Email in File->Preferences
372schedule.fromaddr:The sender email address
373schedule.fromaddr.default:Specify maintainer in main.cfg
374schedule.smtp:The mail server that sendmail must contact to send email
375schedule.smtp.default:Specify MailServer in main.cfg
376schedule.out:Filename or handle to print output status to.
[11633]377# -- export.pl --
378
379export.exportdir:Where the export material ends up.
380
381export.cannot_open_stats_file:WARNING: Couldn't open stats file %s.
382
383export.cannot_open_fail_log:ERROR: Couldn't open fail log %s
384
385export.cannot_sort:WARNING: export.pl cannot sort documents when groupsize > 1. sortmeta option will be ignored.
386
[12409]387export.collectdir:The path of the "collect" directory.
[11633]388
389export.complete:Export complete
390
[17748]391export.debug:Print exported text to STDOUT (for GreenstoneXML exporting)
[11633]392
393export.desc:PERL script used to export files in a Greenstone collection to another format.
394
[12409]395export.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed. (Default: collectdir/collname/etc/fail.log)
[11633]396
397export.groupsize:Number of documents to group into one XML file.
398
[17068]399export.gzip:Use gzip to compress resulting xml documents (don't forget to include ZIPPlugin in your plugin list when building from compressed documents).
[11633]400
401export.importdir:Where the original material lives.
402
403export.keepold:Will not destroy the current contents of the export directory.
404
405export.maxdocs:Maximum number of documents to export.
406
[12692]407export.listall:List all the saveas formats
[11633]408
409export.saveas:Format to export documents as.
410
411export.saveas.DSpace:DSpace Archive format.
412
[14931]413export.saveas.GreenstoneMETS:METS format using the Greenstone profile.
414export.saveas.FedoraMETS:METS format using the Fedora profile.
[11633]415
[17748]416export.saveas.GreenstoneXML:Greenstone XML Archive format
[12692]417
418export.saveas.MARCXML:MARC XML format (an XML version of MARC 21)
419
[11633]420export.out:Filename or handle to print output status to.
421
[17144]422export.params:[options] collection-name
[11633]423
424export.removeold:Will remove the old contents of the export directory.
425
426export.removing_export:Removing current contents of the export directory...
427
428export.sortmeta:Sort documents alphabetically by metadata for building. This will be disabled if groupsize > 1.
429
430export.statsfile:Filename or handle to print export statistics to.
431
432export.stats_backup:Will print stats to STDERR instead.
433
434export.verbosity:Controls the quantity of output. 0=none, 3=lots.
435
436
437# -- mkcol.pl --
438
439mkcol.about:The about text for the collection.
440
[22032]441mkcol.buildtype:The 'buildtype' for the collection (e.g. mg, mgpp, lucene)
442
443mkcol.infodbtype:The 'infodbtype' for the collection (e.g. gdbm, jdbm, sqlite)
444
[11633]445mkcol.bad_name_cvs:ERROR: No collection can be named CVS as this may interfere with directories created by the CVS versioning system.
446
[15019]447mkcol.bad_name_svn:ERROR: No collection can be named .svn as this may interfere with directories created by the SVN versioning system.
448
[11633]449mkcol.bad_name_modelcol:ERROR: No collection can be named modelcol as this is the name of the model collection.
450
451mkcol.cannot_find_modelcol:ERROR: Cannot find the model collection %s
452
453mkcol.col_already_exists:ERROR: This collection already exists.
454
455mkcol.collectdir:Directory where new collection will be created.
456
[18604]457mkcol.group_not_valid_in_gs3:The group option is not valid in Greenstone 3 mode (-gs3mode).
[11633]458mkcol.creating_col:Creating the collection %s
459
460mkcol.creator:The collection creator's e-mail address.
461
462mkcol.creator_undefined:ERROR: The creator was not defined. This variable is needed to recognise duplicate collection names.
463
464mkcol.desc:PERL script used to create the directory structure for a new Greenstone collection.
465
466mkcol.doing_replacements:doing replacements for %s
467
[18419]468mkcol.group:Create a new collection group instead of a standard collection.
469
470mkcol.gs3mode:Mode for Greenstone 3 collections.
471
[11633]472mkcol.long_colname:ERROR: The collection name must be less than 8 characters so compatibility with earlier filesystems can be maintained.
473
474mkcol.maintainer:The collection maintainer's email address (if different from the creator).
475
476mkcol.no_collectdir:ERROR: The collect dir doesn't exist: %s
477
[18419]478mkcol.no_collectdir_specified:ERROR: No collect dir was specified. In gs3mode, either the -site or -collectdir option must be specified.
479
[11633]480mkcol.no_colname:ERROR: No collection name was specified.
481
482mkcol.optionfile:Get options from file, useful on systems where long command lines may cause problems.
483
484mkcol.params:[options] collection-name
485
486mkcol.plugin:Perl plugin module to use (there may be multiple plugin entries).
487
488mkcol.public:If this collection has anonymous access.
489mkcol.public.true:Collection is public
490mkcol.public.false:Collection is private
491
492mkcol.quiet:Operate quietly.
493
[18419]494mkcol.site:In gs3mode, uses this site name with the GSDL3HOME environment variable to determine collectdir, unless -collectdir is specified.
495
[11633]496mkcol.success:The new collection was created successfully at %s
497
498mkcol.title:The title of the collection.
499
500mkcol.win31compat:Whether or not the named collection directory must conform to Windows 3.1 file conventions or not (i.e. 8 characters long).
501mkcol.win31compat.true:Directory name 8 characters or less
502mkcol.win31compat.false:Directory name any length
503
504# -- pluginfo.pl --
505
[12639]506pluginfo.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.
[11633]507
508pluginfo.desc:Prints information about a plugin.
509
510pluginfo.general_options:General options are inherited from parent classes of the plugin.
511
512pluginfo.info:info
513
514pluginfo.no_plugin_name:ERROR: You must provide a plugin name.
515
516pluginfo.option_types:Plugins may take two types of options
517
518pluginfo.params:[options] plugin-name
519
520pluginfo.passing_options:Options may be passed to any plugin by including them in your collect.cfg configuration file.
521
522pluginfo.specific_options:Specific options are defined within the plugin itself, and are available only to this particular plugin.
523
524
[12332]525# -- plugoutinfo.pl --
526
[12639]527plugoutinfo.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.
[12332]528
529plugoutinfo.desc:Prints information about a plugout.
530
531plugoutinfo.general_options:General options are inherited from parent classes of the plugout.
532
533plugoutinfo.info:info
534
535plugoutinfo.no_plugout_name:ERROR: You must provide a plugout name.
536
537plugoutinfo.option_types:Plugouts may take two types of options
538
539plugoutinfo.params:[options] plugout-name
540
541plugoutinfo.passing_options:Options may be passed to any plugout by including them in your collect.cfg configuration file.
542
543plugoutinfo.specific_options:Specific options are defined within the plugout itself, and are available only to this particular plugout.
544
545
546
547#
[11633]548# Classifier option descriptions
549#
550
[12743]551AllList.desc:Creates a single list of all documents. Use by the oaiserver.
552
[11633]553AZCompactList.allvalues:Use all metadata values found.
554
[19528]555AZCompactList.desc:Classifier plugin for sorting alphabetically (on a-z, A-Z, 0-9). Produces a horizontal A-Z list, then a vertical list containing documents, or bookshelves for documents with common metadata.
[11633]556
557AZCompactList.doclevel:Level to process document at.
558AZCompactList.doclevel.top:Whole document.
[28197]559AZCompactList.doclevel.firstlevel:The first level of sections only
560AZCompactList.doclevel.section:All sections.
[11633]561
562AZCompactList.firstvalueonly:Use only the first metadata value found.
563
564AZCompactList.freqsort:Sort by node frequency rather than alpha-numeric.
565
566AZCompactList.maxcompact:Maximum number of documents to be displayed per page.
567
[19528]568AZCompactList.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.
[11633]569
570AZCompactList.mincompact:Minimum number of documents to be displayed per page.
571
572AZCompactList.mingroup:The smallest value that will cause a group in the hierarchy to form.
573
574AZCompactList.minnesting:The smallest value that will cause a list to be converted into a nested list.
575
576AZCompactList.recopt:Used in nested metadata such as -metadata Year/Organisation.
577AZCompactList.sort:Metadata field to sort the leaf nodes by.
578
579AZCompactSectionList.desc:Variation on AZCompactList that classifies sections rather than documents. Entries are sorted by section-level metadata.
580
[19549]581AZList.desc:Classifier plugin for sorting alphabetically (on a-z, A-Z, 0-9). Produces a horizontal A-Z list, with documents listed underneath.
[11633]582
[19528]583AZList.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.
[11633]584
[12743]585AZSectionList.desc:Variation on AZList that classifies sections rather that documents. Entries are sorted by section-level metadata.
[11633]586
[12547]587BasClas.bad_general_option:The %s classifier uses an incorrect option. Check your collect.cfg configuration file.
[11633]588
589BasClas.builddir:Where to put the built indexes.
590
591BasClas.buttonname:The label for the classifier screen and button in navigation bar. The default is the metadata element specified with -metadata.
592
593BasClas.desc:Base class for all the classifiers.
594
595BasClas.no_metadata_formatting:Don't do any automatic metadata formatting (for sorting.)
596
597BasClas.outhandle:The file handle to write output to.
598
599BasClas.removeprefix:A prefix to ignore in metadata values when sorting.
600
601BasClas.removesuffix:A suffix to ignore in metadata values when sorting.
602
603BasClas.verbosity:Controls the quantity of output. 0=none, 3=lots.
604
[12743]605Browse.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.
[11633]606
607DateList.bymonth:Classify by year and month instead of only year.
608
[12743]609DateList.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.
[11633]610
[12743]611DateList.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.
[11633]612
613DateList.reverse_sort:Sort the documents in reverse chronological order (newest first).
614
615DateList.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).
616
[11653]617DateList.no_special_formatting:Don't display Year and Month information in the document list.
618
[11633]619DateList.sort:An extra metadata field to sort by in the case where two documents have the same date.
620
621HFileHierarchy.desc:Classifier plugin for generating hierarchical classifications based on a supplementary structure file.
622
623Hierarchy.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).
624
625Hierarchy.documents_last:Display document nodes after classifier nodes.
626
627Hierarchy.hfile:Use the specified classification structure file.
628
629Hierarchy.hlist_at_top:Display the first level of the classification horizontally.
630
631Hierarchy.reverse_sort:Sort leaf nodes in reverse order (use with -sort).
632
633Hierarchy.separator:Regular expression used for the separator, if using structured metadata.
634
635Hierarchy.sort:Metadata field to sort leaf nodes by. Leaves will not be sorted if not specified.
636
637Hierarchy.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.
638
639Hierarchy.suppresslastlevel:Ignore the final part of the metadata value. This is useful for metadata where each value is unique, such as file paths.
640
641HTML.desc:Creates an empty classification that's simply a link to a web page.
642
643HTML.url:The url of the web page to link to.
644
[19219]645List.bookshelf_type:Controls when to create bookshelves
[19014]646List.bookshelf_type.always:Create a bookshelf icon even if there is only one item in each group at the leaf nodes.
647List.bookshelf_type.never:Never create a bookshelf icon even if there are more than one item in each group at the leaf nodes.
648List.bookshelf_type.duplicate_only:Create a bookshelf icon only when there are more than one item in each group at the leaf nodes.
649
[19244]650List.classify_sections:Classify sections instead of documents.
[11633]651
[19244]652List.desc:A general and flexible list classifier with most of the abilities of AZCompactList, but with better Unicode, metadata and sorting capabilities.
[26268]653List.filter_metadata:Metadata element to test against for a document's inclusion into the classifier. Documents will be included if they define this metadata.
654List.filter_regex:Regular expression to use in the filter_metadata test. If a regex is specified, only documents with filter_metadata that matches this regex will be included.
[20008]655List.level_partition.none:None.
[19014]656List.level_partition.per_letter:Create a partition for each letter.
[20864]657List.level_partition.constant_size:Create partitions with constant size.
658List.level_partition.approximate_size:Create a partition per letter, then group or split the letters to get approximately the same sized partitions.
[19014]659
[29094]660List.metadata:Metadata fields used for classification. Use '/' to separate the levels in the hierarchy and ';' or ',' to separate metadata fields within each level.
[11633]661
[29094]662List.metadata_selection_mode:Determines how many metadata values the document is classified by, within each level. Use '/' to separate the levels.
663List.metadata_selection.firstvalue:Only classify by a single metadata value, the first one encountered.
664List.metadata_selection.firstvalidmetadata:Classify by all the metadata values of the first element in the list that has values.
665List.metadata_selection.allvalues:Classify by all metadata values found, from all elements in the list.
[19244]666List.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'.
[11633]667
[20864]668List.partition_size_within_level:The number of items in each partition (only applies when partition_type_within_level is set to 'constant_size' or 'approximate_size'). Can be specified for each level. Separate levels by '/'.
[19244]669
[20864]670List.partition_type_within_level:The type of partitioning done. Can be specified for each level. Separate levels by '/'.
[19244]671
[23303]672List.reverse_sort_leaf_nodes:Sort the leaf documents in reverse order.
673
[19244]674List.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.
675
676List.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.
677
[27098]678List.standardize_capitalization:Metadata values are lowercased for sorting into bookshelves. Set this option to use these lowercase values for bookshelf display names. Otherwise, the majority case variant will be used.
679
[19244]680List.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.
681
[19528]682SimpleList.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.
[19244]683
684SimpleList.desc:Simple list classifier plugin.
685
686SimpleList.sort:Metadata field to sort by. Use '-sort nosort' for no sorting.
687
[12743]688Phind.desc:Produces a hierarchy of phrases found in the text, which is browsable via an applet.
[11633]689
690Phind.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.
691
692Phind.min_occurs:The minimum number of times a phrase must appear in the text to be included in the phrase hierarchy.
693
694Phind.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.
695
696Phind.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.
697
698Phind.text:The text used to build the phrase hierarchy.
699
700Phind.thesaurus:Name of a thesaurus stored in Phind format in the collection's etc directory.
701
702Phind.title:The metadata field used to describe each document.
703
704Phind.untidy:Don't remove working files.
705
[13901]706RecentDocumentsList.desc:Classifier that gives a list of newly added or modified documents.
707
708RecentDocumentsList.include_docs_added_since:Include only documents modified or added after the specified date (in yyyymmdd or yyyy-mm-dd format).
709
710RecentDocumentsList.include_most_recently_added:Include only the specified number of most recently added documents. Only used if include_docs_added_since is not specified.
711
712RecentDocumentsList.sort:Metadata to sort List by. If not specified, list will be sorted by date of modification/addition.
713
[11633]714SectionList.desc:Same as List classifier but includes all sections of document (excluding top level) rather than just top level document itself.
715
[12743]716Collage.desc:An applet is used to display a collage of images found in the collection.
[11633]717
[19528]718Collage.geometry:The dimensions of the collage canvas. For a canvas 600 pixels wide by 400 pixels high, for example, specify geometry as 600x400
[11633]719
720Collage.maxDepth:Images for collaging are drawn from mirroring the underlying browse classifier. This controls the maximum depth of the mirroring process.
721
722Collage.maxDisplay:The maximum number of images to show in the collage at any one time.
723
724Collage.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.
725
726Collage.bgcolor:The background color of the collage canvas, specified in hexadecimal form (for example #008000 results in a forest green background).
727
728Collage.buttonname:The label for the classifier screen and button in navigation bar.
729
730Collage.refreshDelay:Rate, in milliseconds, that the collage canvas is refreshed.
731
[19528]732Collage.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.
[11633]733
734Collage.imageMustNotHave:Used to suppress images that should not appear in the collage, such as image buttons that make up the navigation bar.
735
736Collage.caption:Optional captions to display below the collage canvas.
737
[13838]738
[11633]739#
740# Plugin option descriptions
741#
[16017]742AcronymExtractor.adding:adding
[11633]743
[16017]744AcronymExtractor.already_seen:already seen
[11633]745
[16017]746AcronymExtractor.desc:Helper extractor plugin for location and marking up acronyms in text.
[11633]747
[16017]748AcronymExtractor.done_acronym_extract:done extracting acronyms.
[11633]749
[16017]750AcronymExtractor.done_acronym_markup:done acronym markup.
[11633]751
[16017]752AcronymExtractor.extract_acronyms:Extract acronyms from within text and set as metadata.
[11633]753
[16017]754AcronymExtractor.extracting_acronyms:extracting acronyms
[11633]755
[16017]756AcronymExtractor.marking_up_acronyms:marking up acronyms
[11633]757
[16017]758AcronymExtractor.markup_acronyms:Add acronym metadata into document text.
[11633]759
[21566]760ArchivesInfPlugin.desc:Plugin which processes the archive info database (archiveinf-doc) which is generated by the import process. It passes each archive file listed in the database to the plugin pipeline to be processed by GreenstoneXMLPlugin.
[27697]761ArchivesInfPlugin.reversesort:Sort in reverse alphabetical order. Useful if the -sortmeta option was used with import.pl.
762ArchivesInfPlugin.sort:Sort in ascending alphabetical order. Useful if the -sortmeta option was used with import.pl.
[11633]763
[19528]764AutoExtractMetadata.desc: Base plugin that brings together all the extractor functionality from the extractor plugins.
[11633]765
[16017]766AutoExtractMetadata.extracting:extracting
[11633]767
[19549]768AutoExtractMetadata.first:Comma separated list of numbers of characters to extract from the start of the text into a set of metadata fields called 'FirstN', where N is the size. For example, the values "3,5,7" will extract the first 3, 5 and 7 characters into metadata fields called "First3", "First5" and "First7".
[11633]769
[23158]770AutoLoadConverters.desc:Helper plugin that dynamically loads up extension converter plugins.
[24728]771AutoloadConverter.noconversionavailable:Conversion not available
[23158]772
[17587]773BaseMediaConverter.desc:Helper plugin that provides base functionality for media converter plugins such as ImageConverter and video converters.
774
[31496]775BaseImporter.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.
[11633]776
[31496]777BaseImporter.associate_tail_re:A regular expression to match filenames against to find associated files. Used as a more powerful alternative to associate_ext.
[11633]778
[31496]779BaseImporter.desc:Base class for all the import plugins.
[11633]780
[31496]781BaseImporter.dummy_text:This document has no text.
[16017]782
[31496]783BaseImporter.no_cover_image:Do not look for a prefix.jpg file (where prefix is the same prefix as the file being processed) to associate as a cover image.
[11633]784
[31496]785BaseImporter.OIDtype.auto:Use OIDtype set in import.pl
[11633]786
[31496]787BaseImporter.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).
[11633]788
[31496]789BaseImporter.processing_tmp_files:Internal flag, set by converter plugins to indicate that we are processing a tmp file.
[11633]790
[31496]791BaseImporter.smart_block:Block files in a smarter way than just looking at filenames.
[11633]792
[31496]793BaseImporter.store_original_file:Save the original source document as an associated file. Note this is already done for files like PDF, Word etc. This option is only useful for plugins that don't already store a copy of the original file.
[11633]794
[31496]795BaseImporter.file_rename_method:The method to be used in renaming the copy of the imported file and associated files.
[16556]796
[31496]797BaseImporter.rename_method.url:Use url encoding in renaming imported files and associated files.
[16556]798
[31496]799BaseImporter.rename_method.base64:Use base64 encoding in renaming imported files and associated files.
[16556]800
[31496]801BaseImporter.rename_method.none:Don't rename imported files and associated files.
[16556]802
[31496]803BibTexPlugin.desc:BibTexPlugin reads bibliography files in BibTex format. BibTexPlugin creates a document object for every reference in the file. This plugin is a subclass of SplitTextFile class, so if there are multiple records, all are read.
[17056]804
[31496]805BookPlugin.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 HTMLPlugin type of processing is done, such as processing html links). 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 Development 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 appearing after a <<TOC>> tag and on the same line as 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.
[11633]806
[31496]807CommonUtil.block_exp:Files matching this regular expression will be blocked from being passed to any later plugins in the list.
[17056]808
[31496]809CommonUtil.desc:Base Utility plugin class that handles filename encoding and file blocking.
[11633]810
[31496]811CommonUtil.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.
[20795]812
[31496]813CommonUtil.encoding.unicode:Just unicode.
[11633]814
[31496]815CommonUtil.encoding.utf8:Either utf8 or unicode -- automatically detected.
[22216]816
[31496]817CommonUtil.filename_encoding:The encoding of the source file filenames.
[18319]818
[31496]819CommonUtil.filename_encoding.auto:Automatically detect the encoding of the filename.
[18319]820
[31496]821CommonUtil.filename_encoding.auto_language_analysis:Auto-detect the encoding of the filename by analysing it.
[18319]822
[31496]823CommonUtil.filename_encoding.auto_filesystem_encoding:Auto-detect the encoding of the filename using filesystem encoding.
[18404]824
[31496]825CommonUtil.filename_encoding.auto_fl:Uses filesystem encoding then language analysis to detect the filename encoding.
[11633]826
[31496]827CommonUtil.filename_encoding.auto_lf:Uses language analysis then filesystem encoding to detect the filename encoding.
[11633]828
[31496]829CommonUtil.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.
830
[16018]831CONTENTdmPlugin.desc:Plugin that processes RDF files in exported CONTENTdm collections.
832
[16017]833ConvertBinaryFile.apply_fribidi:Run the "fribidi" Unicode Bidirectional Algorithm program over the converted file (for right-to-left text).
[11633]834
[16017]835ConvertBinaryFile.convert_to:Plugin converts to TEXT or HTML or various types of Image (e.g. JPEG, GIF, PNG).
[11633]836
[19528]837ConvertBinaryFile.convert_to.auto:Automatically select the format converted to. 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.
[11633]838
[16017]839ConvertBinaryFile.convert_to.html:HTML format.
[11633]840
[16017]841ConvertBinaryFile.convert_to.text:Plain text format.
[11633]842
[16018]843ConvertBinaryFile.convert_to.pagedimg:A series of images.
[11633]844
[16018]845ConvertBinaryFile.convert_to.pagedimg_jpg:A series of images in JPEG format.
[11633]846
[16018]847ConvertBinaryFile.convert_to.pagedimg_gif:A series of images in GIF format.
[11633]848
[16018]849ConvertBinaryFile.convert_to.pagedimg_png:A series of images in PNG format.
850
[17748]851ConvertBinaryFile.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'.
[11633]852
[16017]853ConvertBinaryFile.keep_original_filename:Keep the original filename for the associated file, rather than converting to doc.pdf, doc.doc etc.
[11633]854
[16017]855ConvertBinaryFile.use_strings:If set, a simple strings function will be called to extract text if the conversion utility fails.
[11633]856
[16017]857ConvertToRogPlugin.desc:A plugin that inherits from RogPlugin.
[11633]858
[16017]859CSVPlugin.desc:A plugin for files in comma-separated value format. A new document will be created for each line of the file.
[11633]860
[16017]861DateExtractor.desc:Helper extractor plugin for extracting historical date information from text.
[11633]862
[16017]863DateExtractor.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.
[11633]864
[16017]865DateExtractor.maximum_century:The maximum named century to be extracted as historical metadata (e.g. 14 will extract all references up to the 14th century).
[11633]866
[16017]867DateExtractor.maximum_year:The maximum historical date to be used as metadata (in a Common Era date, such as 1950).
[11633]868
[16017]869DateExtractor.no_bibliography:Do not try to block bibliographic dates when extracting historical dates.
[11633]870
[16017]871DirectoryPlugin.desc:A plugin which recurses through directories processing each file it finds.
[11633]872
[16017]873DirectoryPlugin.recheck_directories:After the files in an import directory have been processed, re-read the directory to discover any new files created.
[11633]874
[19315]875DirectoryPlugin.use_metadata_files:SUPERSEDED - Add MetadataXMLPlugin to the list of plugins in order to read metadata from metadata XML files.
[11633]876
[17748]877DatabasePlugin.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.
[11633]878
[16017]879DSpacePlugin.desc:A plugin that takes a collection of documents exported from DSpace and imports them into Greenstone.
880   
[19549]881DSpacePlugin.first_inorder_ext: This is used to identify the primary document file for a DSpace collection document. With this option, the system will treat the defined ext types of document in sequence to look for the primary document file.
[11633]882
[19549]883DSpacePlugin.first_inorder_mime:This is used to identify the primary document file for a DSpace collection document. With this option, the system will treat the defined mime types of document in sequence to look for the primary document file.
[11633]884
[19549]885DSpacePlugin.only_first_doc:This is used to identify the primary document file for a DSpace collection document. With this option, the system will treat the first document referenced in the dublin_core metadata file as the primary document file.
[11633]886
[16017]887EmailAddressExtractor.desc:Helper extractor plugin for discovering email addresses in text.
[11633]888
[16017]889EmailAddressExtractor.done_email_extract:done extracting e-mail addresses.
[12742]890
[16017]891EmailAddressExtractor.extracting_emails:extracting e-mail addresses
[11633]892
[16017]893EmailAddressExtractor.extract_email:Extract email addresses as metadata.
[11633]894
[31899]895EmailPlugin.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)
[11633]896
[15968]897EmailPlugin.no_attachments:Do not save message attachments.
[11633]898
[15968]899EmailPlugin.headers:Store email headers as "Headers" metadata.
[11633]900
[17056]901EmailPlugin.OIDtype.message_id:Use the message identifier as the document OID. If no message identifier is found, then will use a hash OID.
902
[15968]903EmailPlugin.split_exp:A perl regular expression used to split files containing many messages into individual documents.
[11633]904
[20883]905EmbeddedMetadataPlugin.desc:Plugin that extracts embedded metadata from a variety of file types. It is based on the CPAN module 'ExifTool which includes support for over 70 file formats and 20 metadata formats.  Highlights include: video formats such as AVI, ASF, FLV, MPEG, OGG Vorbis, and WMV; image formats such as BMP, GIF, JPEG, JPEG 2000 and  PNG; audio formats such as AIFF, RealAudio, FLAC, MP3, and WAV; Office document formats such as Encapsulated PostScript, HTML, PDF, and Word.  More details are available at the ExifTool home page http://www.sno.phy.queensu.ca/~phil/exiftool/
[24291]906EmbeddedMetadataPlugin.join_before_split:Join fields with multiple entries (e.g. Authors or Keywords) before they are (optionally) split using the specified separator.
907EmbeddedMetadataPlugin.join_character:The character to use with join_before_split (default is a single space).
908EmbeddedMetadataPlugin.trim_whitespace:Trim whitespace from start and end of any extracted metadata values (Note: this also applies to any values generated through joining with join_before_split or splitting through metadata_field_separator).
[24487]909EmbeddedMetadataPlugin.set_filter_list:A comma-separated list of the metadata sets we would like to retrieve.
[24854]910EmbeddedMetadataPlugin.set_filter_regexp:A regular expression that selects the metadata we would like to retrieve.
[20863]911
[15968]912ExcelPlugin.desc:A plugin for importing Microsoft Excel files (versions 95 and 97).
[11633]913
[16018]914FavouritesPlugin.desc:Plugin to process Internet Explorer Favourites files.
915
[19549]916FOXPlugin.desc:Plugin to process a Foxbase dbt file. This plugin only provides the basic functionality to read in the dbt and dbf files and process each record. A customized plugin based on this general one would need to be written for a particular database to process the appropriate fields.
[11633]917
[17748]918GreenstoneXMLPlugin.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.
[11633]919
[16017]920GISExtractor.desc:Helper extractor plugin for extracting placenames from text. Requires GIS extension to Greenstone.
921
[15968]922GISExtractor.extract_placenames:Extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
[11633]923
[15968]924GISExtractor.gazetteer:Gazetteer to use to extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
[11633]925
[15968]926GISExtractor.place_list:When extracting placements, include list of placenames at start of the document. Requires GIS extension to Greenstone.
[11633]927
[19528]928HBPlugin.desc:Plugin which processes an HTML book directory. This plugin is used by the Humanity Development Library collections and does not handle input encodings other than ASCII or extended ASCII. This code is not very clean and could no doubt be made to run faster, by leaving it in this state we hope to encourage the utilisation of 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
[11633]929
[16018]930HBPlugin.encoding.iso_8859_1:Latin1 (western languages)
931
[17748]932HTMLImagePlugin.aggressiveness:Range of related text extraction techniques to use.
[19549]933HTMLImagePlugin.aggressiveness.1:Filename, path, alternative text (ALT attributes in img HTML tags) only.
[17748]934HTMLImagePlugin.aggressiveness.2:All of 1, plus caption where available.
935HTMLImagePlugin.aggressiveness.3:All of 2, plus near paragraphs where available.
936HTMLImagePlugin.aggressiveness.4:All of 3, plus previous headers (<h1>, <h2>...) where available.
937HTMLImagePlugin.aggressiveness.5:All of 4, plus textual references where available.
[19549]938HTMLImagePlugin.aggressiveness.6:All of 4, plus metadata tags in HTML pages (title, keywords, etc).
[17748]939HTMLImagePlugin.aggressiveness.7:All of 6, 5 and 4 combined.
[19549]940HTMLImagePlugin.aggressiveness.8:All of 7, plus duplicating filename, path, alternative text, and caption (raise ranking of more relevant results).
[17748]941HTMLImagePlugin.aggressiveness.9:All of 1, plus full text of source page.
942
943HTMLImagePlugin.caption_length:Maximum length of captions (in characters).
944
945HTMLImagePlugin.convert_params:Additional parameters for ImageMagicK convert on thumbnail creation. For example, '-raise' will give a three dimensional effect to thumbnail images.
946
947HTMLImagePlugin.desc:A plugin for extracting images and associated text from webpages.
948
949HTMLImagePlugin.document_text:Add image text as document:text (otherwise IndexedText metadata field).
950
951HTMLImagePlugin.index_pages:Index the pages along with the images. Otherwise reference the pages at the source URL.
952
953HTMLImagePlugin.max_near_text:Maximum characters near images to extract.
954
955HTMLImagePlugin.min_height:Pixels. Skip images shorter than this.
956
957HTMLImagePlugin.min_near_text:Minimum characters of near text or caption to extract.
958
959HTMLImagePlugin.min_size:Bytes. Skip images smaller than this.
960
961HTMLImagePlugin.min_width:Pixels. Skip images narrower than this.
962
963HTMLImagePlugin.neartext_length:Target length of near text (in characters).
964
965HTMLImagePlugin.no_cache_images:Don't cache images (point to URL of original).
966
967HTMLImagePlugin.smallpage_threshold:Images on pages smaller than this (bytes) will have the page (title, keywords, etc) meta-data added.
968
969HTMLImagePlugin.textrefs_threshold:Threshold for textual references. Lower values mean the algorithm is less strict.
970
971HTMLImagePlugin.thumb_size:Max thumbnail size. Both width and height.
972
[15968]973HTMLPlugin.assoc_files:Perl regular expression of file extensions to associate with html documents.
[11633]974
[15968]975HTMLPlugin.desc:This plugin processes HTML files
[11633]976
[15968]977HTMLPlugin.description_tags:Split document into sub-sections where <Section> tags occur. '-keep_head' will have no effect when this option is set.
[11633]978
[15968]979HTMLPlugin.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.
[12947]980
[15968]981HTMLPlugin.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.
[11633]982
[15968]983HTMLPlugin.hunt_creator_metadata:Find as much metadata as possible on authorship and place it in the 'Creator' field.
[11633]984
[15968]985HTMLPlugin.keep_head:Don't remove headers from html files.
[11633]986
[21765]987HTMLPlugin.metadata_fields:Comma separated list of metadata fields to attempt to extract. Capitalise this as you want the metadata capitalised in Greenstone, since the tag extraction is case insensitive. e.g. Title,Date. Use 'tag<tagname>' to have the contents of the first <tag> pair put in a metadata element called 'tagname'. e.g. Title,Date,Author<Creator>
[11633]988
[21800]989HTMLPlugin.metadata_field_separator:Separator character used in multi-valued metadata. Will split a metadata field value on this character, and add each item as individual metadata.
990
[15968]991HTMLPlugin.no_metadata:Don't attempt to extract any metadata from files.
[11633]992
[15968]993HTMLPlugin.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.
[11633]994
[15968]995HTMLPlugin.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).
[11633]996
[15968]997HTMLPlugin.no_image_links:Don't make any attempt to trap image links to allow view images.
[14997]998
[15968]999HTMLPlugin.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).
[11633]1000
[15968]1001HTMLPlugin.sectionalise_using_h_tags:Automatically create a sectioned document using h1, h2, ... hX tags.
[11633]1002
[17068]1003HTMLPlugin.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.
[11633]1004
[15968]1005HTMLPlugin.tidy_html:If set, converts an HTML document into a well-formed XHTML to enable users view the document in the book format.
[13968]1006
[15968]1007HTMLPlugin.old_style_HDL:To mark whether the file in this collection used the old HDL document's tags style.
[14012]1008
[18555]1009BaseMediaConverter.enable_cache:Cache automatically generated files (such as thumbnails and screen-size images) so they don't need to be repeatedly generated.
[16018]1010
[16017]1011ImageConverter.converttotype:Convert main image to format 's'.
1012
1013ImageConverter.create_screenview:If set to true, create a screen sized image, and set Screen, ScreenType, screenicon, ScreenWidth, ScreenHeight metadata.
1014
1015ImageConverter.create_thumbnail:If set to true, create a thumbnail version of each image, and add Thumb, ThumbType, thumbicon, ThumbWidth, ThumbHeight metadata.
1016ImageConverter.desc:Helper plugin for image conversion using ImageMagick.
1017
[18986]1018ImageConverter.imagemagicknotinstalled:Image Magick not installed
[11633]1019
[16017]1020ImageConverter.minimumsize:Ignore images smaller than n bytes.
[11633]1021
[16017]1022ImageConverter.noconversionavailable:Image conversion not available
[11633]1023
[16017]1024ImageConverter.noscaleup:Don't scale up small images when making thumbnails.
[11633]1025
[16017]1026ImageConverter.screenviewsize:Make screenview images of size nxn.
[14967]1027
[16017]1028ImageConverter.screenviewtype:Make screenview images in format 's'.
[11633]1029
[16017]1030ImageConverter.thumbnailsize:Make thumbnails of size nxn.
[11633]1031
[16017]1032ImageConverter.thumbnailtype:Make thumbnails in format 's'.
[14967]1033
[16017]1034ImageConverter.win95notsupported: Image Magick not supported on Win95/98
[11633]1035
[16017]1036ImagePlugin.desc:This plugin processes images, adding basic metadata
[11633]1037
[15968]1038IndexPlugin.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'.
[11633]1039
[15968]1040ISISPlugin.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).
[11633]1041
[15968]1042ISISPlugin.subfield_separator:The string used to separate subfields in CDS/ISIS database records.
[11633]1043
[15968]1044ISISPlugin.entry_separator:The string used to separate multiple values for single metadata fields in CDS/ISIS database records.
[11633]1045
[16017]1046KeyphraseExtractor.desc:Helper extractor plugin for generating keyphrases from text. Uses Kea keyphrase extraction system.
1047
1048KeyphraseExtractor.extract_keyphrases:Extract keyphrases automatically with Kea (default settings).
1049
1050KeyphraseExtractor.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.
1051
1052KeyphraseExtractor.extract_keyphrase_options:Options for keyphrase extraction with Kea. For example: mALIWEB - use ALIWEB extraction model; n5 - extract 5 keyphrase;, eGBK - use GBK encoding.
1053
1054KeyphraseExtractor.keyphrases:keyphrases
1055
1056KeyphraseExtractor.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.
1057
[15968]1058LaTeXPlugin.desc:Plugin for LaTeX documents.
[11633]1059
[15968]1060LOMPlugin.desc:Plugin for importing LOM (Learning Object Metadata) files.
[13335]1061
[15968]1062LOMPlugin.root_tag:The DocType of the XML file (or a regular expression that matches the root element).
[16017]1063
[15968]1064LOMPlugin.check_timestamp:Check timestamps of previously downloaded files, and only download again if source file is newer.
[16017]1065
[15968]1066LOMPlugin.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.
[13335]1067
[15968]1068MARCPlugin.desc:Basic MARC plugin.
[11633]1069
[18883]1070MARCPlugin.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.
[11633]1071
[15968]1072MARCXMLPlugin.desc:MARCXML plugin.
[13150]1073
[18883]1074MARCXMLPlugin.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.
[13150]1075
[22402]1076MediainfoOGVPlugin.desc:Plugin for importing OGV movie files. Requires Mediainfo (mediainfo.sourceforge.net) to be installed to extract metadata.
1077
1078MediainfoOGVPlugin.assoc_field:Name of the metadata field that will hold the movie file's name.
1079
[15968]1080MediaWikiPlugin.desc:Plugin for importing MediaWiki web pages
[14252]1081
[15968]1082MediaWikiPlugin.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.
[14252]1083
[15968]1084MediaWikiPlugin.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.
[14252]1085
[18643]1086MediaWikiPlugin.toc_exp:A Perl regular expression to match the 'table of contents'. The default value matches common MediaWiki web pages.
[14252]1087
[15968]1088MediaWikiPlugin.delete_nav:Delete the navigation section. Needs to specify a Perl regular expression in nav_div_exp below.
[14252]1089
[15968]1090MediaWikiPlugin.nav_div_exp:A Perl regular expression to match the navigation section. The default value matches common MediaWiki web pages.
[14252]1091
[15968]1092MediaWikiPlugin.delete_searchbox:Delete the searchbox section. Needs to specify a Perl regular expression in searchbox_div_exp below.
[14252]1093
[16017]1094MediaWikiPlugin.searchbox_div_exp:A Perl regular expression to match the searchbox section. The default value matches common MediaWiki web pages.
[14252]1095
[15968]1096MediaWikiPlugin.remove_title_suffix_exp:A Perl regular expression to trim the extracted title. For example, \\s-(.+) will trim title contents after "-".
[14252]1097
[15968]1098MetadataCSVPlugin.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.
[12742]1099
[31496]1100MetadataPass.desc:On-the-side base class to BaseImporter that supports metadata plugins utilise metadata_read pass of import.pl
[12742]1101
[16018]1102MetadataXMLPlugin.desc:Plugin that processes metadata.xml files.
1103
[17029]1104GreenstoneMETSPlugin.desc:Process Greenstone-style METS documents
[12742]1105
[16017]1106MP3Plugin.desc:Plugin for processing MP3 files.
[11633]1107
[16017]1108MP3Plugin.assoc_images:Use Google image search to locate images related to MP3 file based on ID3 Title and Artist metadata.
1109
1110MP3Plugin.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.
1111
1112MP3Plugin.metadata_fields:Comma separated list of metadata fields to extract (assuming present) in an MP3 file. Use \"*\" to extract all the fields.
1113
[15968]1114NulPlugin.desc:Dummy (.nul) file plugin. Used with the files produced by exploding metadata database files.
[11633]1115
[15968]1116NulPlugin.assoc_field:Name of a metadata field that will be set for each nul file.
1117NulPlugin.add_metadata_as_text:Add a table of metadata as the text of the document, rather than "This document has no text".
[13419]1118
[15968]1119NulPlugin.remove_namespace_for_text:Remove namepsaces from metadata names in the document text (if add_metadata_as_text is set).
[13419]1120
[15968]1121OAIPlugin.desc:Basic Open Archives Initiative (OAI) plugin.
[11633]1122
[17587]1123OAIPlugin.document_field:The metadata element specifying the file name of documents to attach the metadata to.
1124
[18915]1125OAIPlugin.metadata_set:Metadata set (namespace prefix) to import all metadata as
1126OAIPlugin.metadata_set.auto:Use the prefixes specified in the OAI record
1127OAIPlugin.metadata_set.dc: Use the dc prefix. Will map qualified dc elements into their Greenstone form, eg spatial becomes dc.Coverage^spatial.
1128
[23158]1129OAIMetadataXMLPlugin.desc:Version of MetadataXMLPlugin that processes metadata.xml files. Additionally, it uses the "dc.Identifier" field and extracts OAI metadata from the specified OAI server (-oai_server_http_path)
1130
[22232]1131OAIMetadataXMLPlugin.oai_server_http_path: HTTP Path to the OAI server - e.g. http://test.com/oai_server/oai.pl
1132
1133OAIMetadataXMLPlugin.metadata_prefix: OAI metadata prefix - default oai_dc
1134
1135OAIMetadataXMLPlugin.koha_mode: If specified, the plugin will try to generate the oaiextracted.koharecordlink metadata. This metadata contains the link back to Koha document.
1136
[15968]1137OggVorbisPlugin.add_technical_metadata:Add technical (eg. bitrate) metadata.
[11633]1138
[15968]1139OggVorbisPlugin.desc:A plugin for importing Ogg Vorbis audio files.
[11633]1140
[15968]1141OpenDocumentPlugin.desc:Plugin for OASIS OpenDocument format documents (used by OpenOffice 2.0)
[11633]1142
[15968]1143PagedImagePlugin.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.
[11633]1144
[15968]1145PagedImagePlugin.documenttype:Set the document type (used for display)
[16017]1146
[25960]1147PagedImagePlugin.documenttype.auto2:Automatically set document type based on item file format. Uses 'paged' for documents with a single sequence of pages, and 'hierarchy' for documents with internal structure (i.e. from XML item files containing PageGroup elements).
1148PagedImagePlugin.documenttype.auto3:Automatically set document type based on item file format. Uses 'paged' for documents with a single sequence of pages, and 'pagedhierarchy' for documents with internal structure (i.e. from XML item files containing PageGroup elements).
[16017]1149
[25960]1150PagedImagePlugin.documenttype.paged2:Paged documents have a linear sequence of pages and no internal structure. They will be displayed with next and previous arrows and a 'go to page X' box.
1151PagedImagePlugin.documenttype.paged3:Paged documents have a linear sequence of pages and no internal structure. They will be displayed with a scrolling list of page images.
[11633]1152
[25960]1153PagedImagePlugin.documenttype.hierarchy: Hierarchical documents have internal structure and will be displayed with a table of contents
1154
1155PagedImagePlugin.documenttype.pagedhierarchy: (Greenstone 3 only) These documents have internal structure and sequences of pages. They will be displayed with a table of contents and scrolling lists of pages.
1156
[15968]1157PagedImagePlugin.headerpage:Add a top level header page (that contains no image) to each document.
[11633]1158
[16017]1159PDFPlugin.allowimagesonly:Allow PDF files with no extractable text. Avoids the need to have -complex set. Only useful with convert_to html.
[11633]1160
[15968]1161PDFPlugin.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).
[11633]1162
[15968]1163PDFPlugin.desc:Plugin that processes PDF documents.
[11633]1164
[15968]1165PDFPlugin.nohidden:Prevent pdftohtml from attempting to extract hidden text. This is only useful if the -complex option is also set.
[11633]1166
[15968]1167PDFPlugin.noimages:Don't attempt to extract images from PDF.
[11633]1168
[29102]1169PDFPlugin.use_realistic_book:Converts the PDF to a well-formed XHTML document to enable users view it in the realistic book format.
1170
[15968]1171PDFPlugin.use_sections:Create a separate section for each page of the PDF file.
[11633]1172
[15968]1173PDFPlugin.zoom:The factor by which to zoom the PDF for output (this is only useful if -complex is set).
[11633]1174
[17748]1175PostScriptPlugin.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
[11633]1176
[17748]1177PostScriptPlugin.extract_date:Extract date from PS header.
[11633]1178
[17748]1179PostScriptPlugin.extract_pages:Extract pages from PS header.
1180
1181PostScriptPlugin.extract_title:Extract title from PS header.
1182
1183PowerPointPlugin.desc:A plugin for importing Microsoft PowerPoint files.
1184
1185PowerPointPlugin.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.
1186
[22881]1187PowerPointPlugin.convert_to.html_multi:A series of HTML pages, two per slide. One for the slide image, one for the slide text (needs -openoffice_conversion).
1188
1189PowerPointPlugin.convert_to.pagedimg:A series of JPEG images (needs -openoffice_conversion).
1190
1191PowerPointPlugin.convert_to.pagedimg_jpg:A series of images in JPEG format (needs -windows_scripting).
1192
1193PowerPointPlugin.convert_to.pagedimg_gif:A series of images in GIF format (needs -windows_scripting).
1194
1195PowerPointPlugin.convert_to.pagedimg_png:A series of images in PNG format (needs -windows_scripting).
1196
[16017]1197PrintInfo.bad_general_option:The %s plugin uses an incorrect option. Check your collect.cfg configuration file.
1198
[16018]1199PrintInfo.desc:Most base plugin, handles printing info (using pluginfo.pl) and parsing of the arguments.
1200
[15968]1201ProCitePlugin.desc:A plugin for (exported) ProCite databases
[12742]1202
[17462]1203ProCitePlugin.entry_separator:The string used to separate multiple values for single metadata fields in ProCite database records.
1204
[16017]1205ReadTextFile.could_not_extract_encoding:WARNING: encoding could not be extracted from %s - defaulting to %s
[11633]1206
[16017]1207ReadTextFile.could_not_extract_language:WARNING: language could not be extracted from %s - defaulting to %s
[11633]1208
[16017]1209ReadTextFile.could_not_open_for_reading:could not open %s for reading
[11633]1210
[16017]1211ReadTextFile.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.
[11633]1212
[16017]1213ReadTextFile.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.
1214
1215ReadTextFile.desc:Base plugin for files that are plain text.
1216
1217ReadTextFile.empty_file:file contains no text
1218
1219ReadTextFile.extract_language:Identify the language of each document and set 'Language' metadata. Note that this will be done automatically if -input_encoding is 'auto'.
1220
1221ReadTextFile.file_has_no_text:ERROR: %s contains no text
1222
1223ReadTextFile.input_encoding:The encoding of the source documents. Documents will be converted from these encodings and stored internally as utf8.
1224
1225ReadTextFile.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.
1226
1227ReadTextFile.read_denied:Read permission denied for %s
1228
1229ReadTextFile.separate_cjk:Insert spaces between Chinese/Japanese/Korean characters to make each character a word. Use if text is not segmented.
1230
1231ReadTextFile.unsupported_encoding:WARNING: %s appears to be encoded in an unsupported encoding (%s) - using %s
1232
1233ReadTextFile.wrong_encoding:WARNING: %s was read using %s encoding but appears to be encoded as %s.
1234
1235ReadXMLFile.desc:Base class for XML plugins.
1236
1237ReadXMLFile.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.
1238
1239RealMediaPlugin.desc:A plugin for processing Real Media files.
1240
[17068]1241ReferPlugin.desc:ReferPlugin reads bibliography files in Refer format.
[11633]1242
[15968]1243RogPlugin.desc:Creates simple single-level documents from .rog or .mdb files.
[11633]1244
[15968]1245RTFPlugin.desc:Plugin for importing Rich Text Format files.
[11633]1246
[15968]1247SourceCodePlugin.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)
[11633]1248
[15968]1249SourceCodePlugin.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.
[11633]1250
[17068]1251SplitTextFile.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.
[11633]1252
[16017]1253SplitTextFile.split_exp:A perl regular expression to split input files into segments.
[11633]1254
[15968]1255StructuredHTMLPlugin.desc:A plugin to process structured HTML documents, splitting them into sections based on style information.
[12742]1256
[15968]1257StructuredHTMLPlugin.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.
[11850]1258
[15968]1259StructuredHTMLPlugin.title_header:possible user-defined styles for the title header.
[11850]1260
[15968]1261StructuredHTMLPlugin.level1_header:possible user-defined styles for the level1 header in the HTML document (equivalent to <h1>).
[11850]1262
[15968]1263StructuredHTMLPlugin.level2_header:possible user-defined styles for the level2 header in the HTML document (equivalent to <h2>).
[11850]1264
[15968]1265StructuredHTMLPlugin.level3_header:possible user-defined styles for the level3 header in the HTML document (equivalent to <h3>).
[11850]1266
[15968]1267StructuredHTMLPlugin.toc_header:possible user-defined header styles for the table of contents, table of figures etc, to be removed if delete_toc is set.
[11850]1268
[15968]1269TextPlugin.desc:Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).
[11633]1270
[17748]1271TextPlugin.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.
[11633]1272
[31787]1273UnknownConverterPlugin.desc:If you have a custom conversion tool installed that you're able to run from the command line to convert from an unsupported document format to text, HTML or a series of images in jpg, png or gif form, then provide that command to this Plugin. It will then run the command for you, capturing the output for indexing by Greenstone, making any documents that aren't converted to images searchable. Set the process_extension to the suffix of files to be converted. Set convert_to to be the output format that the conversion command will generate, which will determine the output file's suffix. Use %INPUT_FILE and %OUTPUT as place holders in the command, which Greenstone will replace. It will pass in the full path to each file that matches the process_extension suffix in turn as %INPUT_FILE. %OUTPUT will be replaced with a path in the temporary folder of the output file with suffix determined by the value of convert_to. If convert_to is a pagedimg type, Greenstone sets %OUTPUT to be a directory to contain the expected files and will create an item file collating the parts of the document.
[31744]1274
[31787]1275UnknownConverterPlugin.exec_cmd:Command line command string to execute that will do the conversion. Quoted elements need to have the quotes escaped with a backslash to preserve them. Use %INPUT_FILE and %OUTPUT as place holders in the command.
[31744]1276
1277UnknownConverterPlugin.output_file_or_dir_name: Full pathname of the output file or of the directory (of output files) that get generated by the conversion
1278
[15968]1279UnknownPlugin.assoc_field:Name of the metadata field that will hold the associated file's name.
[11633]1280
[15968]1281UnknownPlugin.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.
[11633]1282
[15968]1283UnknownPlugin.file_format:Type of the file (e.g. MPEG, MIDI, ...)
[11633]1284
[15968]1285UnknownPlugin.mime_type:Mime type of the file (e.g. image/gif).
[11633]1286
[15968]1287UnknownPlugin.process_extension:Process files with this file extension. This option is an alternative to process_exp that is simpler to use but less flexible.
[11633]1288
[15968]1289UnknownPlugin.srcicon:Specify a macro name (without underscores) to use as srcicon metadata.
[11633]1290
[15968]1291WordPlugin.desc:A plugin for importing Microsoft Word documents.
[11633]1292
[15968]1293WordPlugin.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.
[11633]1294
[15968]1295WordPlugin.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
[11633]1296
[15968]1297ZIPPlugin.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)
[11633]1298
[11788]1299#
1300# Download module option descriptions
1301#
[11633]1302
[17210]1303BaseDownload.desc:Base class for Download modules
1304BaseDownload.bad_general_option:The %s download module uses an incorrect option.
[14252]1305MediaWikiDownload.desc:A module for downloading from MediaWiki websites
1306MediaWikiDownload.reject_filetype:Ignore url list, separate by comma, e.g.*cgi-bin*,*.ppt ignores hyperlinks that contain either 'cgi-bin' or '.ppt'
[17233]1307MediaWikiDownload.reject_filetype_disp:Ignore URL patterns
[14252]1308MediaWikiDownload.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.
[17233]1309MediaWikiDownload.exclude_directories_disp:Exclude directories
[14252]1310
[12581]1311OAIDownload.desc:A module for downloading from OAI repositories
[11789]1312OAIDownload.url_disp:Source URL
[12581]1313OAIDownload.url:OAI repository URL
[17233]1314OAIDownload.set_disp:Restrict to set
[12581]1315OAIDownload.set:Restrict the download to the specified set in the repository
[16843]1316OAIDownload.metadata_prefix_disp:Metadata prefix
1317OAIDownload.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.
[11789]1318OAIDownload.get_doc_disp:Get document
[12581]1319OAIDownload.get_doc:Download the source document if one is specified in the record
[17246]1320OAIDownload.get_doc_exts_disp:Only include file types
[17233]1321OAIDownload.get_doc_exts:Permissible filename extensions of documents to get
[11789]1322OAIDownload.max_records_disp:Max records
[12581]1323OAIDownload.max_records:Maximum number of records to download
[11788]1324
[12581]1325SRWDownload.desc:A module for downloading from SRW (Search/Retrieve Web Service) repositories
[11788]1326
[12581]1327WebDownload.desc:A module for downloading from the Internet via HTTP or FTP
[17234]1328WebDownload.url:Source URL. In case of http redirects, this value may change
[11789]1329WebDownload.url_disp:Source URL
1330WebDownload.depth:How many hyperlinks deep to go when downloading
1331WebDownload.depth_disp:Download Depth
1332WebDownload.below:Only mirror files below this URL
[17233]1333WebDownload.below_disp:Only files below URL
[11789]1334WebDownload.within:Only mirror files within the same site
[17233]1335WebDownload.within_disp:Only files within site
[12581]1336WebDownload.html_only:Download only HTML files, and ignore associated files e.g images and stylesheets
[17233]1337WebDownload.html_only_disp:Only HTML files
[31880]1338WebDownload.proxied_connect_failed_info:Current proxy settings are:
1339WebDownload.http_proxy_settings:- HTTP host=%s : port=%s
1340WebDownload.https_proxy_settings:- HTTPS host=%s : port=%s
1341WebDownload.ftp_proxy_settings:- FTP host=%s : port=%s
[31860]1342WebDownload.proxyless_connect_failed_info:- The external server might not be responding\n- or you might need to switch on proxy settings
[31875]1343WebDownload.connect_failed_info:- or try ticking No Certificate Checking (affects 'https' URLs)\nin File > Preferences > Connection
[11788]1344
1345WgetDownload.desc: Base class that handles calls to wget
[11792]1346WgetDownload.proxy_on:Proxy on
[31880]1347WgetDownload.http_proxy_host:HTTP proxy host
1348WgetDownload.http_proxy_port:HTTP proxy port
1349WgetDownload.https_proxy_host:HTTPS proxy host
1350WgetDownload.https_proxy_port:HTTPS proxy port
1351WgetDownload.ftp_proxy_host:FTP proxy host
1352WgetDownload.ftp_proxy_port:FTP proxy port
[11792]1353WgetDownload.user_name:User name
1354WgetDownload.user_password:User password
[31860]1355WgetDownload.no_check_certificate:No check certificate
[31957]1356WgetDownload.wget_timed_out_warning:WARNING: wget timed out %s times waiting for a response.\n\tThe URL may be inaccessible or the proxy configuration is wrong or incomplete.\n
[11788]1357
[12581]1358Z3950Download.desc:A module for downloading from Z3950 repositories
1359Z3950Download.host:Host URL
1360Z3950Download.host_disp:Host
1361Z3950Download.port:Port number of the repository
[11789]1362Z3950Download.port_disp:Port
[12581]1363Z3950Download.database:Database to search for records in
[11789]1364Z3950Download.database_disp:Database
[12581]1365Z3950Download.find:Retrieve records containing the specified search term
[11789]1366Z3950Download.find_disp:Find
[12581]1367Z3950Download.max_records:Maximum number of records to download
[11789]1368Z3950Download.max_records_disp:Max Records
[11788]1369
[12332]1370
[11633]1371#
[30619]1372# Plugout option descriptions
[12332]1373#
1374
[12547]1375BasPlugout.bad_general_option:The %s plugout uses an incorrect option.
[19549]1376BasPlugout.debug:Set debugging mode
[17205]1377BasPlugout.desc:Base class for all the export plugouts.
1378BasPlugout.group_size:Number of documents to group into one XML file.
1379BasPlugout.gzip_output:Use gzip to compress resulting xml documents (don't forget to include ZIPPlugin in your plugin list when building from compressed documents).
[30619]1380# '
[28763]1381BasPlugout.no_auxiliary_databases:Don't generate archivesinf databases - useful when exporting.
[30619]1382# '
[19549]1383BasPlugout.output_handle: the file descriptor used to receive output data
1384BasPlugout.output_info:The reference to an arcinfo object used to store information about the archives.
[17205]1385BasPlugout.verbosity:Controls the quantity of output. 0=none, 3=lots.
[27498]1386BasPlugout.xslt_file:Transform a document with the XSLT in the named file.
[27646]1387BasPlugout.subdir_hash_prefix:Specify flag to not count the word HASH in the split length calculation.
[27498]1388BasPlugout.subdir_split_length:The maximum number of characters before spliting an archives subdirectory.
[27646]1389BasPlugout.no_rss:Suppress the automatic generation of RSS feed file.
[29013]1390BasPlugout.rss_title:Comma separated list of metadata fields listed in order of preference from which the title for a document's RSS link is to be obtained
[12332]1391
[17205]1392DSpacePlugout.desc:DSpace Archive format.
[23826]1393DSpacePlugout.metadata_prefix:Comma separated list of metadata prefixes to include in the exported data.  For example, setting this value to 'dls' will generate a metadata_dls.xml file for each document exported in the format needed by DSpace.
[17205]1394
1395FedoraMETSPlugout.desc:METS format using the Fedora profile.
1396FedoraMETSPlugout.fedora_namespace:The prefix used in Fedora for process ids (PIDS) e.g. greenstone:HASH0122efe4a2c58d0
1397
[17748]1398GreenstoneXMLPlugout.desc:Greenstone XML Archive format.
[17205]1399
1400GreenstoneMETSPlugout.desc:METS format using the Greenstone profile.
1401
1402MARCXMLPlugout.desc:MARC xml format.
1403MARCXMLPlugout.group:Output the marc xml records into a single file.
1404MARCXMLPlugout.mapping_file:Use the named mapping file for the transformation.
1405
1406METSPlugout.desc:Superclass plugout for METS format.  Provides common functionality for profiles such as GreenstoneMETS and FedoraMETS and key abstract methods.
1407METSPlugout.xslt_txt:Transform a mets's doctxt.xml with the XSLT in the named file. 
1408METSPlugout.xslt_mets:Transform a mets's docmets.xml with the XSLT in the named file. 
1409
[12332]1410#
[11633]1411# Perl module strings
1412#
1413
1414classify.could_not_find_classifier:ERROR: Could not find classifier \"%s\"
1415
[12617]1416download.could_not_find_download:ERROR: Could not find download module \"%s\"
1417
[11633]1418plugin.could_not_find_plugin:ERROR: Could not find plugin \"%s\"
1419
1420plugin.including_archive:including the contents of 1 ZIP/TAR archive
1421
1422plugin.including_archives:including the contents of %d ZIP/TAR archives
1423
1424plugin.kill_file:Process killed by .kill file
1425
1426plugin.n_considered:%d documents were considered for processing
1427
1428plugin.n_included:%d were processed and included in the collection
1429
1430plugin.n_rejected:%d were rejected
1431
1432plugin.n_unrecognised:%d were unrecognised
1433
1434plugin.no_plugin_could_process:WARNING: No plugin could process %s
1435
1436plugin.no_plugin_could_recognise:WARNING: No plugin could recognise %s
1437
1438plugin.no_plugin_could_process_this_file:no plugin could process this file
1439
1440plugin.no_plugin_could_recognise_this_file:no plugin could recognise this file
1441
1442plugin.one_considered:1 document was considered for processing
1443
1444plugin.one_included:1 was processed and included in the collection
1445
1446plugin.one_rejected:1 was rejected
1447
1448plugin.one_unrecognised:1 was unrecognised
1449
1450plugin.see_faillog:See %s for a list of unrecognised and/or rejected documents
1451
1452PrintUsage.default:Default
1453
1454PrintUsage.required:REQUIRED
[12332]1455
[14252]1456plugout.could_not_find_plugout:ERROR: Could not find plugout \"%s\"
Note: See TracBrowser for help on using the browser.