Changeset 7353

Timestamp:

2004-05-20T09:25:16+12:00 (20 years ago)

Author:

kjdon

Message:

removed all the old print_usage functions - they may be misleading as options change but these dont

Location:

trunk/gsdl/perllib/plugins

Files:

• ConvertToPlug.pm (modified) (2 diffs)
• ConvertToRogPlug.pm (modified) (2 diffs)
• ImagePlug.pm (modified) (1 diff)
• MACROPlug.pm (modified) (1 diff)
• MARCPlug.pm (modified) (1 diff)
• OAIPlug.pm (modified) (1 diff)
• PDFPlug.pm (modified) (1 diff)
• PSPlug.pm (modified) (1 diff)
• RecPlug.pm (modified) (1 diff)
• SRCPlug.pm (modified) (1 diff)
• TEXTPlug.pm (modified) (1 diff)
• UnknownPlug.pm (modified) (1 diff)
• W3ImgPlug.pm (modified) (1 diff)

trunk/gsdl/perllib/plugins/ConvertToPlug.pm

@@ -73 +73 @@
         'args'     => $arguments };
 
-
-sub print_usage {
-    my ($plugin_name) = @_;
-    
-    # for when this function is called directly by pluginfo.pl
-    if (ref ($plugin_name)) {
-    $plugin_name = ref ($plugin_name);
-    }
-
-    print STDERR "\n  usage: plugin $plugin_name [options]\n\n";
-    print STDERR "  options:\n";
-    print STDERR "   -convert_to (html|text) plugin converts to TEXT or HTML\n";
-    print STDERR "                           (default html)\n";
-    print STDERR "   -use_strings            if set a simple strings function\n";
-    print STDERR "                           will be called to extract text\n";
-    print STDERR "                           if the conversion utility fails\n";
-}
-
 sub parse_args
 {
@@ -110 +92 @@
     print STDERR "\nIncorrect options passed to $plugin_name, ";
     print STDERR "check your collect.cfg configuration file\n";
-    &print_usage($plugin_name);
+    $self->print_txt_usage("");  # Use default resource bundle
     die "\n";
     }

trunk/gsdl/perllib/plugins/ConvertToRogPlug.pm

@@ -41 +41 @@
         'inherits' => "yes" };
 
-sub print_usage {
-    my ($plugin_name) = @_;
-    
-    # for when this function is called directly by pluginfo.pl
-    if (ref ($plugin_name)) {
-    $plugin_name = ref ($plugin_name);
-    }
-
-    print STDERR "\n  usage: plugin $plugin_name [options]\n\n";
-    print STDERR "  options:\n";
-    print STDERR "   [none at present]\n";
-}
 
 sub parse_args
@@ -67 +55 @@
     print STDERR "\nIncorrect options passed to $plugin_name, ";
     print STDERR "check your collect.cfg configuration file\n";
-    &print_usage($plugin_name);
+    $self->print_txt_usage("");  # Use default resource bundle
     die "\n";
     }

trunk/gsdl/perllib/plugins/ImagePlug.pm

@@ -80 +80 @@
 
 
-#  sub print_usage {
-#      my ($plugin_name) = @_;
-
-#      print STDERR "
-#    usage: plugin ImagePlug [options]
-
-#     -noscaleup         Don't scale up small images when making thumbnails
-
-#     -thumbnailsize n   Make thumbnails of size nxn
-
-#     -thumbnailtype s   Make thumbnails in format 's'
-
-#     -screenviewsize n  If set, makes an image of size n for screen display
-#                        and sets Screen, ScreenSize, ScrrenWidth and Screeneight
-#                        metadata.  By default it is not set.
-
-#     -screenviewtype s  If -screenviewsize is set, this sets the screen display
-#                        image type.  Defaults to jpg.
-
-#     -convertto s       Convert main inage to (gif|png|jpg)
-
-#     -minimumsize n     Ignore images smaller than n bytes
-
-#  "
-#  }
 
 sub new {

trunk/gsdl/perllib/plugins/MACROPlug.pm

@@ -47 +47 @@
         'args'     => $arguments };
 
-#  sub print_usage {
-#      print STDERR "\n  usage: plugin MACROPlug [options]\n\n";
-#      print STDERR "  options:\n";
-#      print STDERR "   -title_sub\t     Substitution expression to modify string stored as Title.\n";
-#      print STDERR "\t\t     Used by, for example, PSPlug to remove \"Page 1\" etc from\n";
-#      print STDERR "\t\t     text used as the title.\n";
-
-#      print STDERR "\n";
-#  }
-
 
 sub load_language_table

