Changeset 5645

Timestamp:

2003-10-16T10:12:56+13:00 (21 years ago)

Author:

mdewsnip

Message:

Moved classifier descriptions into the resource bundle (perllib/strings.rb).

Location:

trunk/gsdl/perllib/classify

Files:

• AZList.pm (modified) (2 diffs)
• AZSectionList.pm (modified) (1 diff)
• BasClas.pm (modified) (7 diffs)
• Browse.pm (modified) (1 diff)
• DateList.pm (modified) (1 diff)
• HTML.pm (modified) (1 diff)
• Hierarchy.pm (modified) (1 diff)
• List.pm (modified) (2 diffs)
• Phind.pm (modified) (1 diff)
• SectionList.pm (modified) (1 diff)

trunk/gsdl/perllib/classify/AZList.pm

@@ -52 +52 @@
     'reqd' => "no" } ,
       { 'name' => "removesuffix",
-    'desc' => "A suffix to ignore in the Metadata values for the field when sorting.",
+    'desc' => "{AZList.removesuffix}",
     'type' => "string",
     'deft' => "",
@@ -59 +59 @@
 
 my $options = { 'name'     => "AZList",
-        'desc'     => "Classifier plugin for sorting alphabetically",
+        'desc'     => "{AZList.desc}",
         'inherits' => "Yes",
         'args'     => $arguments };

trunk/gsdl/perllib/classify/AZSectionList.pm

@@ -57 +57 @@
 
 my $options = { 'name'     => "AZSectionList",
-        'desc'     => "Classifier plugin for sorting alphabetically. This is very similar to AZList except it sorts by section level metadata (excluding the top level) instead of just top level metadata. The only change is to the classify() subroutine which must now iterate through each section, adding each to the classification.",
+        'desc'     => "{AZSectionList.desc}",
         'inherits' => "Yes",
         'args'     => $arguments };

trunk/gsdl/perllib/classify/BasClas.pm

@@ -53 +53 @@
 
 use parsargv;
+use gsprintf;
 use printusage;
 
@@ -72 +73 @@
 
 my $options = { 'name'     => "BasClas",
-        'desc'     => "Base class for all the classifiers.",
+        'desc'     => "{BasClas.desc}",
         'inherits' => "No",
         'args'     => $arguments };
+
+
+sub gsprintf
+{
+    return &gsprintf::gsprintf(@_);
+}
 
 
@@ -168 +175 @@
     # Produce the usage information using the data structure above
     if ($isleafclass) {
-    print STDERR " usage: classify $classifiername [options]\n\n";
+    &gsprintf(STDERR, " {common.usage}: classify $classifiername [{common.options}]\n\n");
+    # print STDERR " usage: classify $classifiername [options]\n\n";
     }
 
@@ -177 +185 @@
 
     if ($isleafclass) {
-        print STDERR " specific options:\n";
+        &gsprintf(STDERR, " {common.specific_options}:\n");
+        # print STDERR " specific options:\n";
     }
     else {
-        print STDERR " general options (from $classifiername):\n";
+        &gsprintf(STDERR, " {common.general_options}:\n", $classifiername);
+        # print STDERR " general options (from $classifiername):\n";
     }
 
@@ -227 +237 @@
              q^verbosity/\d/2^, \$self->{'verbosity'},
              "allow_extra_options")) {
-    
-    print STDERR "\nThe $name classifier uses an incorrect general option\n";
-    print STDERR "(general options are those available to all classifiers).\n";
-    print STDERR "Check your collect.cfg configuration file.\n";
+
+    &gsprintf(STDERR, "\n{BasClas.bad_general_option}\n", $name);
+    # print STDERR "\nThe $name classifier uses an incorrect general option\n";
+    # print STDERR "(general options are those available to all classifiers).\n";
+    # print STDERR "Check your collect.cfg configuration file.\n";
     $self->print_txt_usage("");  # Use default resource bundle
     die "\n";
@@ -247 +258 @@
 
     my $outhandle = $self->{'outhandle'};
-    print $outhandle "BasClas::classify function must be implemented in sub-class\n";
+    &gsprintf($outhandle, "BasClass::classify {common.must_be_implemented}\n");
+    # print $outhandle "BasClas::classify function must be implemented in sub-class\n";
 }
 
@@ -254 +266 @@
 
     my $outhandle = $self->{'outhandle'};
-    print $outhandle "BasClas::classify function must be implemented in sub-class\n";
+    &gsprintf($outhandle, "BasClass::get_classify_info {common.must_be_implemented}\n");
+    # print $outhandle "BasClas::get_classify_info function must be implemented in sub-class\n";
 }
 

trunk/gsdl/perllib/classify/Browse.pm

@@ -36 +36 @@
 
 my $options = { 'name'     => "Browse",
-        'desc'     => "",
+        'desc'     => "{Browse.desc}",
         'inherits' => "Yes" };
 

trunk/gsdl/perllib/classify/DateList.pm

@@ -74 +74 @@
 
 my $options = { 'name'     => "DateList",
-        'desc'     => "Classifier plugin for sorting by date. By default, sorts by 'Date' metadata. Date is assumed to be in the form yyyymmdd.",
+        'desc'     => "{DateList.desc}",
         'inherits' => "Yes",
         'args'     => $arguments };

trunk/gsdl/perllib/classify/HTML.pm

@@ -53 +53 @@
 
 my $options = { 'name'     => "HTML",
-        'desc'     => "Creates an empty classification that's simply a link to a web page.",
+        'desc'     => "{HTML.desc}",
         'inherits' => "Yes",
         'args'     => $arguments };

trunk/gsdl/perllib/classify/Hierarchy.pm

@@ -82 +82 @@
 my $options = 
 {   'name'     => "Hierarchy",
-    'desc'     => "Classifier plugin for generating hierarchical classifications",
+    'desc'     => "{Hierarchy.desc}",
     'inherits' => "Yes" , 
     'args'     => $arguments };

trunk/gsdl/perllib/classify/List.pm

@@ -66 +66 @@
 
 my $options = { 'name'     => "List",
-        'desc'     => "Simple list classifier plugin.",
+        'desc'     => "{List.desc}",
         'inherits' => "Yes",
         'args'     => $arguments };
@@ -223 +223 @@
 
     # organise into classification structure
+    print STDERR "List::get_classify_info::title = " . $self->{'title'} . "\n";
     my %classifyinfo = ('childtype'=>'VList',
             'Title'=>$self->{'title'},

trunk/gsdl/perllib/classify/Phind.pm

@@ -129 +129 @@
 
 my $options = { 'name'     => "Phind",
-        'desc'     => "The Phind clasifier plugin.",
+        'desc'     => "{Phind.desc}",
         'inherits' => "Yes",
         'args'     => $arguments };

trunk/gsdl/perllib/classify/SectionList.pm

@@ -40 +40 @@
 
 my $options = { 'name'     => "SectionList",
-        'desc'     => "Same as List classifier but includes all sections of document (excluding top level) rather than just top level document itself.",
+        'desc'     => "{SectionList.desc}",
         'inherits' => "Yes" };