]> matita.cs.unibo.it Git - helm.git/blobdiff - helm/uwobo/uwobo_common.ml
ocaml 3.09 transition
[helm.git] / helm / uwobo / uwobo_common.ml
index 87a640b4306d156753c0df050ba71a511360acfc..8952f8132c11954a5ce54d468d60e4f3cd2fcde3 100644 (file)
@@ -48,11 +48,11 @@ let supported_properties = [
 
 let is_supported_property name = List.mem name supported_properties
 
-let version = "0.2.1" ;;
+let version = "0.3.0" ;;
 
 let usage_string =
   sprintf
-"
+    "
 <html>
   <head>
     <title>UWOBO's help message</title>
@@ -70,7 +70,7 @@ let usage_string =
     </p>
     <p>
       <b><kbd>help</kbd></b><br />
-      display this help message
+      displays this help message
     </p>
     <p>
       <b><kbd>newsession?port=p</kbd></b><br />
@@ -82,7 +82,7 @@ let usage_string =
     </p>
     <p>
       <b><kbd>add?bind=key,uri[&bind=key,uri[&...]]</kbd></b><br />
-      load a new stylesheet, specified by <em>uri</em>, and bind it to key
+      loads a new stylesheet, specified by <em>uri</em>, and bind it to key
           <em>key</em>
     </p>
     <p>
@@ -92,16 +92,16 @@ let usage_string =
     </p>
     <p>
       <b><kbd>reload?keys=[key1,key2,...]</kbd></b><br />
-      reload stylesheets specified by <em>key1, key2, ...</em> or all
-          stylesheets if no key was given
+      reloads the stylesheets specified by <em>key1, key2, ...</em>. Reloads all
+          the stylesheets if no key was given
     </p>
     <p>
       <b><kbd>list</kbd></b><br />
-      return a list of loaded stylesheets
+      returns the list of loaded stylesheets
     </p>
     <p>
       <b><kbd>apply?xmluri=uri&keys=key1,key2,...[&errormode={ignore|comment|embed}][&debugmode={ignore|comment|embed}][&profile=id][&password=password][&param.name=value[&param.name=value[&...]]][&param.key.name=value[&param.key.name=value[&...]]][&prop.name[=value][&prop.name[=value][&...]]]</kbd></b><br />
-      apply a chain of stylesheets, specified by <em>key1, key2, ...</em>, to an
+      applies a chain of stylesheets, specified by <em>key1, key2, ...</em>, to an
       input document, specified by <em>uri</em>.<br />
       Error and debugging modes could be ste to three different values.
       <em>ignore</em> means that LibXSLT messages are ignored; <em>comment</em>
@@ -119,50 +119,50 @@ let usage_string =
       have lower precedence with respect to those provided in the URL. A
       <em>password</em> for the profile must be provided if the read permission
       of the profile is set to false.<br />
-      Properties of the final chain output can be set too: valueless properties
+      Properties of the final chain output can be set as well: valueless properties
       can be set using <em>prop.name</em> syntax, others can be set using
       <em>prop.name=value</em> syntax.<br />
       Current supported properties are: %s.
     </p>
     <p>
       <b><kbd>listprofiles</kbd></b><br />
-      return the list of profiles available
+      returns the list of profiles available
     </p>
     <p>
-      <b><kbd>createprofile?[id=id][&orig=orig][&origpassword=origpassword][&readperm={true|false}][&writeperm={true|false}][&adminperm={true|false}][&password=password]</kbd></b><br />
+      <b><kbd>createprofile?[id=id][&orig=orig][&origpassword=origpassword][&readperm={public|private}][&writeperm={public|private}][&adminperm={public|private}][&password=password]</kbd></b><br />
       creates a new profile. The id of the created profile is <em>id</em> (if provided); otherwise it is a fresh id.
       The parameters are inherited from the profile <em>orig</em>, if provided. <em>origpassword</em> is the password of the
-      profile being copied in case the read permission of that profile is set to false. The defaults for
-      <em>password</em> and <em>readper,writeperm,adminperm</em> are respectively true, true, true and no password.
+      profile being copied in case the read permission of that profile is set to false. The default for
+      <em>password</em> is no password, the defaults for <em>readper,writeperm,adminperm</em> are public, public, public.
     </p>
     <p>
       <b><kbd>removeprofile?id=id[&password=password]</kbd></b><br />
-      completely removes the profile <em>id</em>. The password is required if the profile administrative permission
+      removes the profile <em>id</em>. The password is required if the profile administrative permission
       is set to false.
     </p>
     <p>
       <b><kbd>setparam?id=id[&password=password]&key=key[&value=value]</kbd></b><br />
-      sets the property <em>key</em> to <em>value</em>, if <em>value</em> is provided; otherwise
+      sets the parameter <em>key</em> to <em>value</em>, if <em>value</em> is provided; otherwise
       the parameter is unset. The password is required if the profile writing permission is set to
       false.
     </p>
     <p>
       <b><kbd>setpassword?id=id[&oldpassword=oldpassword][&password=password]</kbd></b><br />
-      changes or unset the password. The old password is required if it was set.
+      changes or unset the password for a profile. The old password is required if it was set.
     </p>
     <p>
-      <b><kbd>setpermission?id=id[&password=password]&permission={read|write|admin}&value={true|false}</kbd></b><br />
+      <b><kbd>setpermission?id=id[&password=password]&permission={read|write|admin}&value={public|private}</kbd></b><br />
       changes the permission <em>permission</em>. The password is required if the administrative permission
       is set to false.
     </p>
     <p>
       <b><kbd>getparams?id=id[&password=password]</kbd></b><br />
-      returns all the params of the profile <em>id</em>. The password is required if the read permission
+      returns all the parameters of the profile <em>id</em>. The password is required if the read permission
       is set to false.
     </p>
     <p>
       <b><kbd>getparam?id=id[&password=password]&key=key</kbd></b><br />
-      returns the value of the param <em>key</em> of the profile <em>id</em>. The password is required if the read permission
+      returns the value of the parameter <em>key</em> of the profile <em>id</em>. The password is required if the read permission
       is set to false.
     </p>
     <p>
@@ -173,8 +173,8 @@ let usage_string =
   </body>
 </html>
 "
-  version version
-  (String.concat ", " supported_properties) (* supported properties *)
+    version version
+    (String.concat ", " supported_properties) (* supported properties *)
 ;;
 
 let pp_error =