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

Timestamp:

2002-11-18T17:43:56+13:00 (22 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/AZSectionList.pm (modified) (4 diffs)

trunk/gsdl/perllib/classify/AZSectionList.pm

@@ -34 +34 @@
 # to the classification
 
+# 12/05/02 Added usage datastructure - John Thompson
+
 package AZSectionList;
 
@@ -43 +45 @@
 }
 
+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" }
+];
+
+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.",
+    'inherits' => "Yes",
+    'args'     => $arguments };
+
 sub print_usage {
     print STDERR "
-  usage: classify AZSectionList -metadata X [options]
+  usage: classify AZSectionList [options]
   options:
 
-  -metadata X       (required) Metadata field used for classification.
-            List will be sorted by this element.
+  -metadata X    (required) Metadata field used for classification,
+                  list will be sorted by this element.
 
-  -buttonname X     Button name for this classification.
-            defaults to metadata name. 
+  -buttonname X  (OPTIONAL) Title field for this classification.
+                  if not included title field will be Metaname. 
 
-  -removeprefix regex   A prefix to ignore in the Metadata values
-            for the field when sorting.
-
+  -removeprefix regex A prefix to ignore in the Metadata values
+                      for the field when sorting.
 This is very similar to AZList except it sorts by section level metadata
 (excluding the top level) instead of just top level metadata.
@@ -65 +83 @@
     my $class = shift (@_);
     my $self = new AZList($class, @_);
+
+     # 14-05-02 To allow for proper inheritance of arguments - John Thompson
+     my $option_list = $self->{'option_list'};
+     push( @{$option_list}, $options );
 
     return bless $self, $class;
@@ -91 +113 @@
     # if this section doesn't contain the metadata element we're
     # sorting by we won't include it in this classification
+
     if (defined $metavalue && $metavalue ne "") {
     if ($self->{'removeprefix'}) {
         $metavalue =~ s/^$self->{'removeprefix'}//;
     }
-
     if ($self->{'metaname'} eq 'Creator') {
         &sorttools::format_string_name_english (\$metavalue);