trunk/gsdl/perllib/plugins/MARCPlug.pm

@@ -67 +67 @@
 #use MARC::Batch;
 
-#  sub print_usage {
-#      print STDERR "\n  usage: plugin MARCPlug [options]\n\n";
-#      print STDERR "  options:\n";
-#      print STDERR 
-#  "   -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.\n\n";
-#  }
 
 sub new {

trunk/gsdl/perllib/plugins/OAIPlug.pm

@@ -49 +49 @@
         'inherits' => "yes",
         'args'     => $arguments };
-
-#  sub print_usage {
-#      print STDERR "\n  usage: plugin OAIPlug [options]\n\n";
-#      print STDERR "  currently no options:\n";
-#  }
 
 sub new {

trunk/gsdl/perllib/plugins/PDFPlug.pm

@@ -122 +122 @@
 }
 
-
-#  sub print_usage {
-#      print STDERR "\n  usage: plugin PDFPlug [options]\n\n";
-#      print STDERR "  options:\n";
-#      print STDERR "   -convert_to (html|text) Convert to TEXT or HTML (default html)\n";
-#      print STDERR "   -use_sections     Create a separate section for each page\n";
-#      print STDERR "                     of the PDF file.\n";
-#      print STDERR "   -noimages         Don't attempt to extract images from PDF.\n";
-#      print STDERR "   -complex          Create more complex output. With this option\n";
-#      print STDERR "                     set the output html will look much more like\n";
-#      print STDERR "                     the original PDF file. For this to function\n";
-#      print STDERR "                     properly you Ghostscript installed (for *nix\n";
-#      print STDERR "                     gs should be on your path while for windows\n";
-#      print STDERR "                     you must have gswin32c.exe on your path).\n";
-#      print STDERR "   -nohidden         Prevent pdftohtml from attempting to extract\n";
-#      print STDERR "                     hidden text. This is only useful if the -complex\n";
-#      print STDERR "                     option is also set.";
-#      print STDERR "   -zoom             The factor by which to zoomthe PDF for output\n";
-#      print STDERR "                     (this is only useful if -complex is set).\n\n";
-#  }
-
-
-
 sub get_default_process_exp {
     my $self = shift (@_);

trunk/gsdl/perllib/plugins/PSPlug.pm

@@ -85 +85 @@
 }
 
-#  sub print_usage {
-#      print STDERR "\n  usage: plugin PSPlug [options]\n\n";
-#      print STDERR "  options:\n";
-#      print STDERR "   -extract_date               Extract date from PS header\n";
-#      print STDERR "   -extract_pages              Extract pages from PS header\n";
-#      print STDERR "   -extract_title              Extract title from PS header\n";
-#      print STDERR "\n\nNote! This is a \"poor man's\" ps to text converter. If you are serious, consider\n";
-#      print STDERR "using the PRESCRIPT package, which is available for download at\n   http://www.nzdl.org/html/software.html\n\n";
-#  }
 
 sub get_default_block_exp {

trunk/gsdl/perllib/plugins/RecPlug.pm

@@ -123 +123 @@
         'args'     => $arguments };
 
-#  sub print_usage {
-#      my ($plugin_name) = @_;
-
-#      print STDERR "
-#    usage: plugin RecPlug [options]
-
-#     -use_metadata_files  Read metadata from metadata XML files.
-
-#  "
-#  }
 
 my ($self);

trunk/gsdl/perllib/plugins/SRCPlug.pm

@@ -69 +69 @@
         'args'     => $arguments };
 
-#  sub print_usage {
-#      print STDERR "\n  usage: plugin SRCPlug [options]\n";
-#      print STDERR "Try to import C and C++ source code. Adds \"class\"";
-#      print STDERR " metadata.\n\n";
-#      print STDERR "  options:\n";
-#      print STDERR "  -remove_prefix <pattern>   Remove this leading pattern from the filename\n";
-#      print STDERR "                             (eg -remove_prefix /tmp/XX/src/). The default is to\n";
-#      print STDERR "                             remove the whole path from the filename.\n";
-#      print STDERR "\n";
-#  }
 
 sub new {

trunk/gsdl/perllib/plugins/TEXTPlug.pm

@@ -57 +57 @@
         'args'     => $arguments };
 
