source: trunk/gsdl/perllib/strings.properties@ 13889

Last change on this file since 13889 was 13889, checked in by cvs_anon, 17 years ago

modified the desc of NewList

  • Property svn:keywords set to Author Date Id Revision
File size: 62.5 KB
Line 
1#
2# Resource bundle description
3#
4
5Language.code:en
6Language.name:English
7
8OutputEncoding.unix:iso_8859_1
9OutputEncoding.windows:iso_8859_1
10
11
12#
13# Common output messages
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
46#
47# Script option descriptions and output messages
48#
49
50scripts.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.
51
52scripts.xml:Produces the information in an XML form, without 'pretty' comments but with much more detail.
53
54scripts.listall:Lists all items known about.
55scripts.describeall:Display options for all items known about
56
57scripts.both_old_options:WARNING: -removeold was specified with -keepold or -incremental, defaulting to -removeold. Current contents of %s directory will be deleted.
58
59scripts.no_old_options:WARNING: None of -removeold, -keepold or -incremental were specified, defaulting to -removeold. Current contents of %s directory will be deleted.
60
61# -- buildcol.pl --
62
63buildcol.archivedir:Where the archives live.
64
65buildcol.builddir:Where to put the built indexes.
66
67buildcol.cachedir:Collection will be temporarily built here before being copied to the build directory.
68
69buildcol.cannot_open_cfg_file:WARNING: Can't open config file for updating: %s
70
71buildcol.collectdir:The path of the "collect" directory.
72
73buildcol.copying_back_cached_build:Copying back the cached build
74
75buildcol.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.
76
77buildcol.debug:Print output to STDOUT.
78
79buildcol.desc:PERL script used to build a greenstone collection from GA documents.
80
81buildcol.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed.
82
83buildcol.index:Index to build (will build all in config file if not set).
84
85buildcol.incremental:Only index documents which have not been previously indexed. Implies -keepold. Relies on the lucene indexer.
86
87buildcol.incremental_dlc:Truely incremental update of the GDBM database. Only works for hierarchy classifiers.
88
89buildcol.keepold:Will not destroy the current contents of the building directory.
90
91buildcol.maxdocs:Maximum number of documents to build.
92buildcol.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".
93buildcol.mode:The parts of the building process to carry out.
94buildcol.mode.all:Do everything.
95buildcol.mode.build_index:Just index the text.
96buildcol.mode.compress_text:Just compress the text.
97buildcol.mode.infodb:Just build the metadata database.
98
99buildcol.no_default_images:Default images will not be generated.
100
101buildcol.no_image_script:WARNING: Image making script could not be found: %s
102
103buildcol.no_strip_html:Do not strip the html tags from the indexed text (only used for mgpp collections).
104
105buildcol.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).
106
107buildcol.sections_index_document_metadata:Index document level metadata at section level
108buildcol.sections_index_document_metadata.never:Don't index any document metadata at section level.
109buildcol.sections_index_document_metadata.always:Add all specified document level metadata even if section level metadata of that name exists.
110buildcol.sections_index_document_metadata.unless_section_metadata_exists:Only add document level metadata if no section level metadata of that name exists.
111
112buildcol.out:Filename or handle to print output status to.
113
114buildcol.params:[options] collection-name
115
116buildcol.remove_empty_classifications:Hide empty classifiers and classification nodes (those that contain no documents).
117
118buildcol.removeold:Will remove the old contents of the building directory.
119
120buildcol.unlinked_col_images:Collection images may not be linked correctly.
121
122buildcol.unknown_mode:Unknown mode: %s
123
124buildcol.updating_archive_cache:Updating archive cache
125
126buildcol.verbosity:Controls the quantity of output. 0=none, 3=lots.
127
128
129# -- classinfo.pl --
130
131classinfo.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.
132
133classinfo.desc:Prints information about a classifier.
134
135classinfo.general_options:General options are inherited from parent classes of the classifier.
136
137classinfo.info:info
138
139classinfo.no_classifier_name:ERROR: You must provide a classifier name.
140
141classinfo.option_types:Classifiers may take two types of options
142
143classinfo.params:[options] classifier-name
144
145classinfo.passing_options:Options may be passed to any classifier by including them in your collect.cfg configuration file.
146
147classinfo.specific_options:Specific options are defined within the classifier itself, and are available only to this particular classifier.
148
149# -- downloadfrom.pl --
150downloadfrom.cache_dir:The location of the cache directory
151downloadfrom.desc:Downloads files from an external server
152downloadfrom.download_mode:The type of server to download from
153downloadfrom.download_mode.Web:HTTP
154downloadfrom.download_mode.OAI: Open Archives Initiative
155downloadfrom.download_mode.z3950:z3950 server
156downloadfrom.download_mode.SRW:SearchRetrieve Webservice
157downloadfrom.incorrect_mode:download_mode parameter was incorrect.
158downloadfrom.info:Print information about the server, rather than downloading
159downloadfrom.params:[general options] [specific download options]
160
161# -- downloadinfo.pl --
162
163downloadinfo.desc:Prints information about a download module
164downloadinfo.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.
165downloadinfo.params:[options] [download-module]
166downloadinfo.general_options:General options are inherited from parent classes of the download modules.
167downloadinfo.specific_options:Specific options are defined within the download module itself, and are available only to this particular downloader.
168downloadinfo.option_types:Download modules may take two types of options
169
170# -- explode_metadata_database.pl --
171explode.desc:Explode a metadata database
172
173explode.document_field:The metadata element specifying the file name of documents to obtain and include in the collection.
174
175explode.document_prefix:A prefix for the document locations (for use with the document_field option).
176
177explode.document_suffix:A suffix for the document locations (for use with the document_field option).
178
179explode.encoding:Encoding to use when reading in the database file
180explode.metadata_set:Metadata set (namespace) to export all metadata as
181explode.plugin: Plugin to use for exploding
182explode.params: [options] filename
183explode.records_per_folder: The number of records to put in each subfolder.
184
185# -- exportcol.pl --
186
187exportcol.out:Filename or handle to print output status to.
188exportcol.cddir:The name of the directory that the CD contents are exported to.
189exportcol.cdname:The name of the CD-ROM -- this is what will appear in the start menu once the CD-ROM is installed.
190exportcol.desc:PERL script used to export one or more collections to a Windows CD-ROM.
191exportcol.noinstall:Create a CD-ROM where the library runs directly off the CD-ROM and nothing is installed on the host computer.
192exportcol.params:[options] collection-name1 collection-name2 ...
193exportcol.coll_not_found:Ignoring invalid collection %s: collection not found at %s.
194exportcol.coll_dirs_not_found:Ignoring invalid collection %s: one of the following directories not found:
195exportcol.fail:exportcol.pl failed:
196exportcol.no_valid_colls:No valid collections specified to export.
197exportcol.couldnt_create_dir:Could not create directory %s.
198exportcol.couldnt_create_file:Could not create %s.
199exportcol.instructions:To create a self-installing Windows CD-ROM, write the contents of this folder out to a CD-ROM.
200exportcol.non_exist_files:One or more of the following necessary files and directories does not exist:
201exportcol.success:exportcol.pl succeeded:
202exportcol.output_dir:The exported collections (%s) are in %s.
203exportcol.export_coll_not_installed:The Export to CD-ROM functionality has not been installed.
204
205# -- import.pl --
206
207import.archivedir:Where the converted material ends up.
208
209import.manifest:An XML file that details what files are to be imported. Used instead of recursively descending the import folder, typically for incremental building.
210
211import.cannot_open_stats_file:WARNING: Couldn't open stats file %s.
212
213import.cannot_open_fail_log:ERROR: Couldn't open fail log %s
214
215import.cannot_sort:WARNING: import.pl cannot sort documents when groupsize > 1. sortmeta option will be ignored.
216
217import.collectdir:The path of the "collect" directory.
218
219import.complete:Import complete
220
221import.debug:Print imported text to STDOUT (for GA importing)
222
223import.desc:PERL script used to import files into a GA format ready for building.
224
225import.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed.
226
227import.groupsize:Number of import documents to group into one XML file.
228
229import.gzip:Use gzip to compress resulting xml documents (don't forget to include ZIPPlug in your plugin list when building from compressed documents).
230
231import.importdir:Where the original material lives.
232
233import.incremental:Only import documents which are newer (by timestamp) than the current archives files. Implies -keepold.
234
235import.keepold:Will not destroy the current contents of the archives directory.
236
237import.maxdocs:Maximum number of documents to import.
238
239import.no_import_dir:Error: Import dir (%s) not found.
240
241import.no_plugins_loaded:ERROR: No plugins loaded.
242
243import.OIDtype:The method to use when generating unique identifiers for each document.
244import.OIDtype.hash:Hash the contents of the file. Document identifiers will be the same every time the collection is imported.
245
246import.OIDtype.incremental:Use a simple document count. Significantly faster than "hash", but does not assign the same identifier to the same document content, and further documents cannot be added to existing archives.
247
248import.OIDtype.assigned:Use the metadata value given by the OIDmetadata option (preceded by 'D'); if unspecified, for a particular document a hash is used instead. These identifiers should be unique.
249
250import.OIDtype.dirname:Use the parent directory name (preceded by 'J'). There should only be one document per directory, and directory names should be unique. E.g. import/b13as/h15ef/page.html will get an identifier of Jh15ef.
251
252import.OIDmetadata:Specifies the metadata element that hold's the document's unique identifier, for use with -OIDtype=assigned.
253
254import.saveas:This is to decide the archives format to be generated. The default setting is to GA.
255
256import.saveas.GA:Will generate Greenstone Archive format.
257
258import.saveas.METS:Will generate METS format.
259
260import.out:Filename or handle to print output status to.
261
262import.params:[options] collection-name
263
264import.removeold:Will remove the old contents of the archives directory.
265
266import.removing_archives:Removing current contents of the archives directory...
267
268import.removing_tmpdir:Removing contents of the collection "tmp" directory...
269
270import.sortmeta:Sort documents alphabetically by metadata for building. Search results for boolean queries will be displayed in this order. This will be disabled if groupsize > 1. May be a commma separated list to sort by more than one metadata value.
271
272import.statsfile:Filename or handle to print import statistics to.
273
274import.stats_backup:Will print stats to STDERR instead.
275
276import.verbosity:Controls the quantity of output. 0=none, 3=lots.
277
278
279# -- export.pl --
280
281export.exportdir:Where the export material ends up.
282
283export.cannot_open_stats_file:WARNING: Couldn't open stats file %s.
284
285export.cannot_open_fail_log:ERROR: Couldn't open fail log %s
286
287export.cannot_sort:WARNING: export.pl cannot sort documents when groupsize > 1. sortmeta option will be ignored.
288
289export.collectdir:The path of the "collect" directory.
290
291export.complete:Export complete
292
293export.debug:Print exported text to STDOUT (for GA exporting)
294
295export.desc:PERL script used to export files in a Greenstone collection to another format.
296
297export.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed. (Default: collectdir/collname/etc/fail.log)
298
299export.groupsize:Number of documents to group into one XML file.
300
301export.gzip:Use gzip to compress resulting xml documents (don't forget to include ZIPPlug in your plugin list when building from compressed documents).
302
303export.importdir:Where the original material lives.
304
305export.keepold:Will not destroy the current contents of the export directory.
306
307export.maxdocs:Maximum number of documents to export.
308
309export.listall:List all the saveas formats
310
311export.saveas:Format to export documents as.
312
313export.saveas.DSpace:DSpace Archive format.
314
315export.saveas.METS:METS format using the Greenstone profile.
316
317export.saveas.GA:Greenstone Archive format
318
319export.saveas.MARCXML:MARC XML format (an XML version of MARC 21)
320
321export.saveas_version:Currently only valid with 'saveas METS', options are 'greenstone', for Greenstone METS, or 'fedora', for Fedora METS.
322
323export.out:Filename or handle to print output status to.
324
325export.params:[options] collection-name1, collection-name2...
326
327export.removeold:Will remove the old contents of the export directory.
328
329export.removing_export:Removing current contents of the export directory...
330
331export.sortmeta:Sort documents alphabetically by metadata for building. This will be disabled if groupsize > 1.
332
333export.statsfile:Filename or handle to print export statistics to.
334
335export.stats_backup:Will print stats to STDERR instead.
336
337export.verbosity:Controls the quantity of output. 0=none, 3=lots.
338
339
340
341# -- mkcol.pl --
342
343mkcol.about:The about text for the collection.
344
345mkcol.bad_name_cvs:ERROR: No collection can be named CVS as this may interfere with directories created by the CVS versioning system.
346
347mkcol.bad_name_modelcol:ERROR: No collection can be named modelcol as this is the name of the model collection.
348
349mkcol.cannot_find_modelcol:ERROR: Cannot find the model collection %s
350
351mkcol.col_already_exists:ERROR: This collection already exists.
352
353mkcol.collectdir:Directory where new collection will be created.
354
355mkcol.creating_col:Creating the collection %s
356
357mkcol.creator:The collection creator's e-mail address.
358
359mkcol.creator_undefined:ERROR: The creator was not defined. This variable is needed to recognise duplicate collection names.
360
361mkcol.desc:PERL script used to create the directory structure for a new Greenstone collection.
362
363mkcol.doing_replacements:doing replacements for %s
364
365mkcol.long_colname:ERROR: The collection name must be less than 8 characters so compatibility with earlier filesystems can be maintained.
366
367mkcol.maintainer:The collection maintainer's email address (if different from the creator).
368
369mkcol.no_collectdir:ERROR: The collect dir doesn't exist: %s
370
371mkcol.no_colname:ERROR: No collection name was specified.
372
373mkcol.optionfile:Get options from file, useful on systems where long command lines may cause problems.
374
375mkcol.params:[options] collection-name
376
377mkcol.plugin:Perl plugin module to use (there may be multiple plugin entries).
378
379mkcol.public:If this collection has anonymous access.
380mkcol.public.true:Collection is public
381mkcol.public.false:Collection is private
382
383mkcol.quiet:Operate quietly.
384
385mkcol.success:The new collection was created successfully at %s
386
387mkcol.title:The title of the collection.
388
389mkcol.win31compat:Whether or not the named collection directory must conform to Windows 3.1 file conventions or not (i.e. 8 characters long).
390mkcol.win31compat.true:Directory name 8 characters or less
391mkcol.win31compat.false:Directory name any length
392
393# -- pluginfo.pl --
394
395pluginfo.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.
396
397pluginfo.desc:Prints information about a plugin.
398
399pluginfo.general_options:General options are inherited from parent classes of the plugin.
400
401pluginfo.info:info
402
403pluginfo.no_plugin_name:ERROR: You must provide a plugin name.
404
405pluginfo.option_types:Plugins may take two types of options
406
407pluginfo.params:[options] plugin-name
408
409pluginfo.passing_options:Options may be passed to any plugin by including them in your collect.cfg configuration file.
410
411pluginfo.specific_options:Specific options are defined within the plugin itself, and are available only to this particular plugin.
412
413
414# -- plugoutinfo.pl --
415
416plugoutinfo.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.
417
418plugoutinfo.desc:Prints information about a plugout.
419
420plugoutinfo.general_options:General options are inherited from parent classes of the plugout.
421
422plugoutinfo.info:info
423
424plugoutinfo.no_plugout_name:ERROR: You must provide a plugout name.
425
426plugoutinfo.option_types:Plugouts may take two types of options
427
428plugoutinfo.params:[options] plugout-name
429
430plugoutinfo.passing_options:Options may be passed to any plugout by including them in your collect.cfg configuration file.
431
432plugoutinfo.specific_options:Specific options are defined within the plugout itself, and are available only to this particular plugout.
433
434
435#
436# Plugout option descriptions
437#
438
439MARCXMLPlugout.desc:MARC xml format.
440
441METSPlugout.desc:METS format using the Greenstone profile.
442
443BasPlugout.desc:Base class for all the export plugouts.
444
445GAPlugout.desc:Greenstone Archive format.
446
447DSpacePlugout.desc::DSpace Archive format.
448
449METSPlugout.version::Currently only valid with 'saveas METS', options are 'greenstone', for Greenstone METS, or 'fedora', for Fedora METS.
450
451BasPlugout.group_size:Number of documents to group into one XML file.
452
453BasPlugout.output_info:the reference to an arcinfo object used to store information about the archives.
454
455BasPlugout.output_handle: the file descriptor used to send output information
456
457BasPlugout.verbosity:Controls the quantity of output. 0=none, 3=lots.
458
459BasPlugout.gzip_output:Use gzip to compress resulting xml documents (don't forget to include ZIPPlug in your plugin list when building from compressed documents).
460
461BasPlugout.xslt_file:Transform a document with the XSLT in the named file.
462
463MARCXMLPlugout.group:Output the marc xml records into a single file.
464
465MARCXMLPlugout.mapping_file:Use the named mapping file for the transformation.
466
467METSPlugout.xslt_txt:Transform a mets's doctxt.xml with the XSLT in the named file.
468
469METSPlugout.xslt_mets:Transform a mets's docmets.xml with the XSLT in the named file.
470
471#
472# Classifier option descriptions
473#
474
475AllList.desc:Creates a single list of all documents. Use by the oaiserver.
476
477AZCompactList.allvalues:Use all metadata values found.
478
479AZCompactList.desc:Classifier plugin for sorting alphabetically (on a-zA-Z0-9). Produces a horizontal A-Z list, then a vertical list containing documents, or bookshelves for documents with common metadata.
480
481AZCompactList.doclevel:Level to process document at.
482AZCompactList.doclevel.top:Whole document.
483AZCompactList.doclevel.section:By sections.
484
485AZCompactList.firstvalueonly:Use only the first metadata value found.
486
487AZCompactList.freqsort:Sort by node frequency rather than alpha-numeric.
488
489AZCompactList.maxcompact:Maximum number of documents to be displayed per page.
490
491AZCompactList.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.
492
493AZCompactList.mincompact:Minimum number of documents to be displayed per page.
494
495AZCompactList.mingroup:The smallest value that will cause a group in the hierarchy to form.
496
497AZCompactList.minnesting:The smallest value that will cause a list to be converted into a nested list.
498
499AZCompactList.recopt:Used in nested metadata such as -metadata Year/Organisation.
500AZCompactList.sort:Metadata field to sort the leaf nodes by.
501
502AZCompactSectionList.desc:Variation on AZCompactList that classifies sections rather than documents. Entries are sorted by section-level metadata.
503
504AZList.desc:Classifier plugin for sorting alphabetically (on a-zA-Z0-9). Produces a horizontal A-Z list, with documents listed underneath.
505
506AZList.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.
507
508AZSectionList.desc:Variation on AZList that classifies sections rather that documents. Entries are sorted by section-level metadata.
509
510BasClas.bad_general_option:The %s classifier uses an incorrect option. Check your collect.cfg configuration file.
511
512BasClas.builddir:Where to put the built indexes.
513
514BasClas.buttonname:The label for the classifier screen and button in navigation bar. The default is the metadata element specified with -metadata.
515
516BasClas.desc:Base class for all the classifiers.
517
518BasClas.no_metadata_formatting:Don't do any automatic metadata formatting (for sorting.)
519
520BasClas.outhandle:The file handle to write output to.
521
522BasClas.removeprefix:A prefix to ignore in metadata values when sorting.
523
524BasClas.removesuffix:A suffix to ignore in metadata values when sorting.
525
526BasClas.verbosity:Controls the quantity of output. 0=none, 3=lots.
527
528Browse.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.
529
530DateList.bymonth:Classify by year and month instead of only year.
531
532DateList.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.
533
534DateList.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.
535
536DateList.reverse_sort:Sort the documents in reverse chronological order (newest first).
537
538DateList.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).
539
540DateList.no_special_formatting:Don't display Year and Month information in the document list.
541
542DateList.sort:An extra metadata field to sort by in the case where two documents have the same date.
543
544GenericList.always_bookshelf_last_level:Create a bookshelf icon even if there is only one item in each group at the leaf nodes.
545GenericList.classify_sections:Classify sections instead of documents.
546GenericList.desc:A general and flexible list classifier with most of the abilities of AZCompactList, but with better Unicode, metadata and sorting capabilities.
547GenericList.metadata:Metadata fields used for classification. Use '/' to separate the levels in the hierarchy and ';' to separate metadata fields within each level.
548GenericList.partition_size_within_level:The number of items in each partition (only applies when partition_type_within_level is set to 'constant_size').
549GenericList.partition_type_within_level:The type of partitioning done: either 'per_letter', 'constant_size', or 'none'.
550GenericList.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.
551GenericList.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.
552
553HFileHierarchy.desc:Classifier plugin for generating hierarchical classifications based on a supplementary structure file.
554
555Hierarchy.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).
556
557Hierarchy.documents_last:Display document nodes after classifier nodes.
558
559Hierarchy.hfile:Use the specified classification structure file.
560
561Hierarchy.hlist_at_top:Display the first level of the classification horizontally.
562
563Hierarchy.reverse_sort:Sort leaf nodes in reverse order (use with -sort).
564
565Hierarchy.separator:Regular expression used for the separator, if using structured metadata.
566
567Hierarchy.sort:Metadata field to sort leaf nodes by. Leaves will not be sorted if not specified.
568
569Hierarchy.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.
570
571Hierarchy.suppresslastlevel:Ignore the final part of the metadata value. This is useful for metadata where each value is unique, such as file paths.
572
573HTML.desc:Creates an empty classification that's simply a link to a web page.
574
575HTML.url:The url of the web page to link to.
576
577List.desc:Simple list classifier plugin.
578
579List.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.
580
581List.sort:Metadata field to sort by. Use '-sort nosort' for no sorting.
582
583Phind.desc:Produces a hierarchy of phrases found in the text, which is browsable via an applet.
584
585Phind.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.
586
587Phind.min_occurs:The minimum number of times a phrase must appear in the text to be included in the phrase hierarchy.
588
589Phind.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.
590
591Phind.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.
592
593Phind.text:The text used to build the phrase hierarchy.
594
595Phind.thesaurus:Name of a thesaurus stored in Phind format in the collection's etc directory.
596
597Phind.title:The metadata field used to describe each document.
598
599Phind.untidy:Don't remove working files.
600
601SectionList.desc:Same as List classifier but includes all sections of document (excluding top level) rather than just top level document itself.
602
603Collage.desc:An applet is used to display a collage of images found in the collection.
604
605Collage.geometry:The dimensions of the Collage canvas. For a canvas 600 pixels wide by 400 pixels high, for example, specify geometry as 600x400
606
607Collage.maxDepth:Images for collaging are drawn from mirroring the underlying browse classifier. This controls the maximum depth of the mirroring process.
608
609Collage.maxDisplay:The maximum number of images to show in the collage at any one time.
610
611Collage.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.
612
613Collage.bgcolor:The background color of the collage canvas, specified in hexadecimal form (for example #008000 results in a forest green background).
614
615Collage.buttonname:The label for the classifier screen and button in navigation bar.
616
617Collage.refreshDelay:Rate, in milliseconds, that the collage canvas is refreshed.
618
619Collage.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.
620
621Collage.imageMustNotHave:Used to suppress images that should not appear in the collage, such as image buttons that make up the navigation bar.
622
623Collage.caption:Optional captions to display below the collage canvas.
624
625NewList.desc:Get newly modified documents classifier plugin.
626
627NewList.after_specified_date:Used to specify a date. The date input format is either yyyymmdd or yyyy-mm-dd
628
629NewList.return_doc_size:The number of docs returned from the collection.
630
631#
632# Plugin option descriptions
633#
634
635ArcPlug.desc:Plugin which recurses through an archives.inf file (i.e. the file generated in the archives directory when an import is done), processing each file it finds.
636
637BasPlug.adding:adding
638
639BasPlug.already_seen:already seen
640
641BasPlug.bad_general_option:The %s plugin uses an incorrect option. Check your collect.cfg configuration file.
642
643BasPlug.block_exp:Files matching this regular expression will be blocked from being passed to any later plugins in the list. This has no real effect other than to prevent lots of warning messages about input files you don't care about. Each plugin might have a default block_exp. e.g. by default HTMLPlug blocks any files with .gif, .jpg, .jpeg, .png or .css file extensions.
644
645BasPlug.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.
646
647BasPlug.could_not_extract_encoding:WARNING: encoding could not be extracted from %s - defaulting to %s
648
649BasPlug.could_not_extract_language:WARNING: language could not be extracted from %s - defaulting to %s
650
651BasPlug.could_not_open_for_reading:could not open %s for reading
652
653BasPlug.no_cover_image:Do not look for a prefix.jpg file (where prefix is the same prefix as the file being processed) and associate it as a cover image.
654
655BasPlug.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.
656
657BasPlug.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.
658
659BasPlug.desc:Base class for all the import plugins.
660
661BasPlug.done_acronym_extract:done extracting acronyms.
662
663BasPlug.done_acronym_markup:done acronym markup.
664
665BasPlug.done_email_extract:done extracting e-mail addresses.
666
667BasPlug.dummy_text:This document has no text.
668
669BasPlug.empty_file:file contains no text
670
671BasPlug.extract_acronyms:Extract acronyms from within text and set as metadata.
672
673BasPlug.extract_email:Extract email addresses as metadata.
674
675BasPlug.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.
676
677BasPlug.extract_language:Identify the language of each document and set 'Language' metadata. Note that this will be done automatically if -input_encoding is 'auto'.
678
679BasPlug.extracting:extracting
680
681BasPlug.extracting_acronyms:extracting acronyms
682
683BasPlug.extract_keyphrases:Extract keyphrases automatically with Kea (default settings).
684
685BasPlug.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.
686
687BasPlug.extract_keyphrase_options:Options for keyphrase extraction with Kea. For example: mALIWEB - use ALIWEB extraction model; n5 - extract 5 keyphrase;, eGBK - use GBK encoding.
688
689BasPlug.extracting_emails:extracting e-mail addresses
690
691BasPlug.file_has_no_text:ERROR: %s contains no text
692
693BasPlug.first:Comma separated list of first sizes to extract from the text into a metadata field. The field is called 'FirstNNN'.
694
695BasPlug.input_encoding:The encoding of the source documents. Documents will be converted from these encodings and stored internally as utf8.
696BasPlug.input_encoding.ascii:Plain 7 bit ascii. This may be a bit faster than using iso_8859_1. Beware of using this on a collection of documents that may contain characters outside the plain 7 bit ascii set though (e.g. German or French documents containing accents), use iso_8859_1 instead.
697BasPlug.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.
698
699BasPlug.input_encoding.unicode:Just unicode.
700
701BasPlug.input_encoding.utf8:Either utf8 or unicode -- automatically detected.
702
703BasPlug.keyphrases:keyphrases
704
705BasPlug.marking_up_acronyms:marking up acronyms
706
707BasPlug.markup_acronyms:Add acronym metadata into document text.
708
709BasPlug.maximum_century:The maximum named century to be extracted as historical metadata (e.g. 14 will extract all references up to the 14th century).
710
711BasPlug.maximum_year:The maximum historical date to be used as metadata (in a Common Era date, such as 1950).
712
713BasPlug.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.
714
715BasPlug.must_be_implemented:BasPlug::read function must be implemented in sub-class for recursive plugins
716
717BasPlug.no_bibliography:Do not try to block bibliographic dates when extracting historical dates.
718
719BasPlug.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).
720
721BasPlug.read_denied:Read permission denied for %s
722
723BasPlug.separate_cjk:Insert spaces between Chinese/Japanese/Korean characters to make each character a word. Use if text is not segmented.
724
725BasPlug.smart_block:Block files in a smarter way than just looking at filenames.
726
727BasPlug.stems:stems
728
729BasPlug.unsupported_encoding:WARNING: %s appears to be encoded in an unsupported encoding (%s) - using %s
730
731BasPlug.wrong_encoding:WARNING: %s was read using %s encoding but appears to be encoded as %s.
732
733BibTexPlug.desc:BibTexPlug reads bibliography files in BibTex format. BibTexPlug creates a document object for every reference in the file. It is a subclass of SplitPlug, so if there are multiple records, all are read.
734
735BookPlug.desc:Creates multi-level document from document containing <<TOC>> level tags. Metadata for each section is taken from any other tags on the same line as the <<TOC>>. e.g. <<Title>>xxxx<</Title>> sets Title metadata. Everything else between TOC tags is treated as simple html (i.e. no processing of html links or any other HTMLPlug type stuff is done). Expects input files to have a .hb file extension by default (this can be changed by adding a -process_exp option a file with the same name as the hb file but a .jpg extension is taken as the cover image (jpg files are blocked by this plugin). BookPlug is a simplification (and extension) of the HBPlug used by the Humanity Library collections. BookPlug is faster as it expects the input files to be cleaner (The input to the HDL collections contains lots of excess html tags around <<TOC>> tags, uses <<I>> tags to specify images, and simply takes all text between <<TOC>> tags and start of text to be Title metadata). If you're marking up documents to be displayed in the same way as the HDL collections, use this plugin instead of HBPlug.
736
737ConvertToPlug.apply_fribidi:Run the "fribidi" Unicode Bidirectional Algorithm program over the converted file (for right-to-left text).
738ConvertToPlug.convert_to:Plugin converts to TEXT or HTML or various types of Image (e.g. JPEG, GIF, PNG).
739ConvertToPlug.convert_to.auto:Automatically select the format converted too. Format chosen depends on input document type, for example Word will automatically be converted to HTML, whereas PowerPoint will be converted to Greenstone's PagedImage format.
740ConvertToPlug.convert_to.html:HTML format.
741ConvertToPlug.convert_to.text:Plain text format.
742ConvertToPlug.convert_to.pagedimg_jpg:JPEG format.
743ConvertToPlug.convert_to.pagedimg_gif:GIF format.
744ConvertToPlug.convert_to.pagedimg_png:PNG format.
745
746ConvertToPlug.desc:This plugin is inherited by such plugins as WordPlug, PPTPlug, PSPlug, RTFPlug and PDFPlug. 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 (HTMLPlug, StructuredHTMLPlug, PagedImgPlug or TEXTPlug) based on the plugin argument 'convert_to'.
747ConvertToPlug.keep_original_filename:Keep the original filename for the associated file, rather than converting to doc.pdf, doc.doc etc.
748ConvertToPlug.use_strings:If set, a simple strings function will be called to extract text if the conversion utility fails.
749
750ConvertToRogPlug.desc:A plugin that inherits from RogPlug.
751
752CSVPlug.desc:A plugin for files in comma-separated value format. A new document will be created for each line of the file.
753
754DBPlug.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.
755
756DBPlug.title_sub:Substitution expression to modify string stored as Title. Used by, for example, PSPlug to remove "Page 1" etc from text used as the title.
757
758DSpacePlug.desc:DSpacePlug takes a collection of documents exported from DSpace and imports them into Greenstone.
759
760DSpacePlug.first_inorder_ext: This is used to identify the primary stream of DSpace collection document. With this option, the system will treat the defined ext types of document in sequence to look for the possible primary stream.
761DSpacePlug.first_inorder_mime:This is used to identify the primary data stream of DSpace collection document.With this option, the system will treat the defined mime types of document in sequence to look for the possible primary stream.
762DSpacePlug.only_first_doc:This is used to identify the primary data stream of DSpace collection document.With this option, the system will treat the first document in dublic_core metadata file as the possible primary stream.
763
764EMAILPlug.desc:Email plug 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)
765
766EMAILPlug.no_attachments:Do not save message attachments.
767
768EMAILPlug.headers:Store email headers as "Headers" metadata.
769
770EMAILPlug.split_exp:A perl regular expression used to split files containing many messages into individual documents.
771
772ExcelPlug.desc:A plugin for importing Microsoft Excel files (versions 95 and 97).
773
774FOXPlug.desc:Plugin to process a Foxbase dbt file. This plugin provides the basic functionality to read in the dbt and dbf files and process each record. This general plugin should be overridden for a particular database to process the appropriate fields in the file.
775
776GAPlug.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.
777
778GISBasPlug.extract_placenames:Extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
779
780GISBasPlug.gazetteer:Gazetteer to use to extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
781
782GISBasPlug.place_list:When extracting placements, include list of placenames at start of the document. Requires GIS extension to Greenstone.
783
784GMLPlug.desc:Plugin which processes a GML format document. It assumes that gml tags are all in lower-case.
785
786HBPlug.desc:Plugin which processes an HTML book directory. This plugin is used by the Humanity Library collections and does not handle input encodings other than ascii or extended ascii. This code is kind of ugly and could no doubt be made to run faster, by leaving it in this state I hope to encourage people to make their collections use HBSPlug instead ;-)\n\nUse HBSPlug if creating a new collection and marking up files like the Humanity Library collections. HBSPlug accepts all input encodings but expects the marked up files to be cleaner than those used by the Humanity Library collections
787
788HTMLPlug.assoc_files:Perl regular expression of file extensions to associate with html documents.
789
790HTMLPlug.desc:This plugin processes HTML files
791
792HTMLPlug.description_tags:Split document into sub-sections where <Section> tags occur. '-keep_head' will have no effect when this option is set.
793
794HTMLPlug.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.
795
796HTMLPlug.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.
797
798HTMLPlug.hunt_creator_metadata:Find as much metadata as possible on authorship and place it in the 'Creator' field.
799
800HTMLPlug.keep_head:Don't remove headers from html files.
801
802HTMLPlug.metadata_fields:Comma separated list of metadata fields to attempt to extract. Use 'tag<tagname>' to have the contents of the first <tagname> pair put in a metadata element called 'tagname'. Capitalise this as you want the metadata capitalised in Greenstone, since the tag extraction is case insensitive.
803
804HTMLPlug.no_metadata:Don't attempt to extract any metadata from files.
805
806HTMLPlug.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.
807
808HTMLPlug.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).
809
810HTMLPlug.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).
811
812HTMLPlug.sectionalise_using_h_tags:Automatically create a sectioned document using h1, h2, ... hX tags.
813
814HTMLPlug.title_sub:Substitution expression to modify string stored as Title. Used by, for example, PDFPlug to remove "Page 1", etc from text used as the title.
815
816ImagePlug.converttotype:Convert main image to format 's'.
817
818ImagePlug.desc:This plugin processes images, adding basic metadata
819
820ImagePlug.minimumsize:Ignore images smaller than n bytes.
821
822ImagePlug.noscaleup:Don't scale up small images when making thumbnails.
823
824ImagePlug.screenviewsize:If set, makes an image of size n for screen display and sets Screen, ScreenSize, ScreenWidth and ScreenHeight metadata. By default it is not set.
825
826ImagePlug.screenviewtype:If -screenviewsize is set, this sets the screen display image type.
827
828ImagePlug.thumbnailsize:Make thumbnails of size nxn.
829
830ImagePlug.thumbnailtype:Make thumbnails in format 's'.
831
832IndexPlug.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'.
833
834ISISPlug.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).
835
836ISISPlug.subfield_separator:The string used to separate subfields in CDS/ISIS database records.
837
838ISISPlug.entry_separator:The string used to separate multiple values for single metadata fields in CDS/ISIS database records.
839
840LaTeXPlug.desc:Plugin for LaTeX documents.
841
842LOMPlug.desc:Plugin for importing LOM (Learning Object Metadata) files.
843
844LOMPlug.root_tag:The DocType of the XML file (or a regular expression that matches the root element).
845LOMPlug.check_timestamp:Check timestamps of previously downloaded files, and only download again if source file is newer.
846LOMPlug.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.
847
848MARCPlug.desc:Basic MARC plugin.
849
850MARCPlug.metadata_mapping:Name of file that includes mapping details from MARC values to Greenstone metadata names. Defaults to 'marctodc.txt' found in the site's etc directory.
851
852MARCXMLPlug.desc:MARCXML plugin.
853
854MARCXMLPlug.metadata_mapping_file:Name of file that includes mapping details from MARC values to Greenstone metadata names. Defaults to 'marctodc.txt' found in the site's etc directory.
855
856MetadataCSVPlug.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.
857
858MetadataPass.desc:On-the-side base class to BasPlug that supports metadata plugins utilise metadata_read pass of import.pl
859
860METSPlug.desc:Process Greenstone-style METS documents
861
862GISBasPlug.desc: On-the-side base class to BasPlug that supports GIS capabilities
863
864NULPlug.desc:Dummy (.nul) file plugin. Used with the files produced by exploding metadata database files.
865
866NULPlug.assoc_field:Name of a metadata field that will be set for each nul file.
867NULPlug.add_metadata_as_text:Add a table of metadata as the text of the document, rather than "This document has no text".
868
869NULPlug.remove_namespace_for_text:Remove namepsaces from metadata names in the document text (if add_metadata_as_text is set).
870
871OAIPlug.desc:Basic Open Archives Initiative (OAI) plugin.
872
873OggVorbisPlug.add_technical_metadata:Add technical (eg. bitrate) metadata.
874
875OggVorbisPlug.desc:A plugin for importing Ogg Vorbis audio files.
876
877OpenDocumentPlug.desc:Plugin for OASIS OpenDocument format documents (used by OpenOffice 2.0)
878
879PagedImgPlug.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.
880
881PagedImgPlug.documenttype:Set the document type (used for display)
882PagedImgPlug.documenttype.paged:Paged documents have next and previous arrows and a 'go to page X' box
883PagedImgPlug.documenttype.hierarchy:Hierarchical documents have a table of contents
884
885PagedImgPlug.headerpage:Add a top level header page (that contains no image) to each document.
886
887PagedImgPlug.screenview:Produce a screenview image for each image, and set Screen, ScreenSize, ScreenWidth and ScreenHeight metadata.
888
889PagedImgPlug.screenviewsize:Make screenview images of size nxn.
890
891PagedImgPlug.screenviewtype:Make screenview images in format 's'.
892
893PagedImgPlug.thumbnail:Produce a thumbnail for each image
894
895PDFPlug.allowimagesonly:Allow PDF files with no extractable text. Avoids the need to have -complex set. Only useful with convert_to html.
896PDFPlug.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).
897
898PDFPlug.desc:Plugin that processes PDF documents.
899
900PDFPlug.nohidden:Prevent pdftohtml from attempting to extract hidden text. This is only useful if the -complex option is also set.
901
902PDFPlug.noimages:Don't attempt to extract images from PDF.
903
904PDFPlug.use_sections:Create a separate section for each page of the PDF file.
905
906PDFPlug.zoom:The factor by which to zoom the PDF for output (this is only useful if -complex is set).
907
908PPTPlug.desc:A plugin for importing Microsoft PowerPoint files.
909
910PPTPlug.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.
911
912ProCitePlug.desc:A plugin for (exported) ProCite databases
913
914PSPlug.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
915
916PSPlug.extract_date:Extract date from PS header.
917
918PSPlug.extract_pages:Extract pages from PS header.
919
920PSPlug.extract_title:Extract title from PS header.
921
922RealMediaPlug.desc:A plugin for processing Real Media files.
923
924RecPlug.desc:RecPlug is a plugin which recurses through directories processing each file it finds.
925
926RecPlug.recheck_directories:After the files in an import directory have been processed, re-read the directory to discover any new files created.
927
928RecPlug.use_metadata_files:(DEPRECATED - Add MetadataXMLPlug to the list of plugins instead) Read metadata from metadata XML files.
929
930ReferPlug.desc:ReferPlug reads bibliography files in Refer format.
931
932ReferPlug.longdesc:ReferPlug reads bibliography files in Refer format.\nBy Gordon W. Paynter (gwp\@cs.waikato.ac.nz), November 2000\n\nLoosely based on hcibib2Plug by Steve Jones (stevej\@cs.waikato.ac.nz). Which was based on EMAILPlug by Gordon Paynter (gwp\@cs.waikato.ac.nz). Which was based on old versions of HTMLplug and HCIBIBPlugby by Stefan Boddie and others -- it's hard to tell what came from where, now.\n\nReferPlug creates a document object for every reference in the file. It is a subclass of SplitPlug, so if there are multiple records, all are read.\n\nDocument text:\n\tThe document text consists of the reference in Refer format.\nMetadata:\n\t\$Creator \%A Author name\n\t\$Title \%T Title of article of book\n\t\$Journal \%J Title of Journal\n\t\$Booktitle \%B Title of book containing the publication\n\t\$Report \%R Type of Report, paper or thesis\n\t\$Volume \%V Volume Number of Journal\n\t\$Number \%N Number of Journal within Volume\n\t\$Editor \%E Editor name\n\t\$Pages \%P Page Number of article\n\t\$Publisher \%I Name of Publisher\n\t\$Publisheraddr \%C Publisher's address\n\t\$Date \%D Date of publication\n\t\$Keywords \%K Keywords associated with publication\n\t\$Abstract \%X Abstract of publication\n\t\$Copyright\t\%* Copyright information for the article
933
934RogPlug.desc:Creates simple single-level documents from .rog or .mdb files.
935
936RTFPlug.desc:Plugin for importing Rich Text Format files.
937
938SRCPlug.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)
939
940SRCPlug.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.
941
942SplitPlug.desc:SplitPlug 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 SplitPlug. See ReferPlug for an example.
943
944SplitPlug.split_exp:A perl regular expression to split input files into segments.
945
946StructuredHTMLPlug.desc:A plugin to process structured HTML documents, splitting them into sections based on style information.
947
948StructuredHTMLPlug.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.
949
950StructuredHTMLPlug.title_header:possible user-defined styles for the title header.
951
952StructuredHTMLPlug.level1_header:possible user-defined styles for the level1 header in the HTML document (equivalent to <h1>).
953
954StructuredHTMLPlug.level2_header:possible user-defined styles for the level2 header in the HTML document (equivalent to <h2>).
955
956StructuredHTMLPlug.level3_header:possible user-defined styles for the level3 header in the HTML document (equivalent to <h3>).
957
958StructuredHTMLPlug.toc_header:possible user-defined header styles for the table of contents, table of figures etc, to be removed if delete_toc is set.
959
960TEXTPlug.desc:Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).
961
962TEXTPlug.title_sub:Substitution expression to modify string stored as Title. Used by, for example, PSPlug to remove "Page 1" etc from text used as the title.
963
964UnknownPlug.assoc_field:Name of the metadata field that will hold the associated file's name.
965
966UnknownPlug.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.
967
968UnknownPlug.file_format:Type of the file (e.g. MPEG, MIDI, ...)
969
970UnknownPlug.mime_type:Mime type of the file (e.g. image/gif).
971
972UnknownPlug.process_extension:Process files with this file extension. This option is an alternative to process_exp that is simpler to use but less flexible.
973
974UnknownPlug.srcicon:Specify a macro name (without underscores) to use as srcicon metadata.
975
976MP3Plug.desc:Plugin for processing MP3 files.
977
978MP3Plug.assoc_images:Use Google image search to locate images related to MP3 file based on ID3 Title and Artist metadata.
979
980MP3Plug.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.
981
982MP3Plug.metadata_fields:Comma separated list of metadata fields to extract (assuming present) in an MP3 file. Use \"*\" to extract all the fields.
983
984W3ImgPlug.aggressiveness:Range of related text extraction techniques to use.
985W3ImgPlug.aggressiveness.1:Filename, path, ALT text only.
986W3ImgPlug.aggressiveness.2:All of 1, plus caption where available.
987W3ImgPlug.aggressiveness.3:All of 2, plus near paragraphs where available.
988W3ImgPlug.aggressiveness.4:All of 3, plus previous headers (<h1>, <h2>...) where available.
989W3ImgPlug.aggressiveness.5:All of 4, plus textual references where available.
990W3ImgPlug.aggressiveness.6:All of 4, plus page metatags (title, keywords, etc).
991W3ImgPlug.aggressiveness.7:All of 6, 5 and 4 combined.
992W3ImgPlug.aggressiveness.8:All of 7, plus repeat caption, filename, etc (raise ranking of more relevant results).
993W3ImgPlug.aggressiveness.9:All of 1, plus full text of source page.
994
995W3ImgPlug.caption_length:Maximum length of captions (in characters).
996
997W3ImgPlug.convert_params:Additional parameters for ImageMagicK convert on thumbnail creation. For example, '-raise' will give a three dimensional effect to thumbnail images.
998
999W3ImgPlug.desc:A plugin for extracting images and associated text from webpages.
1000
1001W3ImgPlug.document_text:Add image text as document:text (otherwise IndexedText metadata field).
1002
1003W3ImgPlug.index_pages:Index the pages along with the images. Otherwise reference the pages at the source URL.
1004
1005W3ImgPlug.max_near_text:Maximum characters near images to extract.
1006
1007W3ImgPlug.min_height:Pixels. Skip images shorter than this.
1008
1009W3ImgPlug.min_near_text:Minimum characters of near text or caption to extract.
1010
1011W3ImgPlug.min_size:Bytes. Skip images smaller than this.
1012
1013W3ImgPlug.min_width:Pixels. Skip images narrower than this.
1014
1015W3ImgPlug.neartext_length:Target length of near text (in characters).
1016
1017W3ImgPlug.no_cache_images:Don't cache images (point to URL of original).
1018
1019W3ImgPlug.smallpage_threshold:Images on pages smaller than this (bytes) will have the page (title, keywords, etc) meta-data added.
1020
1021W3ImgPlug.textrefs_threshold:Threshold for textual references. Lower values mean the algorithm is less strict.
1022
1023W3ImgPlug.thumb_size:Max thumbnail size. Both width and height.
1024
1025WordPlug.desc:A plugin for importing Microsoft Word documents.
1026
1027WordPlug.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.
1028
1029WordPlug.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
1030
1031XMLPlug.desc:Base class for XML plugins.
1032
1033XMLPlug.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.
1034ZIPPlug.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)
1035
1036#
1037# Download module option descriptions
1038#
1039
1040BasDownload.desc:Base class for Download modules
1041
1042OAIDownload.desc:A module for downloading from OAI repositories
1043OAIDownload.url_disp:Source URL
1044OAIDownload.url:OAI repository URL
1045OAIDownload.set_disp:Set
1046OAIDownload.set:Restrict the download to the specified set in the repository
1047OAIDownload.get_doc_disp:Get document
1048OAIDownload.get_doc:Download the source document if one is specified in the record
1049OAIDownload.max_records_disp:Max records
1050OAIDownload.max_records:Maximum number of records to download
1051
1052SRWDownload.desc:A module for downloading from SRW (Search/Retrieve Web Service) repositories
1053
1054WebDownload.desc:A module for downloading from the Internet via HTTP or FTP
1055WebDownload.url:Source URL
1056WebDownload.url_disp:Source URL
1057WebDownload.depth:How many hyperlinks deep to go when downloading
1058WebDownload.depth_disp:Download Depth
1059WebDownload.below:Only mirror files below this URL
1060WebDownload.below_disp:Only mirror files below this URL
1061WebDownload.within:Only mirror files within the same site
1062WebDownload.within_disp:Only mirror files within the same site
1063WebDownload.html_only:Download only HTML files, and ignore associated files e.g images and stylesheets
1064WebDownload.html_only_disp:Download only HTML files
1065
1066WgetDownload.desc: Base class that handles calls to wget
1067WgetDownload.proxy_on:Proxy on
1068WgetDownload.proxy_host:Proxy host
1069WgetDownload.proxy_port:Proxy port
1070WgetDownload.user_name:User name
1071WgetDownload.user_password:User password
1072
1073Z3950Download.desc:A module for downloading from Z3950 repositories
1074Z3950Download.host:Host URL
1075Z3950Download.host_disp:Host
1076Z3950Download.port:Port number of the repository
1077Z3950Download.port_disp:Port
1078Z3950Download.database:Database to search for records in
1079Z3950Download.database_disp:Database
1080Z3950Download.find:Retrieve records containing the specified search term
1081Z3950Download.find_disp:Find
1082Z3950Download.max_records:Maximum number of records to download
1083Z3950Download.max_records_disp:Max Records
1084
1085
1086#
1087#Plugout module option descriptions
1088#
1089
1090BasPlugout.desc:Base class for all the plugouts.
1091BasPlugout.bad_general_option:The %s plugout uses an incorrect option.
1092
1093#
1094# Perl module strings
1095#
1096
1097classify.could_not_find_classifier:ERROR: Could not find classifier \"%s\"
1098
1099download.could_not_find_download:ERROR: Could not find download module \"%s\"
1100
1101plugin.could_not_find_plugin:ERROR: Could not find plugin \"%s\"
1102
1103plugin.including_archive:including the contents of 1 ZIP/TAR archive
1104
1105plugin.including_archives:including the contents of %d ZIP/TAR archives
1106
1107plugin.kill_file:Process killed by .kill file
1108
1109plugin.n_considered:%d documents were considered for processing
1110
1111plugin.n_included:%d were processed and included in the collection
1112
1113plugin.n_rejected:%d were rejected
1114
1115plugin.n_unrecognised:%d were unrecognised
1116
1117plugin.no_plugin_could_process:WARNING: No plugin could process %s
1118
1119plugin.no_plugin_could_recognise:WARNING: No plugin could recognise %s
1120
1121plugin.no_plugin_could_process_this_file:no plugin could process this file
1122
1123plugin.no_plugin_could_recognise_this_file:no plugin could recognise this file
1124
1125plugin.one_considered:1 document was considered for processing
1126
1127plugin.one_included:1 was processed and included in the collection
1128
1129plugin.one_rejected:1 was rejected
1130
1131plugin.one_unrecognised:1 was unrecognised
1132
1133plugin.see_faillog:See %s for a list of unrecognised and/or rejected documents
1134
1135PrintUsage.default:Default
1136
1137PrintUsage.required:REQUIRED
1138
1139plugout.could_not_find_plugout:ERROR: Could not find plugout \"%s\"
Note: See TracBrowser for help on using the repository browser.