Changeset 5607

Timestamp:

2003-10-09T18:01:59+13:00 (21 years ago)

Author:

mdewsnip

Message:

Now contains all the plugin and classifier descriptions, and all the strings in plugin.pm, classify.pm, mkcol.pl, import.pl, buildcol.pl, pluginfo.pl, classinfo.pl.

File:

• trunk/gsdl/perllib/strings.rb (modified) (21 diffs)

trunk/gsdl/perllib/strings.rb

@@ -17 +17 @@
 common.cannot_read_file:ERROR: Can't read file
 
+common.general_options:general options (for %s)
+
+common.must_be_implemented:function must be implemented in sub-class
+
 common.options:options
 
+common.specific_options:specific options
+
 common.usage:usage
 
+
 #
 # Script option descriptions and output messages
 #
+
+scripts.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.
+
+scripts.xml:Produces the information in an XML form, without 'pretty' comments but with much more detail.
+
 
 # -- buildcol.pl --
@@ -82 +94 @@
 
 
+# -- classinfo.pl --
+
+classinfo.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.
+
+classinfo.desc:Prints information about a classifier.
+
+classinfo.general_options:General options are inherited from parent classes of the classifier.
+
+classinfo.info:info
+
+classinfo.no_classifier_name:ERROR: You must provide a classifier name.
+
+classinfo.option_types:Classifiers may take two types of options
+
+classinfo.params:[options] classifier-name
+
+classinfo.passing_options:Options may be passed to any classifier by including them in your collect.cfg configuration file.
+
+classinfo.specific_options:Specific options are defined within the classifier itself, and are available only to this particular classifier.
+
+
 # -- import.pl --
 
@@ -179 +212 @@
 mkcol.title:The title of the collection.
 
-scripts.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.
+
+# -- pluginfo.pl --
+
+pluginfo.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.
+
+pluginfo.desc:Prints information about a plugin.
+
+pluginfo.general_options:General options are inherited from parent classes of the plugin.
+
+pluginfo.info:info
+
+pluginfo.no_plugin_name:ERROR: You must provide a plugin name.
+
+pluginfo.option_types:Plugins may take two types of options
+
+pluginfo.params:[options] plugin-name
+
+pluginfo.passing_options:Options may be passed to any plugin by including them in your collect.cfg configuration file.
+
+pluginfo.specific_options:Specific options are defined within the plugin itself, and are available only to this particular plugin.
 
 
@@ -187 +239 @@
 
 AZCompactList.buttonname:Button name for this classification.
+
+AZCompactList.desc:Classifier plugin for sorting alphabetically
 
 AZCompactList.doclevel:Level to process document at.
@@ -206 +260 @@
 AZCompactList.onlyfirst:Control whether all or only first metadata value used from array of metadata.
 
-AZCompactList.removeprefix:A prefix to ignore in the Metadata values for the field when sorting.
-
 AZList.buttonname:Button name for this classification.
 
+AZList.desc:Classifier plugin for sorting alphabetically
+
 AZList.metadata:Metadata field used for classification. List will be sorted by this element.
 
 AZList.removeprefix:A prefix to ignore in the Metadata values for the field when sorting.
 
+AZList.removesuffix:A suffix to ignore in the Metadata values for the field when sorting.
+
+AZSectionList.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.
+
+BasClas.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.
+
 BasClas.builddir:Where to put the built indexes.
 
+BasClas.desc:Base class for all the classifiers.
+
 BasClas.outhandle:The file handle to write output to.
 
@@ -224 +286 @@
 DateList.datemeta:The metadata that contains the dates to classify by. The format is expected to be yyyymmdd.
 
