Changeset 12742


Ignore:
Timestamp:
2006-09-14T13:33:01+12:00 (18 years ago)
Author:
kjdon
Message:

plugin description mods. Some changed, some added, some removed

File:
1 edited

Legend:

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

    r12706 r12742  
    721721BookPlug.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.
    722722
    723 BRSPlug.desc: BRSPlug deals with the BBC collections. There are three BBC collections we deliver, which are National Sound Archive (nsa), British Film Institute (bfi), and BBC Other (bbcother) (everything does not fit into one of the first two). Four options are provided which are all-build all collections, nsa-build the NSA collections, bfi-build the BFI collections, bbcother-build the OTHER collections.
    724 
    725723ConvertToPlug.apply_fribidi:Run the "fribidi" Unicode Bidirectional Algorithm program over the converted file (for right-to-left text).
    726724ConvertToPlug.convert_to:Plugin converts to TEXT or HTML or various types of Image (e.g. JPEG, GIF, PNG).
     
    732730ConvertToPlug.convert_to.pagedimg_png:PNG format.
    733731
    734 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.
     732ConvertToPlug.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'.
    735733
    736734ConvertToPlug.use_strings:If set, a simple strings function will be called to extract text if the conversion utility fails.
     
    738736ConvertToRogPlug.desc:A plugin that inherits from RogPlug.
    739737
    740 DBPlug.desc:Uses records from a database as documents.
     738CSVPlug.desc:A plugin for files in comma-separated value format. A new document will be created for each line of the file.
     739
     740DBPlug.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.
    741741
    742742DBPlug.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.
    743743
    744 DSpacePlug.desc:DSpacePlug reads the DSpace Export collection and its dublin_core metadata file, and convert to GSII compliance format.
     744DSpacePlug.desc:DSpacePlug takes a collection of documents exported from DSpace and imports them into Greenstone.
     745   
    745746DSpacePlug.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.
    746747DSpacePlug.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.
     
    755756EMAILPlug.split_exp:A perl regular expression used to split files containing many messages into individual documents.
    756757
    757 ExcelPlug.desc:A plugin for importing Microsoft Excel files.
     758ExcelPlug.desc:A plugin for importing Microsoft Excel files (versions 95 and 97).
    758759
    759760FOXPlug.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.
    760761
    761 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.
     762GAPlug.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.
    762763
    763764GISBasPlug.extract_placenames:Extract placenames from within text and set as metadata. Requires GIS extension to Greenstone.
     
    767768GISBasPlug.place_list:When extracting placements, include list of placenames at start of the document. Requires GIS extension to Greenstone.
    768769
    769 GMLPlug.desc:Plugin which processes a GML format document assumes that gml tags are all in lower-case.
     770GMLPlug.desc:Plugin which processes a GML format document. It assumes that gml tags are all in lower-case.
    770771
    771772HBPlug.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
     
    823824LaTeXPlug.desc:Plugin for LaTeX documents.
    824825
    825 MACROPlug.desc:Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).
    826 
    827826MARCPlug.desc:Basic MARC plugin.
    828827
    829828MARCPlug.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.
    830829
     830MetadataCSVPlug.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.
     831
    831832MetadataPass.desc:On-the-side base class to BasPlug that supports metadata plugins utilise metadata_read pass of import.pl
     833
     834METSPlug.desc:Process Greenstone-style METS documents
     835
    832836GISBasPlug.desc: On-the-side base class to BasPlug that supports GIS capabilities
    833837
     
    843847OpenDocumentPlug.desc:Plugin for OASIS OpenDocument format documents (used by OpenOffice 2.0)
    844848
    845 PagedImgPlug.desc:Plugin for documents made up of a sequence of images, with optional OCR text for each image.
     849PagedImgPlug.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.
    846850
    847851PagedImgPlug.documenttype:Set the document type (used for display)
     
    862866PDFPlug.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).
    863867
    864 PDFPlug.desc:Reasonably with-it pdf plugin.
     868PDFPlug.desc:Plugin that processes PDF documents.
    865869
    866870PDFPlug.nohidden:Prevent pdftohtml from attempting to extract hidden text. This is only useful if the -complex option is also set.
     
    876880PPTPlug.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.
    877881
     882ProCitePlug.desc:A plugin for (exported) ProCite databases
     883
    878884PSPlug.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
    879885
     
    907913
    908914SplitPlug.split_exp:A perl regular expression to split input files into segments.
     915
     916StructuredHTMLPlug.desc:A plugin to process structured HTML documents, splitting them into sections based on style information.
    909917
    910918StructuredHTMLPlug.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.
Note: See TracChangeset for help on using the changeset viewer.