Changeset 3540 for trunk/gsdl/perllib/plugins/TEXTPlug.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/plugins/TEXTPlug.pm (modified) (4 diffs)

trunk/gsdl/perllib/plugins/TEXTPlug.pm

@@ -27 +27 @@
 # of first line of text (up to 100 characters long).
 
+# 12/05/02 Added usage datastructure - John Thompson
+
 package TEXTPlug;
 
@@ -36 +38 @@
     @ISA = ('BasPlug');
 }
+
+my $arguments = [ { 'name' => "process_exp",
+                          'desc' => "A perl regular expression to match against filenames. Matching filenames will be processed by this plugin. Each plugin has its own default process_exp. e.g HTMLPlug defaults to '(?i)\.html?\$' i.e. all documents ending in .htm or .html (case-insensitive).",
+                          'type' => "string",
+                          'deft' => q^(?i)\.te?xt$^,
+                          'reqd' => "no" } ,
+                        { 'name' => "title_sub",
+                          'desc' => "Substitution expression to modify string stored as Title. Used by, for example, PSPlug to remove \"Page 1\" etc from text used as the title.",
+                          'type' => "string",
+                          'reqd' => "no" }];
+
+my $options = { 'name'     => "TEXTPlug",
+                 'desc'     => "Creates simple single-level document. Adds Title metadata of first line of text (up to 100 characters long).",
+                     'inherits' => "yes",
+                     'args'     => $arguments };
 
 sub print_usage {
@@ -50 +67 @@
     my ($class) = @_;
     my $self = new BasPlug ($class, @_);
+
+     # 14-05-02 To allow for proper inheritance of arguments - John Thompson
+     my $option_list = $self->{'option_list'};
+     push( @{$option_list}, $options );
 
     if (!parsargv::parse(\@_, 
@@ -87 +108 @@
     $title =~ /^\s+/s;
     if (defined $self->{'title_sub'} &&
-        $self->{'title_sub'}) {$title =~ s/$self->{'title_sub'}//;}
+           $self->{'title_sub'}) {$title =~ s/$self->{'title_sub'}//;}
     $title =~ /^\s*([^\n]*)/s; $title=$1;
     if (length($title) > 100) {