+DateList.desc:Classifier plugin for sorting by date. By default, sorts by 'Date' metadata. Date is assumed to be in the form yyyymmdd.
+
 DateList.nogroupyears:Make each year an individual entry in the horizontal list. (ie, don't have 1920-1922 type classification nodes).
 
 DateList.sortmeta:An extra metadata field to sort by in the case where two documents have the same date.
 
-
 Hierarchy.buttonname:Title field for this classification.
 
+Hierarchy.desc:Classifier plugin for generating hierarchical classifications.
+
 Hierarchy.hfile:The classification structure file.
 
@@ -241 +306 @@
 HTML.buttonname:The title field for this classification.
 
+HTML.desc:Creates an empty classification that's simply a link to a web page.
+
 HTML.url:The url of the web page to link to.
 
 List.buttonname:Button name for this classification.
 
+List.desc:Simple list classifier plugin.
+
 List.metadata:Metadata field used for classification. List will be sorted by this element.
 
@@ -251 +320 @@
 Phind.button:The label for the classifier screen and button in navigation bar.
 
+Phind.desc:The Phind clasifier plugin.
+
 Phind.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.
 
@@ -265 +336 @@
 Phind.untidy:Don't remove working files.
 
+SectionList.desc:Same as List classifier but includes all sections of document (excluding top level) rather than just top level document itself.
+
 
 #
@@ -270 +343 @@
 #
 
+ArcPlug.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.
+
+ArcPlug.processing:processing
+
+BasPlug.adding:adding
+
+BasPlug.already_seen:already seen
+
+BasPlug.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.
+
 BasPlug.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.
 
+BasPlug.could_not_extract_encoding:WARNING: encoding could not be extracted from %s - defaulting to %s
+
+BasPlug.could_not_extract_language:WARNING: language could not be extracted from %s - defaulting to %s
+
+BasPlug.could_not_open_for_reading:could not open %s for reading
+
 BasPlug.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.
 
@@ -278 +367 @@
 BasPlug.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.
 
+BasPlug.desc:Base class for all the import plugins.
+
+BasPlug.done_acronym_extract:done extracting acronyms.
+
+BasPlug.done_acronym_markup:done acronym markup.
+
+BasPlug.done_email_extract:done extracting e-mail addresses.
+
+BasPlug.empty_file:file contains no text
+
 BasPlug.extract_acronyms:Extract acronyms from within text and set as metadata.
 
@@ -285 +384 @@
 
 BasPlug.extract_language:Identify the language of each document and set 'Language' metadata. Note that this will be done automatically if -input_encoding is 'auto'.
+
+BasPlug.extracting:extracting
+
+BasPlug.extracting_acronyms:extracting acronyms
+
+BasPlug.extracting_emails:extracting e-mail addresses
+
+BasPlug.file_has_no_text:ERROR: %s contains no text
 
 BasPlug.first:Comma separated list of first sizes to extract from the text into a metadata field. The field is called 'FirstNNN'.
@@ -294 +401 @@
 BasPlug.input_encoding.utf8:Either utf8 or unicode -- automatically detected.
 
+BasPlug.keyphrases:keyphrases
+
+BasPlug.marking_up_acronyms:marking up acronyms
+
 BasPlug.markup_acronyms:Add acronym metadata into document text.
 
@@ -303 +414 @@
 
 BasPlug.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).
+
+BasPlug.read_denied:Read permission denied for %s
+
+BasPlug.must_be_implemented:BasPlug::read function must be implemented in sub-class for recursive plugins
+
+BasPlug.stems:stems
+
+BasPlug.unsupported_encoding:WARNING: %s appears to be encoded in an unsupported encoding (%s) - using %s
+
+BasPlug.wrong_encoding:WARNING: %s was read using %s encoding but appears to be encoded as %s.
+
+BibTexPlug.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.
+
+BookPlug.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.
 
 ConvertToPlug.convert_to:Plugin converts to TEXT or HTML.
@@ -308 +433 @@
 ConvertToPlug.convert_to.text:Plain text format.
 
+ConvertToPlug.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.
+
 ConvertToPlug.use_strings:If set, a simple strings function will be called to extract text if the conversion utility fails.
 
+ConvertToRogPlug:A plugin that inherits from RogPlug.
+
+DBPlug.desc:Uses records from a database as documents.
+
 DBPlug.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.
 
+EMAILPlug.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\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)
+
 EMAILPlug.no_attachments:Do not save message attachments.
 
 EMAILPlug.split_exp:A perl regular expression used to split files containing many messages into individual documents.
 
