EPScript/Functions - Revision history

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

2022-03-16T01:42:59Z

dumper (3.4.4+)

← Older revision		Revision as of 01:42, 16 March 2022
Line 307:		Line 307:

	=== dumper (3.4.4+) ===		=== 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>		{{codesample\|<pre>
	<print expr="creators.dumper" />		<print expr="creators.dumper" />

2022-03-16T01:41:40Z

Amended syntax for to_dataobj

← Older revision		Revision as of 01:41, 16 March 2022
Line 208:		Line 208:
	=== to_dataobj (3.4.4+) ===		=== 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.		Will take the variable specified and will lookup this against the DataObj type specified using the particular field specified. E.g.
	<epc:print expr="userid.to_dataobj( 'user', 'userid' ).username"/>		<epc:print expr="userid.to_dataobj( 'user', 'userid' ).property( 'username' )"/>
	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 ===		=== uri ===
	Returns the control URI of a particular data object. (i.e. ''/id/<DATASET>/<ID>/'', e.g. ''/id/eprint/1234/'')		Returns the control URI of a particular data object. (i.e. ''/id/<DATASET>/<ID>/'', e.g. ''/id/eprint/1234/'')

2022-03-16T01:39:13Z

make clear subproperty only works for non-multiple fields

← Older revision		Revision as of 01:39, 16 March 2022
Line 202:		Line 202:

	=== subproperty (3.4.4+) ===		=== 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.
	<print expr="compoundfield.subproperty( 'subfield2' )"/>		<print expr="compoundfield.subproperty( 'subfield2' )"/>
	Will print ''field2'' of the field named ''compoundfield''. This currently only works for non-multiple compound fields.		Will print ''field2'' of the field named ''compoundfield''. This currently only works for non-multiple compound fields.

2022-03-15T23:19:06Z

Changed to give relevant and useful example

← Older revision		Revision as of 23:19, 15 March 2022
Line 306:		Line 306:

	=== dumper (3.4.4+) ===		=== 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>		{{codesample\|<pre>
	<print expr="~~$item~~.dumper" />		<print expr="creators.dumper" />
	</pre>}}		</pre>}}

2022-03-15T21:50:14Z

Added dumper render function for

← Older revision		Revision as of 21:50, 15 March 2022
Line 303:		Line 303:
	{{codesample\|<pre>		{{codesample\|<pre>
	<print expr="$item.citation_link('default')" />		<print expr="$item.citation_link('default')" />
			</pre>}}

			=== dumper (3.4.4+) ===
			Renders an XHTML pre element containing the type and serialization of the data object. Useful for debugging workflow/citation issues.
			{{codesample\|<pre>
			<print expr="$item.dumper" />
	</pre>}}		</pre>}}

2022-03-15T21:43:59Z

Adds subproperty and to_dataobj functions

← Older revision		Revision as of 21:43, 15 March 2022
Line 201:		Line 201:
	</pre>}}		</pre>}}

			=== subproperty (3.4.4+) ===
			When you have a compound field and want to print out just a sub-property of this field. E.g.
			<print expr="compoundfield.subproperty( 'subfield2' )"/>
			Will print ''field2'' of the field named ''compoundfield''. This currently only works for non-multiple compound fields.

			=== 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.
			<epc:print expr="userid.to_dataobj( 'user', 'userid' ).username"/>
			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.
	=== uri ===		=== uri ===
	Returns the control URI of a particular data object. (i.e. ''/id/<DATASET>/<ID>/'', e.g. ''/id/eprint/1234/'')		Returns the control URI of a particular data object. (i.e. ''/id/<DATASET>/<ID>/'', e.g. ''/id/eprint/1234/'')
Line 212:		Line 221:
	<a href="{$doc.url()}">Download</a>		<a href="{$doc.url()}">Download</a>
	</pre>}}		</pre>}}


	== EPrint Object Functions ==		== EPrint Object 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

← 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 =