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

Last change on this file since 32273 was 32273, checked in by ak19, 6 years ago

First of the commits to do with restructuring and refactoring the PDFPlugin. 1. Introducing PDFv1Plugin.pm, which only runs the old pdftohtml. pdfbox_conversion are moved into PDFv2Plugin. 2. In the meantime we still have PDFPlugin, the current state of the plugin, for backward compatibility: it uses both the old pdftohtml tool and still has the pdfbox_conversion option. Yet to introduced the PDFv2Plugin. 3. gsConvert.pl has the new flag pdf_tool, set/passed in by PDFPlugin.pm and all PDFPlugin classes hereafter. The pdf_tool flag can be set to pdftohtml, xpdftools or pdfbox. PDFv1Plugin will always set it to pdftohtml, to denote the old pdftohtml tool is to be used, whereas PDFv2Plugin will set it to xpdftools and PDFBoxConverter sets it for symmetry's sake to pdfbox, even though being an AutoLoadConverter at present, the PDFBoxConverter class bypasses gsConvert.pl. gsConvert.pl uses the pdf_tool flag to determine which tool is to be used to do the conversion to produce the selected output_type. 4. Added some strings. One for migrating users to indicate that PDFPlugin was being deprecated in favour of the PDFv1 and PDFv2 plugins. Another was referenced by CommonUntil, and more recently by PDFPlugin, but was not defined in strings.properties. Once PDFv2Plugin has been added, need to remove references to paged_html from PDFPlugin.

  • Property svn:keywords set to Author Date Id Revision
