Changeset 3540 for trunk/gsdl/perllib/classify/List.pm

Timestamp:

2002-11-18T17:43:56+13:00 (21 years ago)

Author:

kjdon

Message:

added John T's changes into CVS - added info to enable retrieval of usage info in xml

File:

• trunk/gsdl/perllib/classify/List.pm (modified) (3 diffs)

trunk/gsdl/perllib/classify/List.pm

@@ -38 +38 @@
 #                      if metadata is also not included title will be 'List'
 
+# 12/05/02 Added usage datastructure - John Thompson
+
 use BasClas;
 package List;
@@ -46 +48 @@
     @ISA = ('BasClas');
 }
+
+my $arguments = 
+[ {     'name' => "metadata",
+    'desc' => "Metadata field used for classification. List will be sorted by this element.",
+    'type' => "metadata",
+    'reqd' => "yes" } ,
+{   'name' => "buttonname",
+    'desc' => "Button name for this classification. Defaults to metadata name.",
+    'type' => "string",
+    'reqd' => "no" } ,
+{   'name' => "sort",
+    'desc' => "Sort documents in list by this metadata field. By default it will sort by Metaname, or (if this is not set) in build (random) order.",
+    'type' => "string",
+    'reqd' => "no" } 
+];
+
+my $options = 
+{   'name'     => "List",
+    'desc'     => "Simple list classifier plugin.",
+    'inherits' => "Yes",
+    'args'     => $arguments };
+
 
 sub print_usage {
@@ -67 +91 @@
     my $class = shift (@_);
     my $self = new BasClas($class, @_);
+
+     # 14-05-02 To allow for proper inheritance of arguments - John Thompson
+     my $option_list = $self->{'option_list'};
+     push( @{$option_list}, $options );
     
     my ($metaname, $title, $sortname, $list);