Changeset 27261 for main/trunk/greenstone2/perllib/cgiactions/baseaction.pm

Timestamp:

2013-04-26T18:30:12+12:00 (11 years ago)

Author:

ak19

Message:

Adding in 2 basic JSON examples for the metadata-server.pl help/usage string that can be pasted in the browser. Still to add help strings for other metadata-server actions that take a JSON parameter.

File:

• main/trunk/greenstone2/perllib/cgiactions/baseaction.pm (modified) (4 diffs)

main/trunk/greenstone2/perllib/cgiactions/baseaction.pm

@@ -87 +87 @@
         $err_mess .= "\n";
         }
+
+        my @help_examples = ();
+        if(defined $action_table->{$a}->{'help-string'}) {
+        push(@help_examples, @{$action_table->{$a}->{'help-string'}});
+        }
+        if (scalar(@help_examples)>0) {
+
+        if (scalar(@help_examples)>1) {
+            $err_mess .= "    Example(s)  :\n";
+        } else {
+            $err_mess .= "    Example  :\n";
+        }
+        $err_mess .= join(", \n\n", @help_examples);
+        $err_mess .= "\n\nTo be strictly CGI-compliant special chars like double-quotes,&,?,<,> must be URL encoded.\n";
+        }
+
         $err_mess .= "\n";
     }
@@ -203 +219 @@
 
 
-
-
 sub authenticate_user
 {
@@ -449 +463 @@
 
 
-
-
 sub run_script
 {
@@ -493 +505 @@
 }
 
-
-
-
 1;