File size: 87.4 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
419
420export.saveas.MARCXML:MARC XML format (an XML version of MARC 21)
421
422export.out:Filename or handle to print output status to.
423
424export.params:[options] collection-name
425
426export.removeold:Will remove the old contents of the export directory.
427
428export.removing_export:Removing current contents of the export directory...
429
430export.sortmeta:Sort documents alphabetically by metadata for building. This will be disabled if groupsize > 1.
431
432export.statsfile:Filename or handle to print export statistics to.
433
434export.stats_backup:Will print stats to STDERR instead.
435
436export.verbosity:Controls the quantity of output. 0=none, 3=lots.
437
438
439# -- mkcol.pl --
440
441mkcol.about:The about text for the collection.
442
443mkcol.buildtype:The 'buildtype' for the collection (e.g. mg, mgpp, lucene)
444
445mkcol.infodbtype:The 'infodbtype' for the collection (e.g. gdbm, jdbm, sqlite)
446
447mkcol.bad_name_cvs:ERROR: No collection can be named CVS as this may interfere with directories created by the CVS versioning system.
448
449mkcol.bad_name_svn:ERROR: No collection can be named .svn as this may interfere with directories created by the SVN versioning system.
450
451mkcol.bad_name_modelcol:ERROR: No collection can be named modelcol as this is the name of the model collection.
452
453mkcol.cannot_find_modelcol:ERROR: Cannot find the model collection %s
454
455mkcol.col_already_exists:ERROR: This collection already exists.
456
457mkcol.collectdir:Directory where new collection will be created.
458
459mkcol.group_not_valid_in_gs3:The group option is not valid in Greenstone 3 mode (-gs3mode).
460mkcol.creating_col:Creating the collection %s
461
462mkcol.creator:The collection creator's e-mail address.
463
464mkcol.creator_undefined:ERROR: The creator was not defined. This variable is needed to recognise duplicate collection names.
465
466mkcol.desc:PERL script used to create the directory structure for a new Greenstone collection.
467
468mkcol.doing_replacements:doing replacements for %s
469
470mkcol.group:Create a new collection group instead of a standard collection.
471
472mkcol.gs3mode:Mode for Greenstone 3 collections.
473
474mkcol.long_colname:ERROR: The collection name must be less than 8 characters so compatibility with earlier filesystems can be maintained.
475
476mkcol.maintainer:The collection maintainer's email address (if different from the creator).
477
478mkcol.no_collectdir:ERROR: The collect dir doesn't exist: %s
479
480mkcol.no_collectdir_specified:ERROR: No collect dir was specified. In gs3mode, either the -site or -collectdir option must be specified.
481
482mkcol.no_colname:ERROR: No collection name was specified.
483
484mkcol.optionfile:Get options from file, useful on systems where long command lines may cause problems.
485
486mkcol.params:[options] collection-name
487
488mkcol.plugin:Perl plugin module to use (there may be multiple plugin entries).
489
490mkcol.public:If this collection has anonymous access.
491mkcol.public.true:Collection is public
492mkcol.public.false:Collection is private
493
494mkcol.quiet:Operate quietly.
495
496mkcol.site:In gs3mode, uses this site name with the GSDL3HOME environment variable to determine collectdir, unless -collectdir is specified.
497
498mkcol.success:The new collection was created successfully at %s
499
500mkcol.title:The title of the collection.
501
502mkcol.win31compat:Whether or not the named collection directory must conform to Windows 3.1 file conventions or not (i.e. 8 characters long).
503mkcol.win31compat.true:Directory name 8 characters or less
504mkcol.win31compat.false:Directory name any length
505
506# -- pluginfo.pl --
507
508pluginfo.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.
509
510pluginfo.desc:Prints information about a plugin.
511
512pluginfo.general_options:General options are inherited from parent classes of the plugin.
513
514pluginfo.info:info
515
516pluginfo.no_plugin_name:ERROR: You must provide a plugin name.
517
518pluginfo.option_types:Plugins may take two types of options
519
520pluginfo.params:[options] plugin-name
521
522pluginfo.passing_options:Options may be passed to any plugin by including them in your collect.cfg configuration file.
523
524pluginfo.specific_options:Specific options are defined within the plugin itself, and are available only to this particular plugin.
525
526
527# -- plugoutinfo.pl --
528
529plugoutinfo.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.
530
531plugoutinfo.desc:Prints information about a plugout.
532
533plugoutinfo.general_options:General options are inherited from parent classes of the plugout.
534
535plugoutinfo.info:info
536
537plugoutinfo.no_plugout_name:ERROR: You must provide a plugout name.
538
539plugoutinfo.option_types:Plugouts may take two types of options
540
541plugoutinfo.params:[options] plugout-name
542
543plugoutinfo.passing_options:Options may be passed to any plugout by including them in your collect.cfg configuration file.
544
545plugoutinfo.specific_options:Specific options are defined within the plugout itself, and are available only to this particular plugout.
546
547
548
549#
550# Classifier option descriptions
551#
552
553AllList.desc:Creates a single list of all documents. Use by the oaiserver.
554
555AZCompactList.allvalues:Use all metadata values found.
556
557AZCompactList.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.
558
559AZCompactList.doclevel:Level to process document at.
560AZCompactList.doclevel.top:Whole document.
561AZCompactList.doclevel.firstlevel:The first level of sections only
562AZCompactList.doclevel.section:All sections.
563
564AZCompactList.firstvalueonly:Use only the first metadata value found.
565
566AZCompactList.freqsort:Sort by node frequency rather than alpha-numeric.
567
568AZCompactList.maxcompact:Maximum number of documents to be displayed per page.
569
570AZCompactList.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.
571
572AZCompactList.mincompact:Minimum number of documents to be displayed per page.
573
574AZCompactList.mingroup:The smallest value that will cause a group in the hierarchy to form.
575
576AZCompactList.minnesting:The smallest value that will cause a list to be converted into a nested list.
577
578AZCompactList.recopt:Used in nested metadata such as -metadata Year/Organisation.
579AZCompactList.sort:Metadata field to sort the leaf nodes by.
580
581AZCompactSectionList.desc:Variation on AZCompactList that classifies sections rather than documents. Entries are sorted by section-level metadata.
582
583AZList.desc:Classifier plugin for sorting alphabetically (on a-z, A-Z, 0-9). Produces a horizontal A-Z list, with documents listed underneath.
584
585AZList.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.
586
587AZSectionList.desc:Variation on AZList that classifies sections rather that documents. Entries are sorted by section-level metadata.
588
589BasClas.bad_general_option:The %s classifier uses an incorrect option. Check your collect.cfg configuration file.
590
591BasClas.builddir:Where to put the built indexes.
592
593BasClas.buttonname:The label for the classifier screen and button in navigation bar. The default is the metadata element specified with -metadata.
594
595BasClas.desc:Base class for all the classifiers.
596
597BasClas.no_metadata_formatting:Don't do any automatic metadata formatting (for sorting.)
598
599BasClas.outhandle:The file handle to write output to.
600
601BasClas.removeprefix:A prefix to ignore in metadata values when sorting.
602
603BasClas.removesuffix:A suffix to ignore in metadata values when sorting.
604
605BasClas.verbosity:Controls the quantity of output. 0=none, 3=lots.
606
607Browse.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.
608
609DateList.bymonth:Classify by year and month instead of only year.
610
611DateList.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.
612
613DateList.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.
614
615DateList.reverse_sort:Sort the documents in reverse chronological order (newest first).
616
617DateList.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).
618
619DateList.no_special_formatting:Don't display Year and Month information in the document list.
620
621DateList.sort:An extra metadata field to sort by in the case where two documents have the same date.
622
623HFileHierarchy.desc:Classifier plugin for generating hierarchical classifications based on a supplementary structure file.
624
625Hierarchy.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).
626
627Hierarchy.documents_last:Display document nodes after classifier nodes.
628
629Hierarchy.hfile:Use the specified classification structure file.
630
631Hierarchy.hlist_at_top:Display the first level of the classification horizontally.
632
633Hierarchy.reverse_sort:Sort leaf nodes in reverse order (use with -sort).
634
635Hierarchy.separator:Regular expression used for the separator, if using structured metadata.
636
637Hierarchy.sort:Metadata field to sort leaf nodes by. Leaves will not be sorted if not specified.
638
639Hierarchy.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.
640
641Hierarchy.suppresslastlevel:Ignore the final part of the metadata value. This is useful for metadata where each value is unique, such as file paths.
642
643HTML.desc:Creates an empty classification that's simply a link to a web page.
644
645HTML.url:The url of the web page to link to.
646
647List.bookshelf_type:Controls when to create bookshelves
648List.bookshelf_type.always:Create a bookshelf icon even if there is only one item in each group at the leaf nodes.
649List.bookshelf_type.never:Never create a bookshelf icon even if there are more than one item in each group at the leaf nodes.
650List.bookshelf_type.duplicate_only:Create a bookshelf icon only when there are more than one item in each group at the leaf nodes.
651
652List.classify_sections:Classify sections instead of documents.
653
654List.desc:A general and flexible list classifier with most of the abilities of AZCompactList, but with better Unicode, metadata and sorting capabilities.
655List.filter_metadata:Metadata element to test against for a document's inclusion into the classifier. Documents will be included if they define this metadata.
656List.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.
657List.level_partition.none:None.
658List.level_partition.per_letter:Create a partition for each letter.
659List.level_partition.constant_size:Create partitions with constant size.
660List.level_partition.approximate_size:Create a partition per letter, then group or split the letters to get approximately the same sized partitions.
661
662List.metadata:Metadata fields used for classification. Use '/' to separate the levels in the hierarchy and ';' or ',' to separate metadata fields within each level.
663
664List.metadata_selection_mode:Determines how many metadata values the document is classified by, within each level. Use '/' to separate the levels.
665List.metadata_selection.firstvalue:Only classify by a single metadata value, the first one encountered.
666List.metadata_selection.firstvalidmetadata:Classify by all the metadata values of the first element in the list that has values.
667List.metadata_selection.allvalues:Classify by all metadata values found, from all elements in the list.
668List.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'.
669
670List.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 '/'.
671
672List.partition_type_within_level:The type of partitioning done. Can be specified for each level. Separate levels by '/'.
673
674List.reverse_sort_leaf_nodes:Sort the leaf documents in reverse order.
675
676List.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.
677
678List.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.
679
680List.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.
681
682List.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.
683
684SimpleList.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.
685
686SimpleList.desc:Simple list classifier plugin.
687
688SimpleList.sort:Metadata field to sort by. Use '-sort nosort' for no sorting.
689
690Phind.desc:Produces a hierarchy of phrases found in the text, which is browsable via an applet.
691
692Phind.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.
693
694Phind.min_occurs:The minimum number of times a phrase must appear in the text to be included in the phrase hierarchy.
695
696Phind.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.
697
698Phind.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.
699
700Phind.text:The text used to build the phrase hierarchy.
701
702Phind.thesaurus:Name of a thesaurus stored in Phind format in the collection's etc directory.
703
704Phind.title:The metadata field used to describe each document.
705
706Phind.untidy:Don't remove working files.
707
708RecentDocumentsList.desc:Classifier that gives a list of newly added or modified documents.
709
710RecentDocumentsList.include_docs_added_since:Include only documents modified or added after the specified date (in yyyymmdd or yyyy-mm-dd format).
711
712RecentDocumentsList.include_most_recently_added:Include only the specified number of most recently added documents. Only used if include_docs_added_since is not specified.
713
714RecentDocumentsList.sort:Metadata to sort List by. If not specified, list will be sorted by date of modification/addition.
715
716SectionList.desc:Same as List classifier but includes all sections of document (excluding top level) rather than just top level document itself.
717
718Collage.desc:An applet is used to display a collage of images found in the collection.
719
720Collage.geometry:The dimensions of the collage canvas. For a canvas 600 pixels wide by 400 pixels high, for example, specify geometry as 600x400
721
722Collage.maxDepth:Images for collaging are drawn from mirroring the underlying browse classifier. This controls the maximum depth of the mirroring process.
723
724Collage.maxDisplay:The maximum number of images to show in the collage at any one time.
725
726Collage.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.
727
728Collage.bgcolor:The background color of the collage canvas, specified in hexadecimal form (for example #008000 results in a forest green background).
729
730Collage.buttonname:The label for the classifier screen and button in navigation bar.
731
732Collage.refreshDelay:Rate, in milliseconds, that the collage canvas is refreshed.
733
734Collage.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.
735
736Collage.imageMustNotHave:Used to suppress images that should not appear in the collage, such as image buttons that make up the navigation bar.
737
738Collage.caption:Optional captions to display below the collage canvas.
739
740
741#
742# Plugin option descriptions
743#
744AcronymExtractor.adding:adding
745
746AcronymExtractor.already_seen:already seen
747
748AcronymExtractor.desc:Helper extractor plugin for location and marking up acronyms in text.
749
750AcronymExtractor.done_acronym_extract:done extracting acronyms.
751
752AcronymExtractor.done_acronym_markup:done acronym markup.
753
754AcronymExtractor.extract_acronyms:Extract acronyms from within text and set as metadata.
755
756AcronymExtractor.extracting_acronyms:extracting acronyms
757
758AcronymExtractor.marking_up_acronyms:marking up acronyms
759
760AcronymExtractor.markup_acronyms:Add acronym metadata into document text.
761
762ArchivesInfPlugin.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.
763ArchivesInfPlugin.reversesort:Sort in reverse alphabetical order. Useful if the -sortmeta option was used with import.pl.
764ArchivesInfPlugin.sort:Sort in ascending alphabetical order. Useful if the -sortmeta option was used with import.pl.
765
766AutoExtractMetadata.desc: Base plugin that brings together all the extractor functionality from the extractor plugins.
767
768AutoExtractMetadata.extracting:extracting
769
770AutoExtractMetadata.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".
771
772AutoLoadConverters.desc:Helper plugin that dynamically loads up extension converter plugins.
773AutoloadConverter.noconversionavailable:Conversion not available
774
775BaseMediaConverter.desc:Helper plugin that provides base functionality for media converter plugins such as ImageConverter and video converters.
776
777BaseImporter.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.
778
779BaseImporter.associate_tail_re:A regular expression to match filenames against to find associated files. Used as a more powerful alternative to associate_ext.
780
781BaseImporter.desc:Base class for all the import plugins.
782
783BaseImporter.dummy_text:This document has no text.
784
785BaseImporter.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.
786
787BaseImporter.OIDtype.auto:Use OIDtype set in import.pl
788
789BaseImporter.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).
790
791BaseImporter.processing_tmp_files:Internal flag, set by converter plugins to indicate that we are processing a tmp file.
792
793BaseImporter.smart_block:Block files in a smarter way than just looking at filenames.
794
795BaseImporter.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.
796
797BaseImporter.file_rename_method:The method to be used in renaming the copy of the imported file and associated files.
798
799BaseImporter.rename_method.url:Use url encoding in renaming imported files and associated files.
800
801BaseImporter.rename_method.base64:Use base64 encoding in renaming imported files and associated files.
802
803BaseImporter.rename_method.none:Don't rename imported files and associated files.
804
805BibTexPlugin.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.
806
807BookPlugin.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.
808
809CommonUtil.block_exp:Files matching this regular expression will be blocked from being passed to any later plugins in the list.
810
811CommonUtil.could_not_open_for_writing:could not open %s for writing
812
813CommonUtil.desc:Base Utility plugin class that handles filename encoding and file blocking.
814
815CommonUtil.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.
816
817CommonUtil.encoding.unicode:Just unicode.
818
819CommonUtil.encoding.utf8:Either utf8 or unicode -- automatically detected.
820
821CommonUtil.filename_encoding:The encoding of the source file filenames.
822
823CommonUtil.filename_encoding.auto:Automatically detect the encoding of the filename.
824
825CommonUtil.filename_encoding.auto_language_analysis:Auto-detect the encoding of the filename by analysing it.
826
827CommonUtil.filename_encoding.auto_filesystem_encoding:Auto-detect the encoding of the filename using filesystem encoding.
828
829CommonUtil.filename_encoding.auto_fl:Uses filesystem encoding then language analysis to detect the filename encoding.
830
831CommonUtil.filename_encoding.auto_lf:Uses language analysis then filesystem encoding to detect the filename encoding.
832
833CommonUtil.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.
834
835CONTENTdmPlugin.desc:Plugin that processes RDF files in exported CONTENTdm collections.
836
837ConvertBinaryFile.apply_fribidi:Run the "fribidi" Unicode Bidirectional Algorithm program over the converted file (for right-to-left text).
838
839ConvertBinaryFile.convert_to:Plugin converts to TEXT or HTML or various types of Image (e.g. JPEG, GIF, PNG).
840
841ConvertBinaryFile.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.
842
843ConvertBinaryFile.convert_to.html:HTML format.
844
845ConvertBinaryFile.convert_to.text:Plain text format.
846
847ConvertBinaryFile.convert_to.pagedimg:A series of images.
848
849ConvertBinaryFile.convert_to.pagedimg_jpg:A series of images in JPEG format.
850
851ConvertBinaryFile.convert_to.pagedimg_gif:A series of images in GIF format.
852
853ConvertBinaryFile.convert_to.pagedimg_png:A series of images in PNG format.
854
855ConvertBinaryFile.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'.
856
857ConvertBinaryFile.keep_original_filename:Keep the original filename for the associated file, rather than converting to doc.pdf, doc.doc etc.
858
859ConvertBinaryFile.use_strings:If set, a simple strings function will be called to extract text if the conversion utility fails.
860
861ConvertToRogPlugin.desc:A plugin that inherits from RogPlugin.
862
863CSVPlugin.desc:A plugin for files in comma-separated value format. A new document will be created for each line of the file.
864
865DateExtractor.desc:Helper extractor plugin for extracting historical date information from text.
866
867DateExtractor.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.
868
869DateExtractor.maximum_century:The maximum named century to be extracted as historical metadata (e.g. 14 will extract all references up to the 14th century).
870
871DateExtractor.maximum_year:The maximum historical date to be used as metadata (in a Common Era date, such as 1950).
872
873DateExtractor.no_bibliography:Do not try to block bibliographic dates when extracting historical dates.
874
875DirectoryPlugin.desc:A plugin which recurses through directories processing each file it finds.
876
877DirectoryPlugin.recheck_directories:After the files in an import directory have been processed, re-read the directory to discover any new files created.
878
879DirectoryPlugin.use_metadata_files:SUPERSEDED - Add MetadataXMLPlugin to the list of plugins in order to read metadata from metadata XML files.
880
881DatabasePlugin.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.
882
883DSpacePlugin.desc:A plugin that takes a collection of documents exported from DSpace and imports them into Greenstone.
884
885DSpacePlugin.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.
886
887DSpacePlugin.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.
888
889DSpacePlugin.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.
890
891EmailAddressExtractor.desc:Helper extractor plugin for discovering email addresses in text.
892
893EmailAddressExtractor.done_email_extract:done extracting e-mail addresses.
894
895EmailAddressExtractor.extracting_emails:extracting e-mail addresses
896
897EmailAddressExtractor.extract_email:Extract email addresses as metadata.
898
899EmailPlugin.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)
900
901EmailPlugin.no_attachments:Do not save message attachments.
902
903EmailPlugin.headers:Store email headers as "Headers" metadata.
904
905EmailPlugin.OIDtype.message_id:Use the message identifier as the document OID. If no message identifier is found, then will use a hash OID.
906
907EmailPlugin.split_exp:A perl regular expression used to split files containing many messages into individual documents.
908
909EmbeddedMetadataPlugin.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/
910EmbeddedMetadataPlugin.join_before_split:Join fields with multiple entries (e.g. Authors or Keywords) before they are (optionally) split using the specified separator.
911EmbeddedMetadataPlugin.join_character:The character to use with join_before_split (default is a single space).
912EmbeddedMetadataPlugin.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).
913EmbeddedMetadataPlugin.set_filter_list:A comma-separated list of the metadata sets we would like to retrieve.
914EmbeddedMetadataPlugin.set_filter_regexp:A regular expression that selects the metadata we would like to retrieve.
915
916ExcelPlugin.desc:A plugin for importing Microsoft Excel files (versions 95 and 97).
917
918FavouritesPlugin.desc:Plugin to process Internet Explorer Favourites files.
919
920FOXPlugin.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.
921
922GreenstoneXMLPlugin.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.
923
924GISExtractor.desc:Helper extractor plugin for extracting placenames from text. Requires GIS extension to Greenstone.
925
926GISExtractor.extract_placenames:Extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
927
928GISExtractor.gazetteer:Gazetteer to use to extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
929
930GISExtractor.place_list:When extracting placements, include list of placenames at start of the document. Requires GIS extension to Greenstone.
931
932HBPlugin.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
933
934HBPlugin.encoding.iso_8859_1:Latin1 (western languages)
935
936HTMLImagePlugin.aggressiveness:Range of related text extraction techniques to use.
937HTMLImagePlugin.aggressiveness.1:Filename, path, alternative text (ALT attributes in img HTML tags) only.
938HTMLImagePlugin.aggressiveness.2:All of 1, plus caption where available.
939HTMLImagePlugin.aggressiveness.3:All of 2, plus near paragraphs where available.
940HTMLImagePlugin.aggressiveness.4:All of 3, plus previous headers (<h1>, <h2>...) where available.
941HTMLImagePlugin.aggressiveness.5:All of 4, plus textual references where available.
942HTMLImagePlugin.aggressiveness.6:All of 4, plus metadata tags in HTML pages (title, keywords, etc).
943HTMLImagePlugin.aggressiveness.7:All of 6, 5 and 4 combined.
944HTMLImagePlugin.aggressiveness.8:All of 7, plus duplicating filename, path, alternative text, and caption (raise ranking of more relevant results).
945HTMLImagePlugin.aggressiveness.9:All of 1, plus full text of source page.
946
947HTMLImagePlugin.caption_length:Maximum length of captions (in characters).
948
949HTMLImagePlugin.convert_params:Additional parameters for ImageMagicK convert on thumbnail creation. For example, '-raise' will give a three dimensional effect to thumbnail images.
950
951HTMLImagePlugin.desc:A plugin for extracting images and associated text from webpages.
952
953HTMLImagePlugin.document_text:Add image text as document:text (otherwise IndexedText metadata field).
954
955HTMLImagePlugin.index_pages:Index the pages along with the images. Otherwise reference the pages at the source URL.
956
957HTMLImagePlugin.max_near_text:Maximum characters near images to extract.
958
959HTMLImagePlugin.min_height:Pixels. Skip images shorter than this.
960
961HTMLImagePlugin.min_near_text:Minimum characters of near text or caption to extract.
962
963HTMLImagePlugin.min_size:Bytes. Skip images smaller than this.
964
965HTMLImagePlugin.min_width:Pixels. Skip images narrower than this.
966
967HTMLImagePlugin.neartext_length:Target length of near text (in characters).
968
969HTMLImagePlugin.no_cache_images:Don't cache images (point to URL of original).
970
971HTMLImagePlugin.smallpage_threshold:Images on pages smaller than this (bytes) will have the page (title, keywords, etc) meta-data added.
972
973HTMLImagePlugin.textrefs_threshold:Threshold for textual references. Lower values mean the algorithm is less strict.
974
975HTMLImagePlugin.thumb_size:Max thumbnail size. Both width and height.
976
977HTMLPlugin.assoc_files:Perl regular expression of file extensions to associate with html documents.
978
979HTMLPlugin.desc:This plugin processes HTML files
980
981HTMLPlugin.description_tags:Split document into sub-sections where <Section> tags occur. '-keep_head' will have no effect when this option is set.
982
983HTMLPlugin.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.
984
985HTMLPlugin.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.
986
987HTMLPlugin.hunt_creator_metadata:Find as much metadata as possible on authorship and place it in the 'Creator' field.
988
989HTMLPlugin.keep_head:Don't remove headers from html files.
990
991HTMLPlugin.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>
992
993HTMLPlugin.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.
994
995HTMLPlugin.no_metadata:Don't attempt to extract any metadata from files.
996
997HTMLPlugin.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.
998
999HTMLPlugin.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).
1000
1001HTMLPlugin.no_image_links:Don't make any attempt to trap image links to allow view images.
1002
1003HTMLPlugin.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).
1004
1005HTMLPlugin.sectionalise_using_h_tags:Automatically create a sectioned document using h1, h2, ... hX tags.
1006
1007HTMLPlugin.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.
1008
1009HTMLPlugin.tidy_html:If set, converts an HTML document into a well-formed XHTML to enable users view the document in the book format.
1010
1011HTMLPlugin.old_style_HDL:To mark whether the file in this collection used the old HDL document's tags style.
1012
1013BaseMediaConverter.enable_cache:Cache automatically generated files (such as thumbnails and screen-size images) so they don't need to be repeatedly generated.
1014
1015ImageConverter.converttotype:Convert main image to format 's'.
1016
1017ImageConverter.create_screenview:If set to true, create a screen sized image, and set Screen, ScreenType, screenicon, ScreenWidth, ScreenHeight metadata.
1018
1019ImageConverter.create_thumbnail:If set to true, create a thumbnail version of each image, and add Thumb, ThumbType, thumbicon, ThumbWidth, ThumbHeight metadata.
1020ImageConverter.desc:Helper plugin for image conversion using ImageMagick.
1021
1022ImageConverter.imagemagicknotinstalled:Image Magick not installed
1023
1024ImageConverter.minimumsize:Ignore images smaller than n bytes.
1025
1026ImageConverter.noconversionavailable:Image conversion not available
1027
1028ImageConverter.noscaleup:Don't scale up small images when making thumbnails.
1029
1030ImageConverter.screenviewsize:Make screenview images of size nxn.
1031
1032ImageConverter.screenviewtype:Make screenview images in format 's'.
1033
1034ImageConverter.thumbnailsize:Make thumbnails of size nxn.
1035
1036ImageConverter.thumbnailtype:Make thumbnails in format 's'.
1037
1038ImageConverter.win95notsupported: Image Magick not supported on Win95/98
1039
1040ImagePlugin.desc:This plugin processes images, adding basic metadata
1041
1042IndexPlugin.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'.
1043
1044ISISPlugin.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).
1045
1046ISISPlugin.subfield_separator:The string used to separate subfields in CDS/ISIS database records.
1047
1048ISISPlugin.entry_separator:The string used to separate multiple values for single metadata fields in CDS/ISIS database records.
1049
1050KeyphraseExtractor.desc:Helper extractor plugin for generating keyphrases from text. Uses Kea keyphrase extraction system.
1051
1052KeyphraseExtractor.extract_keyphrases:Extract keyphrases automatically with Kea (default settings).
1053
1054KeyphraseExtractor.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.
1055
1056KeyphraseExtractor.extract_keyphrase_options:Options for keyphrase extraction with Kea. For example: mALIWEB - use ALIWEB extraction model; n5 - extract 5 keyphrase;, eGBK - use GBK encoding.
1057
1058KeyphraseExtractor.keyphrases:keyphrases
1059
1060KeyphraseExtractor.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.
1061
1062LaTeXPlugin.desc:Plugin for LaTeX documents.
1063
1064LOMPlugin.desc:Plugin for importing LOM (Learning Object Metadata) files.
1065
1066LOMPlugin.root_tag:The DocType of the XML file (or a regular expression that matches the root element).
1067
1068LOMPlugin.check_timestamp:Check timestamps of previously downloaded files, and only download again if source file is newer.
1069
1070LOMPlugin.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.
1071
1072MARCPlugin.desc:Basic MARC plugin.
1073
1074MARCPlugin.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.
1075
1076MARCXMLPlugin.desc:MARCXML plugin.
1077
1078MARCXMLPlugin.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.
1079
1080MediainfoOGVPlugin.desc:Plugin for importing OGV movie files. Requires Mediainfo (mediainfo.sourceforge.net) to be installed to extract metadata.
1081
1082MediainfoOGVPlugin.assoc_field:Name of the metadata field that will hold the movie file's name.
1083
1084MediaWikiPlugin.desc:Plugin for importing MediaWiki web pages
1085
1086MediaWikiPlugin.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.
1087
1088MediaWikiPlugin.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.
1089
1090MediaWikiPlugin.toc_exp:A Perl regular expression to match the 'table of contents'. The default value matches common MediaWiki web pages.
1091
1092MediaWikiPlugin.delete_nav:Delete the navigation section. Needs to specify a Perl regular expression in nav_div_exp below.
1093
1094MediaWikiPlugin.nav_div_exp:A Perl regular expression to match the navigation section. The default value matches common MediaWiki web pages.
1095
1096MediaWikiPlugin.delete_searchbox:Delete the searchbox section. Needs to specify a Perl regular expression in searchbox_div_exp below.
1097
1098MediaWikiPlugin.searchbox_div_exp:A Perl regular expression to match the searchbox section. The default value matches common MediaWiki web pages.
1099
1100MediaWikiPlugin.remove_title_suffix_exp:A Perl regular expression to trim the extracted title. For example, \\s-(.+) will trim title contents after "-".
1101
1102MetadataCSVPlugin.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.
1103
1104MetadataPass.desc:On-the-side base class to BaseImporter that supports metadata plugins utilise metadata_read pass of import.pl
1105
1106MetadataXMLPlugin.desc:Plugin that processes metadata.xml files.
1107
1108GreenstoneMETSPlugin.desc:Process Greenstone-style METS documents
1109
1110MP3Plugin.desc:Plugin for processing MP3 files.
1111
1112MP3Plugin.assoc_images:Use Google image search to locate images related to MP3 file based on ID3 Title and Artist metadata.
1113
1114MP3Plugin.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.
1115
1116MP3Plugin.metadata_fields:Comma separated list of metadata fields to extract (assuming present) in an MP3 file. Use \"*\" to extract all the fields.
1117
1118NulPlugin.desc:Dummy (.nul) file plugin. Used with the files produced by exploding metadata database files.
1119
1120NulPlugin.assoc_field:Name of a metadata field that will be set for each nul file.
1121NulPlugin.add_metadata_as_text:Add a table of metadata as the text of the document, rather than "This document has no text".
1122
1123NulPlugin.remove_namespace_for_text:Remove namepsaces from metadata names in the document text (if add_metadata_as_text is set).
1124
1125OAIPlugin.desc:Basic Open Archives Initiative (OAI) plugin.
1126
1127OAIPlugin.document_field:The metadata element specifying the file name of documents to attach the metadata to.
1128
1129OAIPlugin.metadata_set:Metadata set (namespace prefix) to import all metadata as
1130OAIPlugin.metadata_set.auto:Use the prefixes specified in the OAI record
1131OAIPlugin.metadata_set.dc: Use the dc prefix. Will map qualified dc elements into their Greenstone form, eg spatial becomes dc.Coverage^spatial.
1132
1133OAIMetadataXMLPlugin.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)
1134
1135OAIMetadataXMLPlugin.oai_server_http_path: HTTP Path to the OAI server - e.g. http://test.com/oai_server/oai.pl
1136
1137OAIMetadataXMLPlugin.metadata_prefix: OAI metadata prefix - default oai_dc
1138
1139OAIMetadataXMLPlugin.koha_mode: If specified, the plugin will try to generate the oaiextracted.koharecordlink metadata. This metadata contains the link back to Koha document.
1140
1141OggVorbisPlugin.add_technical_metadata:Add technical (eg. bitrate) metadata.
1142
1143OggVorbisPlugin.desc:A plugin for importing Ogg Vorbis audio files.
1144
1145OpenDocumentPlugin.desc:Plugin for OASIS OpenDocument format documents (used by OpenOffice 2.0)
1146
1147PagedImagePlugin.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.
1148
1149PagedImagePlugin.documenttype:Set the document type (used for display)
1150
1151PagedImagePlugin.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).
1152PagedImagePlugin.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).
1153
1154PagedImagePlugin.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.
1155PagedImagePlugin.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.
1156
1157PagedImagePlugin.documenttype.hierarchy: Hierarchical documents have internal structure and will be displayed with a table of contents
1158
1159PagedImagePlugin.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.
1160
1161PagedImagePlugin.headerpage:Add a top level header page (that contains no image) to each document.
1162
1163PDFPlugin.allowimagesonly:Allow PDF files with no extractable text. Avoids the need to have -complex set. Only useful with convert_to html.
1164
1165PDFPlugin.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).
1166
1167PDFPlugin.convert_to.paged_html:A series of HTML pages, one for each page. Each HTML page contains selectable text positionally overlaid on top of a screenshot of the PDF page background comprising any images, tables and drawings.
1168
1169PDFPlugin.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
1170
1171PDFPlugin.desc:Plugin that processes PDF documents using the older pdftohtml tool. Does not support newer PDF versions.
1172
1173PDFPlugin.nohidden:Prevent pdftohtml from attempting to extract hidden text. This is only useful if the -complex option is also set.
1174
1175PDFPlugin.noimages:Don't attempt to extract images from PDF.
1176
1177PDFPlugin.use_realistic_book:Converts the PDF to a well-formed XHTML document to enable users view it in the realistic book format.
1178
1179PDFPlugin.use_sections:Create a separate section for each page of the PDF file.
1180
1181PDFPlugin.zoom:The factor by which to zoom the PDF for output. If not outputting as paged_html, then zoom is only useful if -complex is set.
1182
1183PostScriptPlugin.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
1184
1185PostScriptPlugin.extract_date:Extract date from PS header.
1186
1187PostScriptPlugin.extract_pages:Extract pages from PS header.
1188
1189PostScriptPlugin.extract_title:Extract title from PS header.
1190
1191PowerPointPlugin.desc:A plugin for importing Microsoft PowerPoint files.
1192
1193PowerPointPlugin.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.
1194
1195PowerPointPlugin.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).
1196
1197PowerPointPlugin.convert_to.pagedimg:A series of JPEG images (needs -openoffice_conversion).
1198
1199PowerPointPlugin.convert_to.pagedimg_jpg:A series of images in JPEG format (needs -windows_scripting).
1200
1201PowerPointPlugin.convert_to.pagedimg_gif:A series of images in GIF format (needs -windows_scripting).
1202
1203PowerPointPlugin.convert_to.pagedimg_png:A series of images in PNG format (needs -windows_scripting).
1204
1205PrintInfo.bad_general_option:The %s plugin uses an incorrect option. Check your collect.cfg configuration file.
1206
1207PrintInfo.desc:Most base plugin, handles printing info (using pluginfo.pl) and parsing of the arguments.
1208
1209ProCitePlugin.desc:A plugin for (exported) ProCite databases
1210
1211ProCitePlugin.entry_separator:The string used to separate multiple values for single metadata fields in ProCite database records.
1212
1213ReadTextFile.could_not_extract_encoding:WARNING: encoding could not be extracted from %s - defaulting to %s
1214
1215ReadTextFile.could_not_extract_language:WARNING: language could not be extracted from %s - defaulting to %s
1216
1217ReadTextFile.could_not_open_for_reading:could not open %s for reading
1218
1219ReadTextFile.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.
1220
1221ReadTextFile.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.
1222
1223ReadTextFile.desc:Base plugin for files that are plain text.
1224
1225ReadTextFile.empty_file:file contains no text
1226
1227ReadTextFile.extract_language:Identify the language of each document and set 'Language' metadata. Note that this will be done automatically if -input_encoding is 'auto'.
1228
1229ReadTextFile.file_has_no_text:ERROR: %s contains no text
1230
1231ReadTextFile.input_encoding:The encoding of the source documents. Documents will be converted from these encodings and stored internally as utf8.
1232
1233ReadTextFile.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.
1234
1235ReadTextFile.read_denied:Read permission denied for %s
1236
1237ReadTextFile.separate_cjk:Insert spaces between Chinese/Japanese/Korean characters to make each character a word. Use if text is not segmented.
1238
1239ReadTextFile.unsupported_encoding:WARNING: %s appears to be encoded in an unsupported encoding (%s) - using %s
1240
1241ReadTextFile.wrong_encoding:WARNING: %s was read using %s encoding but appears to be encoded as %s.
1242
1243ReadXMLFile.desc:Base class for XML plugins.
1244
1245ReadXMLFile.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.
1246
1247RealMediaPlugin.desc:A plugin for processing Real Media files.
1248
1249ReferPlugin.desc:ReferPlugin reads bibliography files in Refer format.
1250
1251RogPlugin.desc:Creates simple single-level documents from .rog or .mdb files.
1252
1253RTFPlugin.desc:Plugin for importing Rich Text Format files.
1254
1255SourceCodePlugin.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)
1256
1257SourceCodePlugin.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.
1258
1259SplitTextFile.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.
1260
1261SplitTextFile.split_exp:A perl regular expression to split input files into segments.
1262
1263StructuredHTMLPlugin.desc:A plugin to process structured HTML documents, splitting them into sections based on style information.
1264
1265StructuredHTMLPlugin.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.
1266
1267StructuredHTMLPlugin.title_header:possible user-defined styles for the title header.
1268
1269StructuredHTMLPlugin.level1_header:possible user-defined styles for the level1 header in the HTML document (equivalent to <h1>).
1270
1271StructuredHTMLPlugin.level2_header:possible user-defined styles for the level2 header in the HTML document (equivalent to <h2>).
1272
1273StructuredHTMLPlugin.level3_header:possible user-defined styles for the level3 header in the HTML document (equivalent to <h3>).
1274
1275StructuredHTMLPlugin.toc_header:possible user-defined header styles for the table of contents, table of figures etc, to be removed if delete_toc is set.
1276
1277TextPlugin.desc:Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).
1278
1279TextPlugin.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.
1280
1281UnknownConverterPlugin.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.
1282
1283UnknownConverterPlugin.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.
1284
1285UnknownConverterPlugin.output_file_or_dir_name: Full pathname of the output file or of the directory (of output files) that get generated by the conversion
1286
1287UnknownPlugin.assoc_field:Name of the metadata field that will hold the associated file's name.
1288
1289UnknownPlugin.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.
1290
1291UnknownPlugin.file_format:Type of the file (e.g. MPEG, MIDI, ...)
1292
1293UnknownPlugin.mime_type:Mime type of the file (e.g. image/gif).
1294
1295UnknownPlugin.process_extension:Process files with this file extension. This option is an alternative to process_exp that is simpler to use but less flexible.
1296
1297UnknownPlugin.srcicon:Specify a macro name (without underscores) to use as srcicon metadata.
1298
1299WordPlugin.desc:A plugin for importing Microsoft Word documents.
1300
1301WordPlugin.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.
1302
1303WordPlugin.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
1304
1305ZIPPlugin.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)
1306
1307#
1308# Download module option descriptions
1309#
1310
1311BaseDownload.desc:Base class for Download modules
1312BaseDownload.bad_general_option:The %s download module uses an incorrect option.
1313MediaWikiDownload.desc:A module for downloading from MediaWiki websites
1314MediaWikiDownload.reject_filetype:Ignore url list, separate by comma, e.g.*cgi-bin*,*.ppt ignores hyperlinks that contain either 'cgi-bin' or '.ppt'
1315MediaWikiDownload.reject_filetype_disp:Ignore URL patterns
1316MediaWikiDownload.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.
1317MediaWikiDownload.exclude_directories_disp:Exclude directories
1318
1319OAIDownload.desc:A module for downloading from OAI repositories
1320OAIDownload.url_disp:Source URL
1321OAIDownload.url:OAI repository URL
1322OAIDownload.set_disp:Restrict to set
1323OAIDownload.set:Restrict the download to the specified set in the repository
1324OAIDownload.metadata_prefix_disp:Metadata prefix
1325OAIDownload.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.
1326OAIDownload.get_doc_disp:Get document
1327OAIDownload.get_doc:Download the source document if one is specified in the record
1328OAIDownload.get_doc_exts_disp:Only include file types
1329OAIDownload.get_doc_exts:Permissible filename extensions of documents to get
1330OAIDownload.max_records_disp:Max records
1331OAIDownload.max_records:Maximum number of records to download
1332
1333SRWDownload.desc:A module for downloading from SRW (Search/Retrieve Web Service) repositories
1334
1335WebDownload.desc:A module for downloading from the Internet via HTTP or FTP
1336WebDownload.url:Source URL. In case of http redirects, this value may change
1337WebDownload.url_disp:Source URL
1338WebDownload.depth:How many hyperlinks deep to go when downloading
1339WebDownload.depth_disp:Download Depth
1340WebDownload.below:Only mirror files below this URL
1341WebDownload.below_disp:Only files below URL
1342WebDownload.within:Only mirror files within the same site
1343WebDownload.within_disp:Only files within site
1344WebDownload.html_only:Download only HTML files, and ignore associated files e.g images and stylesheets
1345WebDownload.html_only_disp:Only HTML files
1346WebDownload.proxied_connect_failed_info:Current proxy settings are:
1347WebDownload.http_proxy_settings:- HTTP host=%s : port=%s
1348WebDownload.https_proxy_settings:- HTTPS host=%s : port=%s
1349WebDownload.ftp_proxy_settings:- FTP host=%s : port=%s
1350WebDownload.proxyless_connect_failed_info:- The external server might not be responding\n- or you might need to switch on proxy settings
1351WebDownload.connect_failed_info:- or try ticking No Certificate Checking (affects 'https' URLs)\nin File > Preferences > Connection
1352
1353WgetDownload.desc: Base class that handles calls to wget
1354WgetDownload.proxy_on:Proxy on
1355WgetDownload.http_proxy_host:HTTP proxy host
1356WgetDownload.http_proxy_port:HTTP proxy port
1357WgetDownload.https_proxy_host:HTTPS proxy host
1358WgetDownload.https_proxy_port:HTTPS proxy port
1359WgetDownload.ftp_proxy_host:FTP proxy host
1360WgetDownload.ftp_proxy_port:FTP proxy port
1361WgetDownload.user_name:User name
1362WgetDownload.user_password:User password
1363WgetDownload.no_check_certificate:No check certificate
1364WgetDownload.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
1365
1366Z3950Download.desc:A module for downloading from Z3950 repositories
1367Z3950Download.host:Host URL
1368Z3950Download.host_disp:Host
1369Z3950Download.port:Port number of the repository
1370Z3950Download.port_disp:Port
1371Z3950Download.database:Database to search for records in
1372Z3950Download.database_disp:Database
1373Z3950Download.find:Retrieve records containing the specified search term
1374Z3950Download.find_disp:Find
1375Z3950Download.max_records:Maximum number of records to download
1376Z3950Download.max_records_disp:Max Records
1377
1378
1379#
1380# Plugout option descriptions
1381#
1382
1383BasPlugout.bad_general_option:The %s plugout uses an incorrect option.
1384BasPlugout.debug:Set debugging mode
1385BasPlugout.desc:Base class for all the export plugouts.
1386BasPlugout.group_size:Number of documents to group into one XML file.
1387BasPlugout.gzip_output:Use gzip to compress resulting xml documents (don't forget to include ZIPPlugin in your plugin list when building from compressed documents).
1388# '
1389BasPlugout.no_auxiliary_databases:Don't generate archivesinf databases - useful when exporting.
1390# '
1391BasPlugout.output_handle: the file descriptor used to receive output data
1392BasPlugout.output_info:The reference to an arcinfo object used to store information about the archives.
1393BasPlugout.verbosity:Controls the quantity of output. 0=none, 3=lots.
1394BasPlugout.xslt_file:Transform a document with the XSLT in the named file.
1395BasPlugout.subdir_hash_prefix:Specify flag to not count the word HASH in the split length calculation.
1396BasPlugout.subdir_split_length:The maximum number of characters before spliting an archives subdirectory.
1397BasPlugout.no_rss:Suppress the automatic generation of RSS feed file.
1398BasPlugout.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
1399
1400DSpacePlugout.desc:DSpace Archive format.
1401DSpacePlugout.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.
1402
1403FedoraMETSPlugout.desc:METS format using the Fedora profile.
1404FedoraMETSPlugout.fedora_namespace:The prefix used in Fedora for process ids (PIDS) e.g. greenstone:HASH0122efe4a2c58d0
1405
1406GreenstoneXMLPlugout.desc:Greenstone XML Archive format.
1407
1408GreenstoneMETSPlugout.desc:METS format using the Greenstone profile.
1409
1410MARCXMLPlugout.desc:MARC xml format.
1411MARCXMLPlugout.group:Output the marc xml records into a single file.
1412MARCXMLPlugout.mapping_file:Use the named mapping file for the transformation.
1413
1414METSPlugout.desc:Superclass plugout for METS format. Provides common functionality for profiles such as GreenstoneMETS and FedoraMETS and key abstract methods.
1415METSPlugout.xslt_txt:Transform a mets's doctxt.xml with the XSLT in the named file.
1416METSPlugout.xslt_mets:Transform a mets's docmets.xml with the XSLT in the named file.
1417
1418#
1419# Perl module strings
1420#
1421
1422classify.could_not_find_classifier:ERROR: Could not find classifier \"%s\"
1423
1424download.could_not_find_download:ERROR: Could not find download module \"%s\"
1425
1426plugin.could_not_find_plugin:ERROR: Could not find plugin \"%s\"
1427
1428plugin.including_archive:including the contents of 1 ZIP/TAR archive
1429
1430plugin.including_archives:including the contents of %d ZIP/TAR archives
1431
1432plugin.kill_file:Process killed by .kill file
1433
1434plugin.n_considered:%d documents were considered for processing
1435
1436plugin.n_included:%d were processed and included in the collection
1437
1438plugin.n_rejected:%d were rejected
1439
1440plugin.n_unrecognised:%d were unrecognised
1441
1442plugin.no_plugin_could_process:WARNING: No plugin could process %s
1443
1444plugin.no_plugin_could_recognise:WARNING: No plugin could recognise %s
1445
1446plugin.no_plugin_could_process_this_file:no plugin could process this file
1447
1448plugin.no_plugin_could_recognise_this_file:no plugin could recognise this file
1449
1450plugin.one_considered:1 document was considered for processing
1451
1452plugin.one_included:1 was processed and included in the collection
1453
1454plugin.one_rejected:1 was rejected
1455
1456plugin.one_unrecognised:1 was unrecognised
1457
1458plugin.see_faillog:See %s for a list of unrecognised and/or rejected documents
1459
1460PrintUsage.default:Default
1461
1462PrintUsage.required:REQUIRED
1463
1464plugout.could_not_find_plugout:ERROR: Could not find plugout \"%s\"
Note: See TracBrowser for help on using the repository browser.