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

Last change on this file since 12743 was 12743, checked in by kjdon, 18 years ago

updated the descriptions of classifiers

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