-#  sub print_usage {
-#      print STDERR "\n  usage: plugin TEXTPlug [options]\n\n";
-#      print STDERR "  options:\n";
-#      print STDERR "   -title_sub\t     Substitution expression to modify string stored as Title.\n";
-#      print STDERR "\t\t     Used by, for example, PSPlug to remove \"Page 1\" etc from\n";
-#      print STDERR "\t\t     text used as the title.\n";
-
-#      print STDERR "\n";
-#  }
 
 sub new {

trunk/gsdl/perllib/plugins/UnknownPlug.pm

@@ -82 +82 @@
         'args'     => $arguments };
 
-#  sub print_usage {
-#      print STDERR "\n  usage: plugin UnknownPlug [options]\n\n";
-#      print STDERR "  options:\n";
-#      print STDERR "   -assoc_field\t     Name of the metadata field that will hold\n";
-#      print STDERR "\t\t     the associated file's name.\n";
-#      print STDERR "\n";
-#      print STDERR "   -file_type\t     Mime type of the file (e.g. image/gif)\n";
-#      print STDERR "\n";
-#  }
 
 sub new {

trunk/gsdl/perllib/plugins/W3ImgPlug.pm

@@ -223 +223 @@
         'inherits' => "yes",
         'args'     => $arguments };
-
-
-#  sub print_usage {
-#      print STDERR "\nUsage: plugin W3ImgPlug [options]\n\n";
-#      print STDERR "  options:\n";
-#      print STDERR "   -aggressiveness     Range of related text extraction techniques to use [4]\n";
-#      print STDERR "                        1: Filename, path, ALT text only\n";
-#      print STDERR "                        2: All of 1, plus caption where available\n";
-#      print STDERR "                        3: All of 2, plus near paragraphs where available\n";
-#      print STDERR "                        4: All of 3, plus previous headers (<h1>, <h2>...)\n";
-#      print STDERR "                           where available\n";
-#      print STDERR "                        5: All of 4, plus textual references where available\n";
-#      print STDERR "                        6: All of 4, plus page metatags (title, keywords, etc)\n";
-#      print STDERR "                        7: All of 6, 5 and 4 combined\n";
-#      print STDERR "                        8: All of 7, plus repeat caption, filename, etc (raise \n";
-#      print STDERR "                           ranking of more relevant results)\n";
-#      print STDERR "                        10: All of 1, plus full text of source page\n";
-#      print STDERR "\n";
-#      print STDERR "   -no_cache_images    Don't cache images (point to URL of original)\n";
-#      print STDERR "   -index_pages        Index the pages along with the images.\n";
-#      print STDERR "                       Otherwise reference the pages at the source URL\n";
-#      print STDERR "   -min_size           Bytes. Skip images smaller than this [2000]\n";
-#      print STDERR "   -min_width          Pixels. Skip images narrower than this [50 pixels]\n";
-#      print STDERR "   -min_height         Pixels. Skip images shorter than this [50 pixels]\n";
-#      print STDERR "   -thumb_size         Max thumbnail size. Both width and height [100 pixels]\n";
-#      print STDERR "   -convert_params     Additional parameters for ImageMagicK convert on\n";
-#      print STDERR "                       thumbnail creation. For example, '-raise' will give\n";
-#      print STDERR "                       a three dimensional effect to thumbnail images.\n";
-#      print STDERR "   -document_text      Add image text as document:text (otherwise IndexedText\n";
-#      print STDERR "                       metadata field)\n";
-#      print STDERR "\n";
-#      print STDERR " Advanced Options (applicability depends on aggressiveness level)\n";
-#      print STDERR "   -smallpage_threshold Images on pages smaller than this (bytes) will have\n";
-#      print STDERR "                        the page (title, keywords, etc) meta-data added [2048]\n";
-#      print STDERR "   -textrefs_threshold  Threshold for textual references. Lower values mean\n";
-#      print STDERR "                        the algorithm is less strict [2]\n";
-#      print STDERR "   -caption_length      Maximum length of captions (in characters) [100]\n";
-#      print STDERR "   -neartext_length     Target length of near text (in characters) [300]\n";
-#      print STDERR "   -max_near_text       Maximum characters near images to extract [400]\n";
-#      print STDERR "   -min_near_text       Minimum characters of near text or caption to extract [10]\n";
-#      print STDERR "\n";
-#      print STDERR " Tag set configuration file (XML format):\n";
-#      print STDERR "   <collectionpath>/etc/W3ImgPlug.cfg \n";
-#      print STDERR "\n";
-#      print STDERR "\n";
-#      print STDERR "W3ImgPlug inherits all of HTMLPlug's functionality and options:\n";
-#      HTMLPlug::print_usage();
-#      print STDERR "\n";
-#  }
 
 sub new {