+ExcelPlug.desc:A plugin for importing Microsoft Excel files.
+
+FOXPlug.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.
+
+GAPlug.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.
+
+GMLPlug.desc:Plugin which processes a GML format document assumes that gml tags are all in lower-case.
+
+HBPlug.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
+
 HTMLPlug.assoc_files:Perl regular expression of file extensions to associate with html documents.
 
+HTMLPlug.desc:This plugin processes HTML files
+
 HTMLPlug.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.
 
@@ -338 +483 @@
 ImagePlug.converttotype:Convert main image to.
 
+ImagePlug.desc:This plugin processes images, adding basic metadata
+
 ImagePlug.minimumsize:Ignore images smaller than n bytes.
 
@@ -350 +497 @@
 ImagePlug.thumbnailtype:Make thumbnails in format 's'.
 
+IndexPlug.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. &gt;Subject&lt;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'.
+
+MACROPlug.desc:Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).
+
+MARCPlug.desc:Basic MARC plugin.
+
 MARCPlug.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.
 
+OAIPlug.desc:Basic Open Archives Initiate (OAI) plugin.
+
 PDFPlug.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).
 
+PDFPlug.desc:Reasonably with-it pdf plugin.
+
 PDFPlug.nohidden:Prevent pdftohtml from attempting to extract hidden text. This is only useful if the -complex option is also set.
 
@@ -362 +519 @@
 PDFPlug.zoom:The factor by which to zoom the PDF for output (this is only useful if -complex is set).
 
+PPTPlug.desc:A plugin for importing Microsoft PowerPoint files.
+
+PSPlug.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
+
 PSPlug.extract_date:Extract date from PS header.
 
@@ -368 +529 @@
 PSPlug.extract_title:Extract title from PS header.
 
+RecPlug.desc:RecPlug is a plugin which recurses through directories processing each file it finds.
+
 RecPlug.use_metadata_files:Read metadata from metadata XML files.
 
+ReferPlug.desc: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
+
+RogPlug.desc:Creates simple single-level documents from .rog or .mdb files.
+
+RTFPlug.desc:Plugin for importing Rich Text Format files.
+
+SRCPlug.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)
+
 SRCPlug.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.
 
+SplitPlug.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.
+
 SplitPlug.split_exp:A perl regular expression to split input files into segments.
 
+TEXTPlug.desc:Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).
+
 TEXTPlug.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.
 
 UnknownPlug.assoc_field:Name of the metadata field that will hold the associated file's name.
+
+UnknownPlug.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.
 
 UnknownPlug.file_type:Mime type of the file (e.g. image/gif).
@@ -395 +572 @@
 W3ImgPlug.convert_params:Additional parameters for ImageMagicK convert on thumbnail creation. For example, '-raise' will give a three dimensional effect to thumbnail images.
 
+W3ImgPlug.desc:A plugin for extracting images and associated text from webpages.
+
 W3ImgPlug.document_text:Add image text as document:text (otherwise IndexedText metadata field).
 
@@ -418 +597 @@
 
 W3ImgPlug.thumb_size:Max thumbnail size. Both width and height.
+
+WordPlug.desc:A plugin for importing Microsoft Word documents.
+
+XMLPlug.desc:Base class for XML plugins.
+
+ZIPPlug.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)
+
+
+#
+# Perl module strings
+#
+
+classify.could_not_find_classifier:ERROR: Could not find classifier \"%s\"
+
+plugin.could_not_find_plugin:ERROR: Could not find plugin \"%s\"
+
+plugin.including_archive:including the contents of 1 ZIP/TAR archive
+
+plugin.including_archives:including the contents of %d ZIP/TAR archives
+
+plugin.kill_file:Process killed by .kill file
+
+plugin.n_considered:%d documents were considered for processing
+
+plugin.n_included:%d were processed and included in the collection
+
+plugin.n_rejected:%d were rejected
+
+plugin.no_plugin_could_process:WARNING: No plugin could process %s
+
+plugin.no_plugin_could_process_this_file:no plugin could process this file
+
+plugin.one_considered:1 document was considered for processing
+
+plugin.one_included:1 was processed and included in the collection
+
+plugin.one_rejected:1 was rejected
+
+plugin.see_faillog:See %s for a list of rejected documents
+
+PrintUsage.default:Default
+
+PrintUsage.required:REQUIRED