Ignore:
Timestamp:
2008-06-12T13:43:33+12:00 (16 years ago)
Author:
kjdon
Message:

first pass at changing all the plugin names

File:
1 edited

Legend:

Unmodified
Added
Removed
  • gsdl/trunk/perllib/strings.properties

    r15118 r15968  
    652652#
    653653
    654 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.
    655 
    656 BasPlug.adding:adding
    657 
    658 BasPlug.already_seen:already seen
    659 
    660 BasPlug.bad_general_option:The %s plugin uses an incorrect option. Check your collect.cfg configuration file.
    661 
    662 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.
    663 
    664 BasPlug.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.
    665 
    666 BasPlug.could_not_extract_encoding:WARNING: encoding could not be extracted from %s - defaulting to %s
    667 
    668 BasPlug.could_not_extract_language:WARNING: language could not be extracted from %s - defaulting to %s
    669 
    670 BasPlug.could_not_open_for_reading:could not open %s for reading
    671 
    672 BasPlug.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.
    673 
    674 BasPlug.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.
    675 
    676 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.
    677 
    678 BasPlug.desc:Base class for all the import plugins.
    679 
    680 BasPlug.done_acronym_extract:done extracting acronyms.
    681 
    682 BasPlug.done_acronym_markup:done acronym markup.
    683 
    684 BasPlug.done_email_extract:done extracting e-mail addresses.
    685 
    686 BasPlug.dummy_text:This document has no text.
    687 
    688 BasPlug.empty_file:file contains no text
    689 
    690 BasPlug.extract_acronyms:Extract acronyms from within text and set as metadata.
    691 
    692 BasPlug.extract_email:Extract email addresses as metadata.
    693 
    694 BasPlug.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.
    695 
    696 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'.
    697 
    698 BasPlug.extracting:extracting
    699 
    700 BasPlug.extracting_acronyms:extracting acronyms
    701 
    702 BasPlug.extract_keyphrases:Extract keyphrases automatically with Kea (default settings).
    703 
    704 BasPlug.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.
    705 
    706 BasPlug.extract_keyphrase_options:Options for keyphrase extraction with Kea. For example: mALIWEB - use ALIWEB extraction model; n5 - extract 5 keyphrase;, eGBK - use GBK encoding.
    707 
    708 BasPlug.extracting_emails:extracting e-mail addresses
    709 
    710 BasPlug.file_has_no_text:ERROR: %s contains no text
    711 
    712 BasPlug.first:Comma separated list of first sizes to extract from the text into a metadata field. The field is called 'FirstNNN'.
    713 
    714 BasPlug.input_encoding:The encoding of the source documents. Documents will be converted from these encodings and stored internally as utf8.
    715 BasPlug.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.
    716 BasPlug.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.
    717 
    718 BasPlug.input_encoding.unicode:Just unicode.
    719 
    720 BasPlug.input_encoding.utf8:Either utf8 or unicode -- automatically detected.
    721 
    722 BasPlug.keyphrases:keyphrases
    723 
    724 BasPlug.marking_up_acronyms:marking up acronyms
    725 
    726 BasPlug.markup_acronyms:Add acronym metadata into document text.
    727 
    728 BasPlug.maximum_century:The maximum named century to be extracted as historical metadata (e.g. 14 will extract all references up to the 14th century).
    729 
    730 BasPlug.maximum_year:The maximum historical date to be used as metadata (in a Common Era date, such as 1950).
    731 
    732 BasPlug.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.
    733 
    734 BasPlug.must_be_implemented:BasPlug::read function must be implemented in sub-class for recursive plugins
    735 
    736 BasPlug.no_bibliography:Do not try to block bibliographic dates when extracting historical dates.
    737 
    738 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).
    739 
    740 BasPlug.read_denied:Read permission denied for %s
    741 
    742 BasPlug.separate_cjk:Insert spaces between Chinese/Japanese/Korean characters to make each character a word. Use if text is not segmented.
    743 
    744 BasPlug.smart_block:Block files in a smarter way than just looking at filenames.
    745 
    746 BasPlug.stems:stems
    747 
    748 BasPlug.unsupported_encoding:WARNING: %s appears to be encoded in an unsupported encoding (%s) - using %s
    749 
    750 BasPlug.wrong_encoding:WARNING: %s was read using %s encoding but appears to be encoded as %s.
    751 
    752 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.
    753 
    754 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.
    755 
    756 ConvertToPlug.apply_fribidi:Run the "fribidi" Unicode Bidirectional Algorithm program over the converted file (for right-to-left text).
    757 ConvertToPlug.convert_to:Plugin converts to TEXT or HTML or various types of Image (e.g. JPEG, GIF, PNG).
    758 ConvertToPlug.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.
    759 ConvertToPlug.convert_to.html:HTML format.
    760 ConvertToPlug.convert_to.text:Plain text format.
    761 ConvertToPlug.convert_to.pagedimg_jpg:JPEG format.
    762 ConvertToPlug.convert_to.pagedimg_gif:GIF format.
    763 ConvertToPlug.convert_to.pagedimg_png:PNG format.
    764 
    765 ConvertToPlug.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'.
    766 ConvertToPlug.keep_original_filename:Keep the original filename for the associated file, rather than converting to doc.pdf, doc.doc etc.
    767 ConvertToPlug.use_strings:If set, a simple strings function will be called to extract text if the conversion utility fails.
    768 
    769 ConvertToRogPlug.desc:A plugin that inherits from RogPlug.
    770 
    771 CSVPlug.desc:A plugin for files in comma-separated value format. A new document will be created for each line of the file.
    772 
    773 DBPlug.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.
    774 
    775 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.
    776 
    777 DSpacePlug.desc:DSpacePlug takes a collection of documents exported from DSpace and imports them into Greenstone.
     654ArchivesInfPlugin.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.
     655
     656BasePlugin.adding:adding
     657
     658BasePlugin.already_seen:already seen
     659
     660BasePlugin.bad_general_option:The %s plugin uses an incorrect option. Check your collect.cfg configuration file.
     661
     662BasePlugin.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.
     663
     664BasePlugin.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.
     665
     666BasePlugin.could_not_extract_encoding:WARNING: encoding could not be extracted from %s - defaulting to %s
     667
     668BasePlugin.could_not_extract_language:WARNING: language could not be extracted from %s - defaulting to %s
     669
     670BasePlugin.could_not_open_for_reading:could not open %s for reading
     671
     672BasePlugin.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.
     673
     674BasePlugin.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.
     675
     676BasePlugin.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.
     677
     678BasePlugin.desc:Base class for all the import plugins.
     679
     680BasePlugin.done_acronym_extract:done extracting acronyms.
     681
     682BasePlugin.done_acronym_markup:done acronym markup.
     683
     684BasePlugin.done_email_extract:done extracting e-mail addresses.
     685
     686BasePlugin.dummy_text:This document has no text.
     687
     688BasePlugin.empty_file:file contains no text
     689
     690BasePlugin.extract_acronyms:Extract acronyms from within text and set as metadata.
     691
     692BasePlugin.extract_email:Extract email addresses as metadata.
     693
     694BasePlugin.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.
     695
     696BasePlugin.extract_language:Identify the language of each document and set 'Language' metadata. Note that this will be done automatically if -input_encoding is 'auto'.
     697
     698BasePlugin.extracting:extracting
     699
     700BasePlugin.extracting_acronyms:extracting acronyms
     701
     702BasePlugin.extract_keyphrases:Extract keyphrases automatically with Kea (default settings).
     703
     704BasePlugin.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.
     705
     706BasePlugin.extract_keyphrase_options:Options for keyphrase extraction with Kea. For example: mALIWEB - use ALIWEB extraction model; n5 - extract 5 keyphrase;, eGBK - use GBK encoding.
     707
     708BasePlugin.extracting_emails:extracting e-mail addresses
     709
     710BasePlugin.file_has_no_text:ERROR: %s contains no text
     711
     712BasePlugin.first:Comma separated list of first sizes to extract from the text into a metadata field. The field is called 'FirstNNN'.
     713
     714BasePlugin.input_encoding:The encoding of the source documents. Documents will be converted from these encodings and stored internally as utf8.
     715BasePlugin.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.
     716BasePlugin.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.
     717
     718BasePlugin.input_encoding.unicode:Just unicode.
     719
     720BasePlugin.input_encoding.utf8:Either utf8 or unicode -- automatically detected.
     721
     722BasePlugin.keyphrases:keyphrases
     723
     724BasePlugin.marking_up_acronyms:marking up acronyms
     725
     726BasePlugin.markup_acronyms:Add acronym metadata into document text.
     727
     728BasePlugin.maximum_century:The maximum named century to be extracted as historical metadata (e.g. 14 will extract all references up to the 14th century).
     729
     730BasePlugin.maximum_year:The maximum historical date to be used as metadata (in a Common Era date, such as 1950).
     731
     732BasePlugin.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.
     733
     734BasePlugin.must_be_implemented:BasPlug::read function must be implemented in sub-class for recursive plugins
     735
     736BasePlugin.no_bibliography:Do not try to block bibliographic dates when extracting historical dates.
     737
     738BasePlugin.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).
     739
     740BasePlugin.read_denied:Read permission denied for %s
     741
     742BasePlugin.separate_cjk:Insert spaces between Chinese/Japanese/Korean characters to make each character a word. Use if text is not segmented.
     743
     744BasePlugin.smart_block:Block files in a smarter way than just looking at filenames.
     745
     746BasePlugin.stems:stems
     747
     748BasePlugin.unsupported_encoding:WARNING: %s appears to be encoded in an unsupported encoding (%s) - using %s
     749
     750BasePlugin.wrong_encoding:WARNING: %s was read using %s encoding but appears to be encoded as %s.
     751
     752BibTexPlugin.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.
     753
     754BookPlugin.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.
     755
     756ConvertBinaryFile.apply_fribidi:Run the "fribidi" Unicode Bidirectional Algorithm program over the converted file (for right-to-left text).
     757ConvertBinaryFile.convert_to:Plugin converts to TEXT or HTML or various types of Image (e.g. JPEG, GIF, PNG).
     758ConvertBinaryFile.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.
     759ConvertBinaryFile.convert_to.html:HTML format.
     760ConvertBinaryFile.convert_to.text:Plain text format.
     761ConvertBinaryFile.convert_to.pagedimg_jpg:JPEG format.
     762ConvertBinaryFile.convert_to.pagedimg_gif:GIF format.
     763ConvertBinaryFile.convert_to.pagedimg_png:PNG format.
     764
     765ConvertToPlugin.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'.
     766ConvertBinaryFile.keep_original_filename:Keep the original filename for the associated file, rather than converting to doc.pdf, doc.doc etc.
     767ConvertBinaryFile.use_strings:If set, a simple strings function will be called to extract text if the conversion utility fails.
     768
     769ConvertToRogPlugin.desc:A plugin that inherits from RogPlug.
     770
     771CSVPlugin.desc:A plugin for files in comma-separated value format. A new document will be created for each line of the file.
     772
     773DBPlugin.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.
     774
     775DBPlugin.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.
     776
     777DSpacePlugin.desc:DSpacePlug takes a collection of documents exported from DSpace and imports them into Greenstone.
    778778   
    779 DSpacePlug.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.
    780 DSpacePlug.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.
    781 DSpacePlug.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.
    782 
    783 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 (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)
    784 
    785 EMAILPlug.no_attachments:Do not save message attachments.
    786 
    787 EMAILPlug.headers:Store email headers as "Headers" metadata.
    788 
    789 EMAILPlug.split_exp:A perl regular expression used to split files containing many messages into individual documents.
    790 
    791 ExcelPlug.desc:A plugin for importing Microsoft Excel files (versions 95 and 97).
    792 
    793 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.
    794 
    795 GAPlug.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.
    796 
    797 GISBasPlug.extract_placenames:Extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
    798 
    799 GISBasPlug.gazetteer:Gazetteer to use to extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
    800 
    801 GISBasPlug.place_list:When extracting placements, include list of placenames at start of the document. Requires GIS extension to Greenstone.
    802 
    803 GMLPlug.desc:Plugin which processes a GML format document. It assumes that gml tags are all in lower-case.
    804 
    805 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
    806 
    807 HTMLPlug.assoc_files:Perl regular expression of file extensions to associate with html documents.
    808 
    809 HTMLPlug.desc:This plugin processes HTML files
    810 
    811 HTMLPlug.description_tags:Split document into sub-sections where <Section> tags occur. '-keep_head' will have no effect when this option is set.
    812 
    813 HTMLPlug.extract_style:Extract style and script information from the HTML <head> tag and save as DocumentHeader metadata. This will be set in the document page as the _document:documentheader_ macro.
    814 
    815 HTMLPlug.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.
    816 
    817 HTMLPlug.hunt_creator_metadata:Find as much metadata as possible on authorship and place it in the 'Creator' field.
    818 
    819 HTMLPlug.keep_head:Don't remove headers from html files.
    820 
    821 HTMLPlug.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.
    822 
    823 HTMLPlug.no_metadata:Don't attempt to extract any metadata from files.
    824 
    825 HTMLPlug.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.
    826 
    827 HTMLPlug.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).
    828 
    829 HTMLPlug.no_image_links:Don't make any attempt to trap image links to allow view images.
    830 
    831 HTMLPlug.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).
    832 
    833 HTMLPlug.sectionalise_using_h_tags:Automatically create a sectioned document using h1, h2, ... hX tags.
    834 
    835 HTMLPlug.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.
    836 
    837 HTMLPlug.tidy_html:If set, converts an HTML document into a well-formed XHTML to enable users view the document in the book format.
    838 
    839 HTMLPlug.old_style_HDL:To mark whether the file in this collection used the old HDL document's tags style.
    840 
    841 ImagePlug.converttotype:Convert main image to format 's'.
    842 
    843 ImagePlug.desc:This plugin processes images, adding basic metadata
    844 
    845 ImagePlug.minimumsize:Ignore images smaller than n bytes.
    846 
    847 ImagePlug.noscaleup:Don't scale up small images when making thumbnails.
    848 
    849 ImagePlug.generatescreenview:Used to control whether screeen-view resolution images are generated or not.
    850 
    851 ImagePlug.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.
    852 
    853 ImagePlug.screenviewtype:If -screenviewsize is set, this sets the screen display image type.
    854 
    855 ImagePlug.generatethumbnail:Used to control whether thumbnails are generated or not.
    856 
    857 ImagePlug.thumbnailsize:Make thumbnails of size nxn.
    858 
    859 ImagePlug.thumbnailtype:Make thumbnails in format 's'.
    860 
    861 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. <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'.
    862 
    863 ISISPlug.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).
    864 
    865 ISISPlug.subfield_separator:The string used to separate subfields in CDS/ISIS database records.
    866 
    867 ISISPlug.entry_separator:The string used to separate multiple values for single metadata fields in CDS/ISIS database records.
    868 
    869 LaTeXPlug.desc:Plugin for LaTeX documents.
    870 
    871 LOMPlug.desc:Plugin for importing LOM (Learning Object Metadata) files.
    872 
    873 LOMPlug.root_tag:The DocType of the XML file (or a regular expression that matches the root element).
    874 LOMPlug.check_timestamp:Check timestamps of previously downloaded files, and only download again if source file is newer.
    875 LOMPlug.download_srcdocs:Download the source document if one is specified (in general^identifier^entry or technical^location). This option should specify a regular expression to match filenames against before downloading. Note, this currently doesn't work for documents outside a firewall.
    876 
    877 MARCPlug.desc:Basic MARC plugin.
    878 
    879 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.
    880 
    881 MARCXMLPlug.desc:MARCXML plugin.
    882 
    883 MARCXMLPlug.metadata_mapping_file:Name of file that includes mapping details from MARC values to Greenstone metadata names. Defaults to 'marctodc.txt' found in the site's etc directory.
    884 
    885 MediaWikiPlug.desc:Plugin for importing MediaWiki web pages
    886 
    887 MediaWikiPlug.show_toc: Add to the collection's About page the 'table of contents' on the MediaWiki website's main page. Needs to specify a Perl regular expression in toc_exp below to match the 'table of contents' section.
    888 
    889 MediaWikiPlug.delete_toc:Delete the 'table of contents' section on each HTML page. Needs to specify a Perl regular expression in toc_exp below to match the 'table of contents' section.
    890 
    891 MediaWikiPlug.toc_exp:A Perl regular expression to match the 'table of content'. The default value matches common MediaWiki web pages.
    892 
    893 MediaWikiPlug.delete_nav:Delete the navigation section. Needs to specify a Perl regular expression in nav_div_exp below.
    894 
    895 MediaWikiPlug.nav_div_exp:A Perl regular expression to match the navigation section. The default value matches common MediaWiki web pages.
    896 
    897 MediaWikiPlug.delete_searchbox:Delete the searchbox section. Needs to specify a Perl regular expression in searchbox_div_exp below.
    898 
    899 MediaWikiPlug.searchbox_div_id:A Perl regular expression to match the searchbox section. The default value matches common MediaWiki web pages.
    900 
    901 MediaWikiPlug.remove_title_suffix_exp:A Perl regular expression to trim the extracted title. For example, \\s-(.+) will trim title contents after "-".
    902 
    903 MetadataCSVPlug.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.
     779DSpacePlugin.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.
     780DSpacePlugin.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.
     781DSpacePlugin.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.
     782
     783EmailPlugin.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)
     784
     785EmailPlugin.no_attachments:Do not save message attachments.
     786
     787EmailPlugin.headers:Store email headers as "Headers" metadata.
     788
     789EmailPlugin.split_exp:A perl regular expression used to split files containing many messages into individual documents.
     790
     791ExcelPlugin.desc:A plugin for importing Microsoft Excel files (versions 95 and 97).
     792
     793FOXPlugin.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.
     794
     795GAPlugin.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.
     796
     797GISExtractor.extract_placenames:Extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
     798
     799GISExtractor.gazetteer:Gazetteer to use to extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
     800
     801GISExtractor.place_list:When extracting placements, include list of placenames at start of the document. Requires GIS extension to Greenstone.
     802
     803GMLPlugin.desc:Plugin which processes a GML format document. It assumes that gml tags are all in lower-case.
     804
     805HBPlugin.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
     806
     807HTMLPlugin.assoc_files:Perl regular expression of file extensions to associate with html documents.
     808
     809HTMLPlugin.desc:This plugin processes HTML files
     810
     811HTMLPlugin.description_tags:Split document into sub-sections where <Section> tags occur. '-keep_head' will have no effect when this option is set.
     812
     813HTMLPlugin.extract_style:Extract style and script information from the HTML <head> tag and save as DocumentHeader metadata. This will be set in the document page as the _document:documentheader_ macro.
     814
     815HTMLPlugin.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.
     816
     817HTMLPlugin.hunt_creator_metadata:Find as much metadata as possible on authorship and place it in the 'Creator' field.
     818
     819HTMLPlugin.keep_head:Don't remove headers from html files.
     820
     821HTMLPlugin.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.
     822
     823HTMLPlugin.no_metadata:Don't attempt to extract any metadata from files.
     824
     825HTMLPlugin.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.
     826
     827HTMLPlugin.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).
     828
     829HTMLPlugin.no_image_links:Don't make any attempt to trap image links to allow view images.
     830
     831HTMLPlugin.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).
     832
     833HTMLPlugin.sectionalise_using_h_tags:Automatically create a sectioned document using h1, h2, ... hX tags.
     834
     835HTMLPlugin.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.
     836
     837HTMLPlugin.tidy_html:If set, converts an HTML document into a well-formed XHTML to enable users view the document in the book format.
     838
     839HTMLPlugin.old_style_HDL:To mark whether the file in this collection used the old HDL document's tags style.
     840
     841ImageConverter.noconversionavailable:Image conversion not available
     842ImageConverter.imagemagicknotinstalled: Image Magick not installed
     843ImageConverter.win95notsupported: Image Magick not supported on Win95/98
     844ImagePlugin.converttotype:Convert main image to format 's'.
     845
     846ImagePlugin.desc:This plugin processes images, adding basic metadata
     847
     848ImagePlugin.minimumsize:Ignore images smaller than n bytes.
     849
     850ImagePlugin.noscaleup:Don't scale up small images when making thumbnails.
     851
     852ImagePlugin.generatescreenview:Used to control whether screeen-view resolution images are generated or not.
     853
     854ImagePlugin.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.
     855
     856ImagePlugin.screenviewtype:If -screenviewsize is set, this sets the screen display image type.
     857
     858ImagePlugin.generatethumbnail:Used to control whether thumbnails are generated or not.
     859
     860ImagePlugin.thumbnailsize:Make thumbnails of size nxn.
     861
     862ImagePlugin.thumbnailtype:Make thumbnails in format 's'.
     863
     864IndexPlugin.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'.
     865
     866ISISPlugin.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).
     867
     868ISISPlugin.subfield_separator:The string used to separate subfields in CDS/ISIS database records.
     869
     870ISISPlugin.entry_separator:The string used to separate multiple values for single metadata fields in CDS/ISIS database records.
     871
     872LaTeXPlugin.desc:Plugin for LaTeX documents.
     873
     874LOMPlugin.desc:Plugin for importing LOM (Learning Object Metadata) files.
     875
     876LOMPlugin.root_tag:The DocType of the XML file (or a regular expression that matches the root element).
     877LOMPlugin.check_timestamp:Check timestamps of previously downloaded files, and only download again if source file is newer.
     878LOMPlugin.download_srcdocs:Download the source document if one is specified (in general^identifier^entry or technical^location). This option should specify a regular expression to match filenames against before downloading. Note, this currently doesn't work for documents outside a firewall.
     879
     880MARCPlugin.desc:Basic MARC plugin.
     881
     882MARCPlugin.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.
     883
     884MARCXMLPlugin.desc:MARCXML plugin.
     885
     886MARCXMLPlugin.metadata_mapping_file:Name of file that includes mapping details from MARC values to Greenstone metadata names. Defaults to 'marctodc.txt' found in the site's etc directory.
     887
     888MediaWikiPlugin.desc:Plugin for importing MediaWiki web pages
     889
     890MediaWikiPlugin.show_toc: Add to the collection's About page the 'table of contents' on the MediaWiki website's main page. Needs to specify a Perl regular expression in toc_exp below to match the 'table of contents' section.
     891
     892MediaWikiPlugin.delete_toc:Delete the 'table of contents' section on each HTML page. Needs to specify a Perl regular expression in toc_exp below to match the 'table of contents' section.
     893
     894MediaWikiPlugin.toc_exp:A Perl regular expression to match the 'table of content'. The default value matches common MediaWiki web pages.
     895
     896MediaWikiPlugin.delete_nav:Delete the navigation section. Needs to specify a Perl regular expression in nav_div_exp below.
     897
     898MediaWikiPlugin.nav_div_exp:A Perl regular expression to match the navigation section. The default value matches common MediaWiki web pages.
     899
     900MediaWikiPlugin.delete_searchbox:Delete the searchbox section. Needs to specify a Perl regular expression in searchbox_div_exp below.
     901
     902MediaWikiPlugin.searchbox_div_id:A Perl regular expression to match the searchbox section. The default value matches common MediaWiki web pages.
     903
     904MediaWikiPlugin.remove_title_suffix_exp:A Perl regular expression to trim the extracted title. For example, \\s-(.+) will trim title contents after "-".
     905
     906MetadataCSVPlugin.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.
    904907
    905908MetadataPass.desc:On-the-side base class to BasPlug that supports metadata plugins utilise metadata_read pass of import.pl
    906909
    907 METSPlug.desc:Process Greenstone-style METS documents
    908 
    909 GISBasPlug.desc: On-the-side base class to BasPlug that supports GIS capabilities
    910 
    911 NULPlug.desc:Dummy (.nul) file plugin. Used with the files produced by exploding metadata database files.
    912 
    913 NULPlug.assoc_field:Name of a metadata field that will be set for each nul file.
    914 NULPlug.add_metadata_as_text:Add a table of metadata as the text of the document, rather than "This document has no text".
    915 
    916 NULPlug.remove_namespace_for_text:Remove namepsaces from metadata names in the document text (if add_metadata_as_text is set).
    917 
    918 OAIPlug.desc:Basic Open Archives Initiative (OAI) plugin.
    919 
    920 OggVorbisPlug.add_technical_metadata:Add technical (eg. bitrate) metadata.
    921 
    922 OggVorbisPlug.desc:A plugin for importing Ogg Vorbis audio files.
    923 
    924 OpenDocumentPlug.desc:Plugin for OASIS OpenDocument format documents (used by OpenOffice 2.0)
    925 
    926 PagedImgPlug.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.
    927 
    928 PagedImgPlug.documenttype:Set the document type (used for display)
    929 PagedImgPlug.documenttype.paged:Paged documents have next and previous arrows and a 'go to page X' box
    930 PagedImgPlug.documenttype.hierarchy:Hierarchical documents have a table of contents
    931 
    932 PagedImgPlug.headerpage:Add a top level header page (that contains no image) to each document.
    933 
    934 PagedImgPlug.screenview:Produce a screenview image for each image, and set Screen, ScreenSize, ScreenWidth and ScreenHeight metadata.
    935 
    936 PagedImgPlug.screenviewsize:Make screenview images of size nxn.
    937 
    938 PagedImgPlug.screenviewtype:Make screenview images in format 's'.
    939 
    940 PagedImgPlug.thumbnail:Produce a thumbnail for each image
    941 
    942 PDFPlug.allowimagesonly:Allow PDF files with no extractable text. Avoids the need to have -complex set. Only useful with convert_to html.
    943 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).
    944 
    945 PDFPlug.desc:Plugin that processes PDF documents.
    946 
    947 PDFPlug.nohidden:Prevent pdftohtml from attempting to extract hidden text. This is only useful if the -complex option is also set.
    948 
    949 PDFPlug.noimages:Don't attempt to extract images from PDF.
    950 
    951 PDFPlug.use_sections:Create a separate section for each page of the PDF file.
    952 
    953 PDFPlug.zoom:The factor by which to zoom the PDF for output (this is only useful if -complex is set).
    954 
    955 PPTPlug.desc:A plugin for importing Microsoft PowerPoint files.
    956 
    957 PPTPlug.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.
    958 
    959 ProCitePlug.desc:A plugin for (exported) ProCite databases
    960 
    961 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
    962 
    963 PSPlug.extract_date:Extract date from PS header.
    964 
    965 PSPlug.extract_pages:Extract pages from PS header.
    966 
    967 PSPlug.extract_title:Extract title from PS header.
    968 
    969 RealMediaPlug.desc:A plugin for processing Real Media files.
    970 
    971 RecPlug.desc:RecPlug is a plugin which recurses through directories processing each file it finds.
    972 
    973 RecPlug.recheck_directories:After the files in an import directory have been processed, re-read the directory to discover any new files created.
    974 
    975 RecPlug.use_metadata_files:(DEPRECATED - Add MetadataXMLPlug to the list of plugins instead) Read metadata from metadata XML files.
    976 
    977 ReferPlug.desc:ReferPlug reads bibliography files in Refer format.
    978 
    979 ReferPlug.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
    980 
    981 RogPlug.desc:Creates simple single-level documents from .rog or .mdb files.
    982 
    983 RTFPlug.desc:Plugin for importing Rich Text Format files.
    984 
    985 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)
    986 
    987 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.
    988 
    989 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.
    990 
    991 SplitPlug.split_exp:A perl regular expression to split input files into segments.
    992 
    993 StructuredHTMLPlug.desc:A plugin to process structured HTML documents, splitting them into sections based on style information.
    994 
    995 StructuredHTMLPlug.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.
    996 
    997 StructuredHTMLPlug.title_header:possible user-defined styles for the title header.
    998 
    999 StructuredHTMLPlug.level1_header:possible user-defined styles for the level1 header in the HTML document (equivalent to <h1>).
    1000 
    1001 StructuredHTMLPlug.level2_header:possible user-defined styles for the level2 header in the HTML document (equivalent to <h2>).
    1002 
    1003 StructuredHTMLPlug.level3_header:possible user-defined styles for the level3 header in the HTML document (equivalent to <h3>).
    1004 
    1005 StructuredHTMLPlug.toc_header:possible user-defined header styles for the table of contents, table of figures etc, to be removed if delete_toc is set.
    1006 
    1007 TEXTPlug.desc:Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).
    1008 
    1009 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.
    1010 
    1011 UnknownPlug.assoc_field:Name of the metadata field that will hold the associated file's name.
    1012 
    1013 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.
    1014 
    1015 UnknownPlug.file_format:Type of the file (e.g. MPEG, MIDI, ...)
    1016 
    1017 UnknownPlug.mime_type:Mime type of the file (e.g. image/gif).
    1018 
    1019 UnknownPlug.process_extension:Process files with this file extension. This option is an alternative to process_exp that is simpler to use but less flexible.
    1020 
    1021 UnknownPlug.srcicon:Specify a macro name (without underscores) to use as srcicon metadata.
    1022 
    1023 MP3Plug.desc:Plugin for processing MP3 files.
    1024 
    1025 MP3Plug.assoc_images:Use Google image search to locate images related to MP3 file based on ID3 Title and Artist metadata.
    1026 
    1027 MP3Plug.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.
    1028 
    1029 MP3Plug.metadata_fields:Comma separated list of metadata fields to extract (assuming present) in an MP3 file. Use \"*\" to extract all the fields.
    1030 
    1031 W3ImgPlug.aggressiveness:Range of related text extraction techniques to use.
    1032 W3ImgPlug.aggressiveness.1:Filename, path, ALT text only.
    1033 W3ImgPlug.aggressiveness.2:All of 1, plus caption where available.
    1034 W3ImgPlug.aggressiveness.3:All of 2, plus near paragraphs where available.
    1035 W3ImgPlug.aggressiveness.4:All of 3, plus previous headers (<h1>, <h2>...) where available.
    1036 W3ImgPlug.aggressiveness.5:All of 4, plus textual references where available.
    1037 W3ImgPlug.aggressiveness.6:All of 4, plus page metatags (title, keywords, etc).
    1038 W3ImgPlug.aggressiveness.7:All of 6, 5 and 4 combined.
    1039 W3ImgPlug.aggressiveness.8:All of 7, plus repeat caption, filename, etc (raise ranking of more relevant results).
    1040 W3ImgPlug.aggressiveness.9:All of 1, plus full text of source page.
    1041 
    1042 W3ImgPlug.caption_length:Maximum length of captions (in characters).
    1043 
    1044 W3ImgPlug.convert_params:Additional parameters for ImageMagicK convert on thumbnail creation. For example, '-raise' will give a three dimensional effect to thumbnail images.
    1045 
    1046 W3ImgPlug.desc:A plugin for extracting images and associated text from webpages.
    1047 
    1048 W3ImgPlug.document_text:Add image text as document:text (otherwise IndexedText metadata field).
    1049 
    1050 W3ImgPlug.index_pages:Index the pages along with the images. Otherwise reference the pages at the source URL.
    1051 
    1052 W3ImgPlug.max_near_text:Maximum characters near images to extract.
    1053 
    1054 W3ImgPlug.min_height:Pixels. Skip images shorter than this.
    1055 
    1056 W3ImgPlug.min_near_text:Minimum characters of near text or caption to extract.
    1057 
    1058 W3ImgPlug.min_size:Bytes. Skip images smaller than this.
    1059 
    1060 W3ImgPlug.min_width:Pixels. Skip images narrower than this.
    1061 
    1062 W3ImgPlug.neartext_length:Target length of near text (in characters).
    1063 
    1064 W3ImgPlug.no_cache_images:Don't cache images (point to URL of original).
    1065 
    1066 W3ImgPlug.smallpage_threshold:Images on pages smaller than this (bytes) will have the page (title, keywords, etc) meta-data added.
    1067 
    1068 W3ImgPlug.textrefs_threshold:Threshold for textual references. Lower values mean the algorithm is less strict.
    1069 
    1070 W3ImgPlug.thumb_size:Max thumbnail size. Both width and height.
    1071 
    1072 WordPlug.desc:A plugin for importing Microsoft Word documents.
    1073 
    1074 WordPlug.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.
    1075 
    1076 WordPlug.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
    1077 
    1078 XMLPlug.desc:Base class for XML plugins.
    1079 
    1080 XMLPlug.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.
    1081 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)
     910METSPlugin.desc:Process Greenstone-style METS documents
     911
     912GISExtractor.desc: On-the-side base class to BasPlug that supports GIS capabilities
     913
     914NulPlugin.desc:Dummy (.nul) file plugin. Used with the files produced by exploding metadata database files.
     915
     916NulPlugin.assoc_field:Name of a metadata field that will be set for each nul file.
     917NulPlugin.add_metadata_as_text:Add a table of metadata as the text of the document, rather than "This document has no text".
     918
     919NulPlugin.remove_namespace_for_text:Remove namepsaces from metadata names in the document text (if add_metadata_as_text is set).
     920
     921OAIPlugin.desc:Basic Open Archives Initiative (OAI) plugin.
     922
     923OggVorbisPlugin.add_technical_metadata:Add technical (eg. bitrate) metadata.
     924
     925OggVorbisPlugin.desc:A plugin for importing Ogg Vorbis audio files.
     926
     927OpenDocumentPlugin.desc:Plugin for OASIS OpenDocument format documents (used by OpenOffice 2.0)
     928
     929PagedImagePlugin.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.
     930
     931PagedImagePlugin.documenttype:Set the document type (used for display)
     932PagedImagePlugin.documenttype.paged:Paged documents have next and previous arrows and a 'go to page X' box
     933PagedImagePlugin.documenttype.hierarchy:Hierarchical documents have a table of contents
     934
     935PagedImagePlugin.headerpage:Add a top level header page (that contains no image) to each document.
     936
     937PagedImagePlugin.screenview:Produce a screenview image for each image, and set Screen, ScreenSize, ScreenWidth and ScreenHeight metadata.
     938
     939PagedImagePlugin.screenviewsize:Make screenview images of size nxn.
     940
     941PagedImagePlugin.screenviewtype:Make screenview images in format 's'.
     942
     943PagedImagePlugin.thumbnail:Produce a thumbnail for each image
     944
     945PDFPlugin.allowimagesonly:Allow PDF files with no extractable text. Avoids the need to have -complex set. Only useful with convert_to html.
     946PDFPlugin.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).
     947
     948PDFPlugin.desc:Plugin that processes PDF documents.
     949
     950PDFPlugin.nohidden:Prevent pdftohtml from attempting to extract hidden text. This is only useful if the -complex option is also set.
     951
     952PDFPlugin.noimages:Don't attempt to extract images from PDF.
     953
     954PDFPlugin.use_sections:Create a separate section for each page of the PDF file.
     955
     956PDFPlugin.zoom:The factor by which to zoom the PDF for output (this is only useful if -complex is set).
     957
     958PPTPlugin.desc:A plugin for importing Microsoft PowerPoint files.
     959
     960PPTPlugin.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.
     961
     962ProCitePlugin.desc:A plugin for (exported) ProCite databases
     963
     964PSPlugin.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
     965
     966PSPlugin.extract_date:Extract date from PS header.
     967
     968PSPlugin.extract_pages:Extract pages from PS header.
     969
     970PSPlugin.extract_title:Extract title from PS header.
     971
     972RealMediaPlugin.desc:A plugin for processing Real Media files.
     973
     974DirectoryPlugin.desc:RecPlug is a plugin which recurses through directories processing each file it finds.
     975
     976DirectoryPlugin.recheck_directories:After the files in an import directory have been processed, re-read the directory to discover any new files created.
     977
     978DirectoryPlugin.use_metadata_files:(DEPRECATED - Add MetadataXMLPlug to the list of plugins instead) Read metadata from metadata XML files.
     979
     980ReferPlugin.desc:ReferPlug reads bibliography files in Refer format.
     981
     982ReferPlugin.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
     983
     984RogPlugin.desc:Creates simple single-level documents from .rog or .mdb files.
     985
     986RTFPlugin.desc:Plugin for importing Rich Text Format files.
     987
     988SourceCodePlugin.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)
     989
     990SourceCodePlugin.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.
     991
     992SplitPlugin.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.
     993
     994SplitPlugin.split_exp:A perl regular expression to split input files into segments.
     995
     996StructuredHTMLPlugin.desc:A plugin to process structured HTML documents, splitting them into sections based on style information.
     997
     998StructuredHTMLPlugin.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.
     999
     1000StructuredHTMLPlugin.title_header:possible user-defined styles for the title header.
     1001
     1002StructuredHTMLPlugin.level1_header:possible user-defined styles for the level1 header in the HTML document (equivalent to <h1>).
     1003
     1004StructuredHTMLPlugin.level2_header:possible user-defined styles for the level2 header in the HTML document (equivalent to <h2>).
     1005
     1006StructuredHTMLPlugin.level3_header:possible user-defined styles for the level3 header in the HTML document (equivalent to <h3>).
     1007
     1008StructuredHTMLPlugin.toc_header:possible user-defined header styles for the table of contents, table of figures etc, to be removed if delete_toc is set.
     1009
     1010TextPlugin.desc:Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).
     1011
     1012TextPlugin.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.
     1013
     1014UnknownPlugin.assoc_field:Name of the metadata field that will hold the associated file's name.
     1015
     1016UnknownPlugin.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.
     1017
     1018UnknownPlugin.file_format:Type of the file (e.g. MPEG, MIDI, ...)
     1019
     1020UnknownPlugin.mime_type:Mime type of the file (e.g. image/gif).
     1021
     1022UnknownPlugin.process_extension:Process files with this file extension. This option is an alternative to process_exp that is simpler to use but less flexible.
     1023
     1024UnknownPlugin.srcicon:Specify a macro name (without underscores) to use as srcicon metadata.
     1025
     1026MP3Plugin.desc:Plugin for processing MP3 files.
     1027
     1028MP3Plugin.assoc_images:Use Google image search to locate images related to MP3 file based on ID3 Title and Artist metadata.
     1029
     1030MP3Plugin.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.
     1031
     1032MP3Plugin.metadata_fields:Comma separated list of metadata fields to extract (assuming present) in an MP3 file. Use \"*\" to extract all the fields.
     1033
     1034W3ImagePlugin.aggressiveness:Range of related text extraction techniques to use.
     1035W3ImagePlugin.aggressiveness.1:Filename, path, ALT text only.
     1036W3ImagePlugin.aggressiveness.2:All of 1, plus caption where available.
     1037W3ImagePlugin.aggressiveness.3:All of 2, plus near paragraphs where available.
     1038W3ImagePlugin.aggressiveness.4:All of 3, plus previous headers (<h1>, <h2>...) where available.
     1039W3ImagePlugin.aggressiveness.5:All of 4, plus textual references where available.
     1040W3ImagePlugin.aggressiveness.6:All of 4, plus page metatags (title, keywords, etc).
     1041W3ImagePlugin.aggressiveness.7:All of 6, 5 and 4 combined.
     1042W3ImagePlugin.aggressiveness.8:All of 7, plus repeat caption, filename, etc (raise ranking of more relevant results).
     1043W3ImagePlugin.aggressiveness.9:All of 1, plus full text of source page.
     1044
     1045W3ImagePlugin.caption_length:Maximum length of captions (in characters).
     1046
     1047W3ImagePlugin.convert_params:Additional parameters for ImageMagicK convert on thumbnail creation. For example, '-raise' will give a three dimensional effect to thumbnail images.
     1048
     1049W3ImagePlugin.desc:A plugin for extracting images and associated text from webpages.
     1050
     1051W3ImagePlugin.document_text:Add image text as document:text (otherwise IndexedText metadata field).
     1052
     1053W3ImagePlugin.index_pages:Index the pages along with the images. Otherwise reference the pages at the source URL.
     1054
     1055W3ImagePlugin.max_near_text:Maximum characters near images to extract.
     1056
     1057W3ImagePlugin.min_height:Pixels. Skip images shorter than this.
     1058
     1059W3ImagePlugin.min_near_text:Minimum characters of near text or caption to extract.
     1060
     1061W3ImagePlugin.min_size:Bytes. Skip images smaller than this.
     1062
     1063W3ImagePlugin.min_width:Pixels. Skip images narrower than this.
     1064
     1065W3ImagePlugin.neartext_length:Target length of near text (in characters).
     1066
     1067W3ImagePlugin.no_cache_images:Don't cache images (point to URL of original).
     1068
     1069W3ImagePlugin.smallpage_threshold:Images on pages smaller than this (bytes) will have the page (title, keywords, etc) meta-data added.
     1070
     1071W3ImagePlugin.textrefs_threshold:Threshold for textual references. Lower values mean the algorithm is less strict.
     1072
     1073W3ImagePlugin.thumb_size:Max thumbnail size. Both width and height.
     1074
     1075WordPlugin.desc:A plugin for importing Microsoft Word documents.
     1076
     1077WordPlugin.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.
     1078
     1079WordPlugin.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
     1080
     1081ReadXMLFile.desc:Base class for XML plugins.
     1082
     1083ReadXMLFile.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.
     1084ZIPPlugin.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)
    10821085
    10831086#
Note: See TracChangeset for help on using the changeset viewer.