Changeset 27261

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.

Location:

main/trunk/greenstone2/perllib/cgiactions

Files:

• baseaction.pm (modified) (4 diffs)
• metadataaction.pm (modified) (1 diff)

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;

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

@@ -90 +90 @@
     "set-metadata-array" => { 
         'compulsory-args' => [ "where", "json" ],
-        'optional-args'   => [ ] },
+        'optional-args'   => [ ],
+        'help-string' => [
+        'A simple example: metadata-server.pl?a=set-metadata-array&where=archives|index|import&c=demo&json=[{"docid":"HASHc5bce2d6d3e5b04e470ec9","metaname":"Title","metavalue":"Tralalala","metamode":"accumulate"},{"docid":"HASHbe483fa4df4e096335d1c8","metaname":"Title","metavalue":"Lala was here","metapos":0, "metamode":"override"}]', 
+        
+        'A more complex example: metadata-server.pl?a=set-metadata-array&where=archives|index&c=demo&json=[{"docid":"HASHc5bce2d6d3e5b04e470ec9.1","metatable":[{"metaname":"Title","metavals":["Transformers","Robots in disguise","Autobots"]}],"metamode":"override"},{"docid":"HASHbe483fa4df4e096335d1c8.2","metaname":"Title","metavalue":"Pinky was here","metamode":"accumulate"}]' ] },
+
+# The same examples rewritten for when running the metadata-server.pl script from the commandline:
+
+# the simple example: metadata-server.pl a="set-metadata-array" where="archives|index|import" c="demo" json="[{\"docid\":\"HASHc5bce2d6d3e5b04e470ec9\",\"metaname\":\"Title\",\"metavalue\":\"Tralalala\",\"metamode\":\"accumulate\"},{\"docid\":\"HASHbe483fa4df4e096335d1c8\",\"metaname\":\"Title\",\"metavalue\":\"Lala was here\",\"metapos\":0, \"metamode\":\"override\"}]",
+        
+# the more complex example: metadata-server.pl a="set-metadata-array" where="archives|index" c="demo" json="[{\"docid\":\"HASHc5bce2d6d3e5b04e470ec9.1\",\"metatable\":[{\"metaname\":\"Title\",\"metavals\":[\"Transformers\",\"Robots in disguise\",\"Autobots\"]}],\"metamode\":\"override\"},{\"docid\":\"HASHbe483fa4df4e096335d1c8.2\",\"metaname\":\"Title\",\"metavalue\":\"Pinky was here\",\"metamode\":\"accumulate\"}]"
                      
     "set-archives-metadata-array" => {