source: main/trunk/greenstone2/perllib/strings.properties@ 32582

Last change on this file since 32582 was 32582, checked in by ak19, 5 years ago

Now that previous commit(s) put sig handlers in place in gs_sql, have been able to add in Undo on build/import Cancel for the GS SQL Plugs. This utilizes AutoCommit vs Transaction (rollback/commit) behaviour. On cancel, a sig handler is triggered (SIGINT) and, if AutoCommit is off, does a rollback before die() which calls object destructor and disconnects from db. On regular program execution running to normal termination, the last finish() call on gs_sql that will trigger the disconnect, will now first do a commit(), if AutoCommit is off, before disconnecting. For now, the default for both GreenstoneSQLPlugs is to support Undo (i.e. transactions), which turns AutoCommit off. Not sure whether this will be robust: what if transactions take place in memory, we could be dealing with millions of docs of large full-txt. Another issue is that the SQL DB may be out of sync with archives and index folder on Cancel: archives and index just terminate and are in an intermediate state depending on when cancel was pressed. Whereas the GS SQL DB is in a rolled back state as if the import or build never took place. A third issue is that during buildcol (perhaps specifically during buildcol's doc processing phase), pressing Cancel still continues buildcol: the current perl process is cancelled but the next one continues, rather than terminating buildcol in entirety. What happens with the GS SQL DB is that any 'transaction' until then is rolled back, perhaps a transaction regarding one doc if the Cancel affects on a doc basis, and the next process (next doc processing?) continues and allows for further transactions that are all committed at the end on natural termination of buildcol. Need to whether Undo behavious is really what we want. But it's available now and we can simply change the default to not support Undo if we want the old behaviour again.

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