EPScript/Functions - Revision history

Drn@ecs.soton.ac.uk: /* dumper (3.4.4+) */

2022-03-16T01:42:59Z

‎dumper (3.4.4+)

2022-03-16T01:41:40Z

Amended syntax for to_dataobj

2022-03-16T01:39:13Z

make clear subproperty only works for non-multiple fields

2022-03-15T23:19:06Z

Changed to give relevant and useful example

2022-03-15T21:50:14Z

Added dumper render function for

2022-03-15T21:43:59Z

Adds subproperty and to_dataobj functions

2022-02-21T02:22:35Z

Added format template

2022-02-21T01:39:46Z

Added all functions in EPrints::Script::Compiled

2022-02-20T18:09:16Z

Added some more functions

2022-02-20T14:50:13Z

Switched back to basic navigatiom template

@@ Line 307: / Line 307: @@
 === dumper (3.4.4+) ===
-Renders an XHTML pre element containing the type and serialization of a variable/metafield.  Useful for debugging workflow/citation issues.
+Renders an XHTML pre element containing the type and serialization of a variable/metafield.  Useful for debugging workflow/citation issues.  Not particularly useful for data objects as dump will be too big to be rendered.
 {{codesample|<pre>
   <print expr="creators.dumper" />

@@ Line 208: / Line 208: @@
 === to_dataobj (3.4.4+) ===
 Will take the variable specified and will lookup this against the DataObj type specified using the particular field specified.  E.g.
-  &lt;epc:print expr=&quot;userid.to_dataobj( &apos;user&apos;, &apos;userid&apos; ).username&quot;/&gt;
+  &lt;epc:print expr=&quot;userid.to_dataobj( &apos;user&apos;, &apos;userid&apos; ).property( &apos;username&apos; )&quot;/&gt;
-Will print the username of the user who is owner of the ePrint.  Where the first ''userid'' is the field in the EPrint DataObj, ''user'' is the dataset ID you want to lookup against and the second ''userid'' is the field in the User DataObj you want lookup against.
+Will print the username of the user who is owner of the eprint.  Where the first ''userid'' is the field in the EPrint DataObj, ''user'' is the dataset ID you want to lookup against and the second ''userid'' is the field in the User DataObj you want lookup against.  The property function is then used to get the value for ''username'' from the retrieved user DataObj.
 === uri ===
 Returns the control URI of a particular data object. (i.e. ''/id/<DATASET>/<ID>/'', e.g. ''/id/eprint/1234/'')

@@ Line 202: / Line 202: @@
 === subproperty (3.4.4+) ===
-When you have a compound field and want to print out just a sub-property of this field.  E.g.
+When you have a compound (non-multiple) field and want to print out just a sub-property of this field.  E.g.
    &lt;print expr=&quot;compoundfield.subproperty( &apos;subfield2&apos; )&quot;/&gt;
 Will print ''field2'' of the field named ''compoundfield''.  This currently only works for non-multiple compound fields.

@@ Line 306: / Line 306: @@
 === dumper (3.4.4+) ===
-Renders an XHTML pre element containing the type and serialization of the data object.  Useful for debugging workflow/citation issues.
+Renders an XHTML pre element containing the type and serialization of a variable/metafield.  Useful for debugging workflow/citation issues.
 {{codesample|<pre>
-  <print expr="$item.dumper" />
+  <print expr="creators.dumper" />
 </pre>}}

@@ Line 303: / Line 303: @@
 {{codesample|<pre>
   <print expr="$item.citation_link('default')" />
 </pre>}}

← Older revision		Revision as of 14:50, 20 February 2022
Line 1:		Line 1:
−	{{~~Navigate\|Section=~~EPScript~~\|Prev=Operators\|Curr=Functions\|Next=XML Syntax~~}}	+	{{EPScript}}

	= Functions =		= Functions =