source: trunk/gsdl/perllib/strings.rb@ 8647

Last change on this file since 8647 was 8647, checked in by mdewsnip, 20 years ago

Added a "-newest_first" option to DateList for reverse chronological sorting.

  • Property svn:keywords set to Author Date Id Revision
File size: 43.8 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
42
43#
44# Script option descriptions and output messages
45#
46
47scripts.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.
48
49scripts.xml:Produces the information in an XML form, without 'pretty' comments but with much more detail.
50
51scripts.listall:Lists all known plugins instead of details about one given plugin.
52
53
54# -- buildcol.pl --
55
56buildcol.archivedir:Where the archives live.
57
58buildcol.builddir:Where to put the built indexes.
59
60buildcol.cachedir:Collection will be temporarily built here before being copied to the build directory.
61
62buildcol.cannot_open_cfg_file:WARNING: Can't open config file for updating: %s
63
64buildcol.collectdir:Collection directory.
65
66buildcol.copying_back_cached_build:Copying back the cached build
67
68buildcol.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.
69
70buildcol.debug:Print output to STDOUT.
71
72buildcol.desc:PERL script used to build a greenstone collection from GML documents.
73
74buildcol.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed.
75
76buildcol.index:Index to build (will build all in config file if not set).
77
78buildcol.keepold:Will not destroy the current contents of the building directory.
79
80buildcol.maxdocs:Maximum number of documents to build.
81
82buildcol.mode:The parts of the building process to carry out.
83buildcol.mode.all:Do everything.
84buildcol.mode.build_index:Just index the text.
85buildcol.mode.compress_text:Just compress the text.
86buildcol.mode.infodb:Just build the metadata database.
87
88buildcol.no_default_images:Default images will not be generated.
89
90buildcol.no_image_script:WARNING: Image making script could not be found: %s
91
92buildcol.no_strip_html:Do not strip the html tags from the indexed text (only used for mgpp collections).
93
94buildcol.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).
95
96buildcol.out:Filename or handle to print output status to.
97
98buildcol.params:[options] collection-name
99
100buildcol.remove_empty_classifications:Hide empty classifiers and classification nodes (those that contain no documents).
101
102buildcol.unlinked_col_images:Collection images may not be linked correctly.
103
104buildcol.unknown_mode:Unknown mode: %s
105
106buildcol.updating_archive_cache:Updating archive cache
107
108buildcol.verbosity:Controls the quantity of output. 0=none, 3=lots.
109
110
111# -- classinfo.pl --
112
113classinfo.collect: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.
114
115classinfo.desc:Prints information about a classifier.
116
117classinfo.general_options:General options are inherited from parent classes of the classifier.
118
119classinfo.info:info
120
121classinfo.no_classifier_name:ERROR: You must provide a classifier name.
122
123classinfo.option_types:Classifiers may take two types of options
124
125classinfo.params:[options] classifier-name
126
127classinfo.passing_options:Options may be passed to any classifier by including them in your collect.cfg configuration file.
128
129classinfo.specific_options:Specific options are defined within the classifier itself, and are available only to this particular classifier.
130
131# -- exportcol.pl --
132
133exportcol.out:Filename or handle to print output status to.
134exportcol.cdname:The name of the CD-ROM -- this is what will appear in the start menu once the CD-ROM is installed.
135exportcol.desc:PERL script used to export one or more collections to a Windows CD-ROM.
136exportcol.params:[options] collection-name1 collection-name2 ...
137exportcol.coll_not_found:Ignoring invalid collection %s: collection not found at %s.
138exportcol.coll_dirs_not_found:Ignoring invalid collection %s: one of the following directories not found:
139exportcol.fail:exportcol.pl failed:
140exportcol.no_valid_colls:No valid collections specified to export.
141exportcol.couldnt_create_dir:Could not create directory %s.
142exportcol.couldnt_create_file:Could not create %s.
143exportcol.instructions:To create a self-installing Windows CD-ROM, write the contents of this folder out to a CD-ROM.
144exportcol.non_exist_files:One or more of the following necessary files and directories does not exist:
145exportcol.success:exportcol.pl succeeded:
146exportcol.output_dir:The exported collections (%s) are in %s.
147exportcol.export_coll_not_installed:The Export to CD-ROM functionality has not been installed.
148
149# -- import.pl --
150
151import.archivedir:Where the converted material ends up.
152
153import.cannot_open_stats_file:WARNING: Couldn't open stats file %s.
154
155import.cannot_open_fail_log:ERROR: Couldn't open fail log %s
156
157import.cannot_sort:WARNING: import.pl cannot sort documents when groupsize > 1. sortmeta option will be ignored.
158
159import.collectdir:Collection directory.
160
161import.complete:Import complete
162
163import.debug:Print imported text to STDOUT.
164
165import.desc:PERL script used to import files into a GML format ready for building.
166
167import.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed.
168
169import.groupsize:Number of import documents to group into one XML file.
170
171import.gzip:Use gzip to compress resulting xml documents (don't forget to include ZIPPlug in your plugin list when building from compressed documents).
172
173import.importdir:Where the original material lives.
174
175import.keepold:Will not destroy the current contents of the archives directory (the default).
176
177import.maxdocs:Maximum number of documents to import.
178
179import.no_plugins_loaded:ERROR: No plugins loaded.
180
181import.OIDtype:The method to use when generating unique identifiers for each document.
182import.OIDtype.hash:Hashes the contents of the file. Document identifier will be the same every time the collection is imported.
183import.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.
184
185import.saveas:This is to decide the archives format to be generated. The default setting is to GA.
186
187import.saveas.GA:Will generate Greenstone Archive format.
188
189import.saveas.METS:Will generate METS format.
190
191import.out:Filename or handle to print output status to.
192
193import.params:[options] collection-name
194
195import.removeold:Will remove the old contents of the archives directory -- use with care.
196
197import.removing_archives:Removing current contents of the archives directory...
198
199import.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.
200
201import.statsfile:Filename or handle to print import statistics to.
202
203import.stats_backup:Will print stats to STDERR instead.
204
205import.verbosity:Controls the quantity of output. 0=none, 3=lots.
206
207
208# -- export.pl --
209
210export.exportdir:Where the export material ends up.
211
212export.cannot_open_stats_file:WARNING: Couldn't open stats file %s.
213
214export.cannot_open_fail_log:ERROR: Couldn't open fail log %s
215
216export.cannot_sort:WARNING: export.pl cannot sort documents when groupsize > 1. sortmeta option will be ignored.
217
218export.collectdir:Collection directory.
219
220export.complete:Export complete
221
222export.debug:Print exported text to STDOUT.
223
224export.desc:PERL script used to import files into a GML format ready for building.
225
226export.faillog:Fail log filename. This log receives the filenames of any files which fail to be processed.
227
228export.groupsize:Number of import documents to group into one XML file.
229
230export.gzip:Use gzip to compress resulting xml documents (don't forget to include ZIPPlug in your plugin list when building from compressed documents).
231
232export.importdir:Where the original material lives.
233
234export.keepold:Will not destroy the current contents of the export directory (the default).
235
236export.maxdocs:Maximum number of documents to import.
237
238export.no_plugins_loaded:ERROR: No plugins loaded.
239
240export.OIDtype:The method to use when generating unique identifiers for each document.
241export.OIDtype.hash:Hashes the contents of the file. Document identifier will be the same every time the collection is imported.
242export.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.
243
244export.saveas:This is to decide the export format to be generated. The default setting is to METS.
245
246export.saveas.DSpace:Will generate DSpace Archive format.
247
248export.saveas.METS:Will generate METS format.
249
250export.out:Filename or handle to print output status to.
251
252export.params:[options] collection-name
253
254export.removeold:Will remove the old contents of the export directory -- use with care.
255
256export.removing_export:Removing current contents of the export directory...
257
258export.sortmeta:Sort documents alphabetically by metadata for building. This will be disabled if groupsize > 1.
259
260export.statsfile:Filename or handle to print export statistics to.
261
262export.stats_backup:Will print stats to STDERR instead.
263
264export.verbosity:Controls the quantity of output. 0=none, 3=lots.
265
266
267# -- mkcol.pl --
268
269mkcol.about:The about text for the collection.
270
271mkcol.bad_name_cvs:ERROR: No collection can be named CVS as this may interfere with directories created by the CVS versioning system.
272
273mkcol.bad_name_modelcol:ERROR: No collection can be named modelcol as this is the name of the model collection.
274
275mkcol.cannot_find_modelcol:ERROR: Cannot find the model collection %s
276
277mkcol.col_already_exists:ERROR: This collection already exists.
278
279mkcol.collectdir:Directory where new collection will be created.
280
281mkcol.creating_col:Creating the collection %s
282
283mkcol.creator:The collection creator's e-mail address.
284
285mkcol.creator_undefined:ERROR: The creator was not defined. This variable is needed to recognise duplicate collection names.
286
287mkcol.desc:PERL script used to create the directory structure for a new Greenstone collection.
288
289mkcol.doing_replacements:doing replacements for %s
290
291mkcol.long_colname:ERROR: The collection name must be less than 8 characters so compatibility with earlier filesystems can be maintained.
292
293mkcol.maintainer:The collection maintainer's email address (if different from the creator).
294
295mkcol.no_collectdir:ERROR: The collect dir doesn't exist: %s
296
297mkcol.no_colname:ERROR: No collection name was specified.
298
299mkcol.optionfile:Get options from file, useful on systems where long command lines may cause problems.
300
301mkcol.params:[options] collection-name
302
303mkcol.plugin:Perl plugin module to use (there may be multiple plugin entries).
304
305mkcol.public:If this collection has anonymous access (true/false).
306
307mkcol.quiet:Operate quietly.
308
309mkcol.success:The new collection was created successfully at %s
310
311mkcol.title:The title of the collection.
312
313mkcol.win31compat:Whether or not the named collection directory must conform to Windows 3.1 file conventions or not (i.e. 8 characters long).
314
315# -- pluginfo.pl --
316
317pluginfo.collect: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.
318
319pluginfo.desc:Prints information about a plugin.
320
321pluginfo.general_options:General options are inherited from parent classes of the plugin.
322
323pluginfo.info:info
324
325pluginfo.no_plugin_name:ERROR: You must provide a plugin name.
326
327pluginfo.option_types:Plugins may take two types of options
328
329pluginfo.params:[options] plugin-name
330
331pluginfo.passing_options:Options may be passed to any plugin by including them in your collect.cfg configuration file.
332
333pluginfo.specific_options:Specific options are defined within the plugin itself, and are available only to this particular plugin.
334
335
336#
337# Classifier option descriptions
338#
339AutoHierarchy.desc:Classifier plugin for generating a hierarchical classification based on structured metadata, without the need for a supplementary file.
340
341AutoHierarchy.separator:Regular expression used for the separator
342
343AutoHierarchy.suppresslastlevel:Ignore the final part of the metadata value. This is useful for metadata where each value is unique, such as file paths.
344
345AZCompactList.allvalues:Use all metadata values found.
346
347AZCompactList.desc:Classifier plugin for sorting alphabetically
348
349AZCompactList.doclevel:Level to process document at.
350AZCompactList.doclevel.top:Whole document.
351AZCompactList.doclevel.section:By sections.
352
353AZCompactList.firstvalueonly:Use only the first metadata value found.
354
355AZCompactList.freqsort:Sort by node frequency rather than alpha-numeric.
356
357AZCompactList.maxcompact:Maximum number of documents to be displayed per page.
358
359AZCompactList.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.
360
361AZCompactList.mincompact:Minimum number of documents to be displayed per page.
362
363AZCompactList.mingroup:The smallest value that will cause a group in the hierarchy to form.
364
365AZCompactList.minnesting:The smallest value that will cause a list to be converted into a nested list.
366
367AZCompactList.recopt:Used in nested metadata such as -metadata Year/Organisation.
368AZCompactList.removeprefix:A prefix to ignore in the Metadata values for the field when sorting.
369AZCompactList.removesuffix:A suffix to ignore in the Metadata values for the field when sorting.
370
371AZCompactList.sort:Metadata field to sort the child nodes by.
372
373AZCompactSectionList.desc:Variation on AZCompactList that classifies sections rather than documents. Entries are sorted by section-level metadata.
374
375AZList.desc:Classifier plugin for sorting alphabetically
376
377AZList.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.
378
379AZList.removeprefix:A prefix to ignore in the Metadata values for the field when sorting.
380
381AZList.removesuffix:A suffix to ignore in the Metadata values for the field when sorting.
382
383AZSectionList.desc:Classifier plugin for sorting alphabetically. This is very similar to AZList except it sorts by section level metadata (excluding the top level) instead of just top level metadata. The only change is to the classify() subroutine which must now iterate through each section, adding each to the classification.
384
385BasClas.bad_general_option:The %s classifier uses an incorrect general option (general options are those available to all classifiers). Check your collect.cfg configuration file.
386
387BasClas.builddir:Where to put the built indexes.
388
389BasClas.buttonname:The label for the classifier screen and button in navigation bar.
390
391BasClas.desc:Base class for all the classifiers.
392
393BasClas.metadata.deft:Metadata element specified with -metadata.
394
395BasClas.outhandle:The file handle to write output to.
396
397BasClas.verbosity:Controls the quantity of output. 0=none, 3=lots.
398
399Browse.desc:.
400
401DateList.bymonth:Classify by year and month instead of only year.
402
403DateList.desc:Classifier plugin for sorting by date. By default, sorts by 'Date' metadata. Date is assumed to be in the form yyyymmdd.
404
405DateList.metadata:The metadata that contains the dates to classify by. The format is expected to be yyyymmdd.
406
407DateList.newest_first:Sort the documents in reverse chronological order (newest first).
408
409DateList.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).
410
411DateList.sort:An extra metadata field to sort by in the case where two documents have the same date.
412
413Hierarchy.desc:Classifier plugin for generating hierarchical classifications based on a supplementary structure file.
414
415Hierarchy.hfile:The classification structure file.
416
417Hierarchy.hlist_at_top:Display the first level of the classification horizontally.
418
419Hierarchy.metadata:Metadata field used for classification. List will be sorted by this element, unless -sort is used.
420
421Hierarchy.sort:Metadata field to sort by. Use '-sort nosort' for no sorting.
422
423HTML.desc:Creates an empty classification that's simply a link to a web page.
424
425HTML.url:The url of the web page to link to.
426
427List.desc:Simple list classifier plugin.
428
429List.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.
430
431List.sort:Metadata field to sort by. Use '-sort nosort' for no sorting.
432
433Phind.desc:The Phind clasifier plugin.
434
435Phind.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.
436
437Phind.min_occurs:The minimum number of times a phrase must appear in the text to be included in the phrase hierarchy.
438
439Phind.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.
440
441Phind.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.
442
443Phind.text:The text used to build the phrase hierarchy.
444
445Phind.thesaurus:Name of a thesaurus stored in Phind format in the collection's etc directory.
446
447Phind.title:The metadata field used to describe each document.
448
449Phind.untidy:Don't remove working files.
450
451SectionList.desc:Same as List classifier but includes all sections of document (excluding top level) rather than just top level document itself.
452
453Collage.desc:The Collage classifier plugin.
454
455Collage.geometry:The dimensions of the Collage canvas. For a canvas 600 pixels wide by 400 pixels high, for example, specify geometry as 600x400
456
457Collage.maxDepth:Images for collaging are drawn from mirroring the underlying browse classifier. This controls the maximum depth of the mirroring process.
458
459Collage.maxDisplay:The maximum number of images to show in the collage at any one time.
460
461Collage.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.
462
463Collage.bgcolor:The background color of the collage canvas, specified in hexadecimal form (for example #008000 results in a forest green background).
464
465Collage.refreshDelay:Rate, in milliseconds, that the collage canvas is refreshed.
466
467Collage.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.
468
469Collage.imageMustNotHave:Used to supress images that should not appear in the colage, such as image buttons that make up the navigation bar.
470
471Collage.caption:Optional captions to display below the collage canvas.
472
473#
474# Plugin option descriptions
475#
476
477ArcPlug.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.
478
479BasPlug.adding:adding
480
481BasPlug.already_seen:already seen
482
483BasPlug.bad_general_option:The %s plugin uses an incorrect general option (general options are those available to all plugins). Check your collect.cfg configuration file.
484
485BasPlug.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.
486
487BasPlug.could_not_extract_encoding:WARNING: encoding could not be extracted from %s - defaulting to %s
488
489BasPlug.could_not_extract_language:WARNING: language could not be extracted from %s - defaulting to %s
490
491BasPlug.could_not_open_for_reading:could not open %s for reading
492
493BasPlug.cover_image:Will look for a prefix.jpg file (where prefix is the same prefix as the file being processed) and associate it as a cover image.
494
495BasPlug.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.
496
497BasPlug.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.
498
499BasPlug.desc:Base class for all the import plugins.
500
501BasPlug.done_acronym_extract:done extracting acronyms.
502
503BasPlug.done_acronym_markup:done acronym markup.
504
505BasPlug.done_email_extract:done extracting e-mail addresses.
506
507BasPlug.dummy_text:This document has no text.
508
509BasPlug.empty_file:file contains no text
510
511BasPlug.extract_acronyms:Extract acronyms from within text and set as metadata.
512
513BasPlug.extract_email:Extract email addresses as metadata.
514
515BasPlug.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.
516
517BasPlug.extract_language:Identify the language of each document and set 'Language' metadata. Note that this will be done automatically if -input_encoding is 'auto'.
518
519BasPlug.extracting:extracting
520
521BasPlug.extracting_acronyms:extracting acronyms
522
523BasPlug.extracting_emails:extracting e-mail addresses
524
525BasPlug.file_has_no_text:ERROR: %s contains no text
526
527BasPlug.first:Comma separated list of first sizes to extract from the text into a metadata field. The field is called 'FirstNNN'.
528
529BasPlug.input_encoding:The encoding of the source documents. Documents will be converted from these encodings and stored internally as utf8.
530BasPlug.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.
531BasPlug.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.
532BasPlug.input_encoding.unicode:Just unicode.
533BasPlug.input_encoding.utf8:Either utf8 or unicode -- automatically detected.
534
535BasPlug.keyphrases:keyphrases
536
537BasPlug.marking_up_acronyms:marking up acronyms
538
539BasPlug.markup_acronyms:Add acronym metadata into document text.
540
541BasPlug.maximum_century:The maximum named century to be extracted as historical metadata (e.g. 14 will extract all references up to the 14th century).
542
543BasPlug.maximum_year:The maximum historical date to be used as metadata (in a Common Era date, such as 1950).
544
545BasPlug.no_bibliography:Do not try to block bibliographic dates when extracting historical dates.
546
547BasPlug.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).
548
549BasPlug.read_denied:Read permission denied for %s
550
551BasPlug.must_be_implemented:BasPlug::read function must be implemented in sub-class for recursive plugins
552
553BasPlug.stems:stems
554
555BasPlug.unsupported_encoding:WARNING: %s appears to be encoded in an unsupported encoding (%s) - using %s
556
557BasPlug.wrong_encoding:WARNING: %s was read using %s encoding but appears to be encoded as %s.
558
559BibTexPlug.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.
560
561BookPlug.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.
562
563ConvertToPlug.convert_to:Plugin converts to TEXT or HTML.
564ConvertToPlug.convert_to.html:HTML format.
565ConvertToPlug.convert_to.text:Plain text format.
566
567ConvertToPlug.desc:The plugin is inherited by such plugins as WordPlug and PDFPlug. It facilitates the conversion of these document types to either HTML or TEXT by setting up variable that instruct ConvertToBasPlug how to work. It works by dynamically inheriting HTMLPlug or TEXTPlug based on the plugin argument 'convert_to'. If the argument is not present, the default is to inherit HTMLPlug.
568
569ConvertToPlug.use_strings:If set, a simple strings function will be called to extract text if the conversion utility fails.
570
571ConvertToRogPlug.desc:A plugin that inherits from RogPlug.
572
573DBPlug.desc:Uses records from a database as documents.
574
575DBPlug.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.
576
577EMAILPlug.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)
578
579EMAILPlug.no_attachments:Do not save message attachments.
580
581EMAILPlug.headers:Store email headers as "Headers" metadata.
582
583EMAILPlug.split_exp:A perl regular expression used to split files containing many messages into individual documents.
584
585ExcelPlug.desc:A plugin for importing Microsoft Excel files.
586
587FOXPlug.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.
588
589GAPlug.desc:Processes GreenstoneArchive XML documents. Note that this plugin does no syntax checking (though the XML::Parser module tests for well-formedness). It's assumed that the GreenstoneArchive files conform to their DTD.
590
591GMLPlug.desc:Plugin which processes a GML format document assumes that gml tags are all in lower-case.
592
593HBPlug.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
594
595HTMLPlug.assoc_files:Perl regular expression of file extensions to associate with html documents.
596
597HTMLPlug.desc:This plugin processes HTML files
598
599HTMLPlug.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.
600
601HTMLPlug.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.
602
603HTMLPlug.hunt_creator_metadata:Find as much metadata as possible on authorship and place it in the 'Creator' field. Requires the -metadata_fields flag.
604
605HTMLPlug.keep_head:Don't remove headers from html files.
606
607HTMLPlug.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.
608
609HTMLPlug.no_metadata:Don't attempt to extract any metadata from files.
610
611HTMLPlug.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).
612
613HTMLPlug.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).
614
615HTMLPlug.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.
616
617ImagePlug.converttotype:Convert main image to format 's'.
618
619ImagePlug.desc:This plugin processes images, adding basic metadata
620
621ImagePlug.minimumsize:Ignore images smaller than n bytes.
622
623ImagePlug.noscaleup:Don't scale up small images when making thumbnails.
624
625ImagePlug.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.
626
627ImagePlug.screenviewtype:If -screenviewsize is set, this sets the screen display image type.
628
629ImagePlug.thumbnailsize:Make thumbnails of size nxn.
630
631ImagePlug.thumbnailtype:Make thumbnails in format 's'.
632
633IndexPlug.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'.
634
635ISISPlug.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).
636
637ISISPlug.subfield_separator:The string used to separate subfields in CDS/ISIS database records.
638
639ISISPlug.entry_separator:The string used to separate multiple values for single metadata fields in CDS/ISIS database records.
640
641ISISPlug.explode_databases:Explode databases processed by this plugin into individual records with editable metadata. This is an irreversible process and the original database files will be deleted.
642
643ISISPlug.document_field:The metadata element specifying the file name of documents to obtain and include in the collection.
644
645ISISPlug.document_prefix:A prefix for the document locations (for use with the document_field option).
646
647ISISPlug.document_suffix:A suffix for the document locations (for use with the document_field option).
648
649LaTeXPlug.desc:Plugin for LaTeX documents.
650
651MACROPlug.desc:Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).
652
653MARCPlug.desc:Basic MARC plugin.
654
655MARCPlug.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.
656
657OAIPlug.desc:Basic Open Archives Initiate (OAI) plugin.
658
659OggVorbisPlug.add_technical_metadata:Add technical (eg. bitrate) metadata.
660
661OggVorbisPlug.desc:A plugin for importing Ogg Vorbis audio files.
662
663PagedImgPlug.desc:Plugin for documents made up of a sequence of images, with optional OCR text for each image.
664
665PagedImgPlug.documenttype:Set the document type (used for display)
666PagedImgPlug.documenttype.paged:Paged documents have next and previous arrows and a 'go to page X' box
667PagedImgPlug.documenttype.hierarchy:Hierarchical documents have a table of contents
668
669PagedImgPlug.headerpage:Add a top level header page (that contains no image) to each document.
670
671PagedImgPlug.screenview:Produce a screenview image for each image, and set Screen, ScreenSize, ScreenWidth and ScreenHeight metadata.
672
673PagedImgPlug.screenviewsize:Make screenview images of size nxn.
674
675PagedImgPlug.screenviewtype:Make screenview images in format 's'.
676
677PagedImgPlug.thumbnail:Produce a thumbnail for each image
678
679PDFPlug.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).
680
681PDFPlug.desc:Reasonably with-it pdf plugin.
682
683PDFPlug.nohidden:Prevent pdftohtml from attempting to extract hidden text. This is only useful if the -complex option is also set.
684
685PDFPlug.noimages:Don't attempt to extract images from PDF.
686
687PDFPlug.use_sections:Create a separate section for each page of the PDF file.
688
689PDFPlug.zoom:The factor by which to zoom the PDF for output (this is only useful if -complex is set).
690
691PPTPlug.desc:A plugin for importing Microsoft PowerPoint files.
692
693PSPlug.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
694
695PSPlug.extract_date:Extract date from PS header.
696
697PSPlug.extract_pages:Extract pages from PS header.
698
699PSPlug.extract_title:Extract title from PS header.
700
701RecPlug.desc:RecPlug is a plugin which recurses through directories processing each file it finds.
702
703RecPlug.recheck_directories:After the files in an import directory have been processed, re-read the directory to discover any new files created.
704
705RecPlug.use_metadata_files:Read metadata from metadata XML files.
706
707ReferPlug.desc:ReferPlug reads bibliography files in Refer format.
708
709ReferPlug.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
710
711RogPlug.desc:Creates simple single-level documents from .rog or .mdb files.
712
713RTFPlug.desc:Plugin for importing Rich Text Format files.
714
715SRCPlug.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)
716
717SRCPlug.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.
718
719SplitPlug.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.
720
721SplitPlug.split_exp:A perl regular expression to split input files into segments.
722
723TEXTPlug.desc:Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).
724
725TEXTPlug.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.
726
727UnknownPlug.assoc_field:Name of the metadata field that will hold the associated file's name.
728
729UnknownPlug.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.
730
731UnknownPlug.file_type:Type of the file (e.g. MPEG, MIDI, ...)
732
733UnknownPlug.mime_type:Mime type of the file (e.g. image/gif).
734
735MP3Plug.desc:Plugin for processing MP3 files.
736
737MP3Plug.assoc_images:Use google image search to locate images related to MP3 file based on ID3 Title and Artist metadata.
738
739MP3Plug.assoc_images:Used to store [applet] metadata for each document that contains the necessary HTML for an MP3 audio player applet to play that file.
740
741MP3Plug.metadata_fields:Comma separated list of metadata fields to extract (assuming present) in an MP3 file. Use \"*\" to extract all the fields.
742
743W3ImgPlug.aggressiveness:Range of related text extraction techniques to use.
744W3ImgPlug.aggressiveness.1:Filename, path, ALT text only.
745W3ImgPlug.aggressiveness.2:All of 1, plus caption where available.
746W3ImgPlug.aggressiveness.3:All of 2, plus near paragraphs where available.
747W3ImgPlug.aggressiveness.4:All of 3, plus previous headers (<h1>, <h2>...) where available.
748W3ImgPlug.aggressiveness.5:All of 4, plus textual references where available.
749W3ImgPlug.aggressiveness.6:All of 4, plus page metatags (title, keywords, etc).
750W3ImgPlug.aggressiveness.7:All of 6, 5 and 4 combined.
751W3ImgPlug.aggressiveness.8:All of 7, plus repeat caption, filename, etc (raise ranking of more relevant results).
752W3ImgPlug.aggressiveness.9:All of 1, plus full text of source page.
753
754W3ImgPlug.caption_length:Maximum length of captions (in characters).
755
756W3ImgPlug.convert_params:Additional parameters for ImageMagicK convert on thumbnail creation. For example, '-raise' will give a three dimensional effect to thumbnail images.
757
758W3ImgPlug.desc:A plugin for extracting images and associated text from webpages.
759
760W3ImgPlug.document_text:Add image text as document:text (otherwise IndexedText metadata field).
761
762W3ImgPlug.index_pages:Index the pages along with the images. Otherwise reference the pages at the source URL.
763
764W3ImgPlug.max_near_text:Maximum characters near images to extract.
765
766W3ImgPlug.min_height:Pixels. Skip images shorter than this.
767
768W3ImgPlug.min_near_text:Minimum characters of near text or caption to extract.
769
770W3ImgPlug.min_size:Bytes. Skip images smaller than this.
771
772W3ImgPlug.min_width:Pixels. Skip images narrower than this.
773
774W3ImgPlug.neartext_length:Target length of near text (in characters).
775
776W3ImgPlug.no_cache_images:Don't cache images (point to URL of original).
777
778W3ImgPlug.smallpage_threshold:Images on pages smaller than this (bytes) will have the page (title, keywords, etc) meta-data added.
779
780W3ImgPlug.textrefs_threshold:Threshold for textual references. Lower values mean the algorithm is less strict.
781
782W3ImgPlug.thumb_size:Max thumbnail size. Both width and height.
783
784WordPlug.desc:A plugin for importing Microsoft Word documents.
785
786XMLPlug.desc:Base class for XML plugins.
787
788ZIPPlug.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)
789
790
791#
792# Perl module strings
793#
794
795classify.could_not_find_classifier:ERROR: Could not find classifier \"%s\"
796
797plugin.could_not_find_plugin:ERROR: Could not find plugin \"%s\"
798
799plugin.including_archive:including the contents of 1 ZIP/TAR archive
800
801plugin.including_archives:including the contents of %d ZIP/TAR archives
802
803plugin.kill_file:Process killed by .kill file
804
805plugin.n_considered:%d documents were considered for processing
806
807plugin.n_included:%d were processed and included in the collection
808
809plugin.n_rejected:%d were rejected
810
811plugin.n_unrecognised:%d were unrecognised
812
813plugin.no_plugin_could_process:WARNING: No plugin could process %s
814
815plugin.no_plugin_could_recognise:WARNING: No plugin could recognise %s
816
817plugin.no_plugin_could_process_this_file:no plugin could process this file
818
819plugin.no_plugin_could_recognise_this_file:no plugin could recognise this file
820
821plugin.one_considered:1 document was considered for processing
822
823plugin.one_included:1 was processed and included in the collection
824
825plugin.one_rejected:1 was rejected
826
827plugin.one_unrecognised:1 was unrecognised
828
829plugin.see_faillog:See %s for a list of unrecognised and/or rejected documents
830
831PrintUsage.default:Default
832
833PrintUsage.required:REQUIRED
Note: See TracBrowser for help on using the repository browser.