Changeset 4873 for trunk/gsdl/perllib/plugins/ImagePlug.pm

Timestamp:

2003-07-03T15:59:04+12:00 (21 years ago)

Author:

mdewsnip

Message:

Further work on standardising option descriptions. Specifically, in preparation for translating the option descriptions into other languages, all the option description strings have been moved in a "resource bundle" file (modelled on a Java resource bundle). (This also has the advantage of reducing the number of duplicate descriptions). The option descriptions in the plugins, classifiers, mkcol.pl, import.pl and buildcol.pl have been replaced with keys into this resource bundle (perllib/strings.rb). When translating the strings in this file into a new language, the new resource bundle should be named strings_<language-code>.rb (where <language-code> is a combination of language and country, eg. 'fr_FR' for the version of French spoken in France).

To support these changes, the PrintUsage module (perllib/printusage.pm) has new code for reading resource bundles and displaying the correct strings. Also, pluginfo.pl, classinfo.pl, mkcol.pl, import.pl and buildcol.pl have a new option (-language) for specifying the language code to display option descriptions in.

If a resource bundle for the specified language code does not exist, a generic resource bundle is used (strings.rb). This currently contains the English text descriptions. However, for users who always use Greenstone in another language, it would be easier to rename the standard file to strings_en_US.rb and rename the resource bundle of their desired language to strings.rb. This would mean they would not have to constantly specify their language with the -language option, since the default resource bundle will suit them.

Currently, the encoding names (in encodings.pm) are not part of this scheme. These are displayed as part of BasPlug's input_encoding option. It is debatable whether these names would be worth translating into other languages.

Parse errors in plugins and classifiers currently cause them to display the usage information using the default resource bundle. It is likely that BasPlug will soon have an option added to specify the language for the usage information in this case. (Note that this does not include using pluginfo.pl or classinfo.pl to display usage information - these have a -language option).

File:

• trunk/gsdl/perllib/plugins/ImagePlug.pm (modified) (2 diffs)

trunk/gsdl/perllib/plugins/ImagePlug.pm

@@ -34 +34 @@
 my $arguments =
     [ { 'name' => "process_exp",
-    'desc' => "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).",
+    'desc' => "{BasPlug.process_exp}",
     'type' => "string",
     'deft' => &get_default_process_exp(),
     'reqd' => "no" },
       { 'name' => "noscaleup",
-    'desc' => "Don't scale up small images when making thumbnails.",
+    'desc' => "{ImagePlug.noscaleup}",
     'type' => "flag",
     'reqd' => "no" },
       { 'name' => "thumbnailsize",
-    'desc' => "Make thumbnails of size nxn.",
+    'desc' => "{ImagePlug.thumbnailsize}",
     'type' => "int",
     'deft' => "100",
     'reqd' => "no" },
       { 'name' => "thumbnailtype",
-    'desc' => "Make thumbnails in format 's'.",
+    'desc' => "{ImagePlug.thumbnailtype}",
     'type' => "string",
     'deft' => "gif",
     'reqd' => "no" },
       { 'name' => "screenviewsize",
-    'desc' => "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.",
+    'desc' => "{ImagePlug.screenviewsize}",
     'type' => "int",
     'deft' => "0",
     'reqd' => "no" },
       { 'name' => "screenviewtype",
-    'desc' => "If -screenviewsize is set, this sets the screen display image type.",
+    'desc' => "{ImagePlug.screenviewtype}",
     'type' => "string",
     'deft' => "jpg",
     'reqd' => "no" },
       { 'name' => "converttotype",
-    'desc' => "Convert main image to.",
+    'desc' => "{ImagePlug.converttotype}",
     'type' => "string",
     'deft' => "",
     'reqd' => "no" },
       { 'name' => "minimumsize",
-    'desc' => "Ignore images smaller than n bytes.",
+    'desc' => "{ImagePlug.minimumsize}",
     'type' => "int",
     'deft' => "100",
@@ -127 +127 @@
     print STDERR "\nImagePlug uses an incorrect option.\n";
     print STDERR "Check your collect.cfg configuration file.\n";
-    $self->print_txt_usage();
+    $self->print_txt_usage("");  # Use default resource bundle
     die "\n";
     }