Changeset 5680


Ignore:
Timestamp:
2003-10-20T14:57:31+13:00 (21 years ago)
Author:
mdewsnip
Message:

Moved plugin descriptions into the resource bundle (perllib/strings.rb), for translation by UNESCO.

Location:
trunk/gsdl/perllib/plugins
Files:
33 edited

Legend:

Unmodified
Added
Removed

  • trunk/gsdl/perllib/plugins/ArcPlug.pm

    r4744 r5680  
    3636use plugin;
    3737use arcinfo;
     38use gsprintf;
    3839
    3940BEGIN {
    … …  
    4243
    4344my $options = { 'name'     => "ArcPlug",
    44         '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.",
     45        'desc'     => "{ArcPlug.desc}",
    4546        'inherits' => "Yes" };
     47
     48sub gsprintf
     49{
     50    return &gsprintf::gsprintf(@_);
     51}
    4652
    4753sub new {
    … …  
    7985
    8086    # found an archives.inf file
    81     print $outhandle "ArcPlug: processing $archive_info_filename\n";
     87    &gsprintf($outhandle, "ArcPlug: {common.processing} $archive_info_filename\n");
    8288
    8389    # read in the archives information file

  • trunk/gsdl/perllib/plugins/BibTexPlug.pm

    r5454 r5680  
    5959
    6060my $options = { 'name'     => "BibTexPlug",
    61         '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.",
     61        'desc'     => "{BibTexPlug.desc}",
    6262        'inherits' => "Yes",
    6363        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/BookPlug.pm

    r4873 r5680  
    7373
    7474my $options = { 'name'     => "BookPlug",
    75         '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.",
     75        'desc'     => "{BookPlug.desc}",
    7676        'inherits' => "Yes",
    7777        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/ConvertToPlug.pm

    r4873 r5680  
    6868
    6969my $options = { 'name'     => "ConvertToPlug",
    70         '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.",
     70        'desc'     => "{ConvertToPlug.desc}",
    7171        'inherits' => "Yes",
    7272        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/ConvertToRogPlug.pm

    r4843 r5680  
    3737
    3838my $options = { 'name'     => "ConvertToRogPlug",
    39         'desc'     => "A plugin that inherits from RogPlug.",
     39        'desc'     => "{ConvertToRogPlug.desc}",
    4040        'inherits' => "Yes" };
    4141

  • trunk/gsdl/perllib/plugins/DBPlug.pm

    r4873 r5680  
    5252
    5353my $options = { 'name'     => "DBPlug",
    54         'desc'     => "Uses records from a database as documents.",
     54        'desc'     => "{DBPlug.desc}",
    5555        'inherits' => "yes",
    5656        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/EMAILPlug.pm

    r4873 r5680  
    104104
    105105my $options = { 'name'     => "EMAILPlug",
    106         '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)",
     106        'desc'     => "{EMAILPlug.desc}",
    107107        'inherits' => "Yes",
    108108        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/ExcelPlug.pm

    r4744 r5680  
    3535
    3636my $options = { 'name'     => "ExcelPlug",
    37         'desc'     => "A plugin for importing Microsoft Excel files.",
     37        'desc'     => "{ExcelPlug.desc}",
    3838        'inherits' => "Yes" };
    3939

  • trunk/gsdl/perllib/plugins/FOXPlug.pm

    r4744 r5680  
    4646
    4747my $options = { 'name'     => "FOXPlug",
    48         '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.",
     48        'desc'     => "{FOXPlug.desc}",
    4949        'inherits' => "yes" };
    5050

  • trunk/gsdl/perllib/plugins/GAPlug.pm

    r3629 r5680  
    4040
    4141my $options = { 'name'     => "GAPlug",
    42         '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.",
     42        'desc'     => "{GAPlug.desc}",
    4343        'inherits' => "yes" };
    4444

  • trunk/gsdl/perllib/plugins/GMLPlug.pm

    r3540 r5680  
    4040
    4141my $options = { 'name'     => "GMLPlug",
    42         'desc'     => "Plugin which processes a GML format document assumes that gml tags are all in lower-case.",
     42        'desc'     => "{GMLPlug.desc}",
    4343        'inherits' => "yes" };
    4444

  • trunk/gsdl/perllib/plugins/HBPlug.pm

    r4744 r5680  
    5454
    5555my $options = { 'name'     => "HBPlug",
    56         '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",
     56        'desc'     => "{HBPlug.desc}",
    5757        'inherits' => "yes" };
    5858

  • trunk/gsdl/perllib/plugins/HTMLPlug.pm

    r5096 r5680  
    9292
    9393my $options = { 'name'     => "HTMLPlug",
    94         'desc'     => "This plugin processes HTML files",
     94        'desc'     => "{HTMLPlug.desc}",
    9595        'inherits' => "yes",
    9696        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/ImagePlug.pm

    r5103 r5680  
    7474
    7575my $options = { 'name'     => "ImagePlug",
    76         'desc'     => "",
     76        'desc'     => "{ImagePlug.desc}",
    7777        'inherits' => "yes",
    7878        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/IndexPlug.pm

    r3540 r5680  
    6565
    6666my $options = { 'name'     => "IndexPlug",
    67         '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'..",
     67        'desc'     => "{IndexPlug.desc}",
    6868        'inherits' => "yes" };
    6969

  • trunk/gsdl/perllib/plugins/MACROPlug.pm

    r4873 r5680  
    4242
    4343my $options = { 'name'     => "MACROPlug",
    44         'desc'     => "Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).",
     44        'desc'     => "{MACROPlug.desc}",
    4545        'inherits' => "yes",
    4646        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/MARCPlug.pm

    r4873 r5680  
    4646
    4747my $options = { 'name'     => "MARCPlug",
    48         'desc'     => "Basic MARC plugin.",
     48        'desc'     => "{MARCPlug.desc}",
    4949        'inherits' => "Yes",
    5050        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/OAIPlug.pm

    r4873 r5680  
    3737
    3838my $options = { 'name'     => "OAIPlug",
    39         'desc'     => "Basic Open Archives Initiate (OAI) plugin.",
     39        'desc'     => "{OAIPlug.desc}",
    4040        'inherits' => "yes" };
    4141

  • trunk/gsdl/perllib/plugins/PDFPlug.pm

    r5616 r5680  
    6060
    6161my $options = { 'name'     => "PDFPlug",
    62         'desc'     => "Reasonably with-it pdf plugin.",
     62        'desc'     => "{PDFPlug.desc}",
    6363        'inherits' => "yes",
    6464        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/PPTPlug.pm

    r4744 r5680  
    3535
    3636my $options = { 'name'     => "PPTPlug",
    37         'desc'     => "A plugin for importing Microsoft PowerPoint files.",
     37        'desc'     => "{PPTPlug.desc}",
    3838        'inherits' => "Yes" };
    3939

  • trunk/gsdl/perllib/plugins/PSPlug.pm

    r4873 r5680  
    5656
    5757my $options = { 'name'     => "PSPlug",
    58         '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",
     58        'desc'     => "{PSPlug.desc}",
    5959        'inherits' => "yes",
    6060        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/RTFPlug.pm

    r4873 r5680  
    4343
    4444my $options = { 'name'     => "RTFPlug",
    45         'desc'     => "Plugin for importing Rich Text Format files.",
     45        'desc'     => "{RTFPlug.desc}",
    4646        'inherits' => "yes",
    4747        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/RecPlug.pm

    r5295 r5680  
    118118
    119119my $options = { 'name'     => "RecPlug",
    120         'desc'     => "RecPlug is a plugin which recurses through directories processing each file it finds.",
     120        'desc'     => "{RecPlug.desc}",
    121121        'inherits' => "yes",
    122122        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/ReferPlug.pm

    r4873 r5680  
    8080
    8181my $options = { 'name'     => "ReferPlug",
    82         '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",
     82        'desc'     => "{ReferPlug.desc}",
    8383        'inherits' => "yes",
    8484        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/RogPlug.pm

    r4744 r5680  
    3737
    3838my $options = { 'name'     => "RogPlug",
    39         'desc'     => "Creates simple single-level documents from .rog or .mdb files.",
     39        'desc'     => "{RogPlug.desc}",
    4040        'inherits' => "Yes" };
    4141

  • trunk/gsdl/perllib/plugins/SRCPlug.pm

    r4873 r5680  
    6464
    6565my $options = { 'name'     => "SRCPlug",
    66         '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)",
     66        'desc'     => "{SRCPlug.desc}",
    6767        'inherits' => "yes",
    6868        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/SplitPlug.pm

    r4873 r5680  
    5757
    5858my $options = { 'name'     => "SplitPlug",
    59         '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.",
     59        'desc'     => "{SplitPlug.desc}",
    6060        'inherits' => "yes",
    6161            'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/TEXTPlug.pm

    r4873 r5680  
    5252
    5353my $options = { 'name'     => "TEXTPlug",
    54         'desc'     => "Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).",
     54        'desc'     => "{TEXTPlug.desc}",
    5555        'inherits' => "yes",
    5656        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/UnknownPlug.pm

    r4873 r5680  
    7777
    7878my $options = { 'name'     => "UnknownPlug",
    79         '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.",
     79        'desc'     => "{UnknownPlug.desc}",
    8080        'inherits' => "yes",
    8181        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/W3ImgPlug.pm

    r4873 r5680  
    219219
    220220my $options = { 'name'     => "W3ImgPlug",
    221         'desc'     => "",
     221        'desc'     => "{W3ImgPlug.desc}",
    222222        'inherits' => "yes",
    223223        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/WordPlug.pm

    r4873 r5680  
    4242
    4343my $options = { 'name'     => "WordPlug",
    44         'desc'     => "A plugin for importing Microsoft Word documents.",
     44        'desc'     => "{WordPlug.desc}",
    4545        'inherits' => "yes",
    4646        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/XMLPlug.pm

    r4873 r5680  
    4444
    4545my $options = { 'name'     => "XMLPlug",
    46         'desc'     => "Base class for XML plugins.",
     46        'desc'     => "{XMLPlug.desc}",
    4747        'inherits' => "yes",
    4848        'args'     => $arguments };

  • trunk/gsdl/perllib/plugins/ZIPPlug.pm

    r4744 r5680  
    5858
    5959my $options = { 'name'     => "ZIPPlug",
    60         '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)",
     60        'desc'     => "{ZIPPlug.desc}",
    6161        'inherits' => "yes" };
    6262
Note: See TracChangeset for help on using the changeset viewer.