EPScript/Data Types

From EPrints Documentation
Revision as of 11:33, 4 October 2006 by Moj (talk | contribs)
Jump to: navigation, search

EPScript

Template:Devel

Data Types

Strings and characters

These are contained within either double quotes ("") or single quotes (''). There is no difference between the two, but it may be easier to use one sort when inside an XML attribute. For example:


<when test="type = 'patent'">
...
</when>


Numbers

Logical Operators

and

Returns true if both the left-hand and the right-hand expressions return true.


<if test="type = 'book' and is_set( creators )">
...
</if>


or

Returns true if at least one of the expressions returns true.


<if test="type = 'book' or type = 'patent'">
...
</if>


not

Returns true if the expression is false and false if the expression is true.


<if !is_set( creators )">
...
</if>


Comparison Operators

lt

<if test="length(editors) lt 6">
...
</if>


gt

<if test="length(editors) gt 1">
...
</if>


equals

<if test="type = 'patent'">
...
</if>


Control Structures

if

Inserts the content of the <if> element if the EPScript in the test attribute returns true.


<if test="date_effective">(<print expr="date_effective" opts="res=year" />)</if>


choose/when/otherwise

A <choose> element consists of one or many <when> elements and an optional <otherwise> element. The test attribute of each <when> element is evaluated, and if this returns true the content is included and execution leaves the <choose> structure. If no test attribute returns true and an <otherwise> element is provided, the content of the <otherwise> element is included.


<choose>
  <when test="title"><print expr="title" /></ep:when>
  <otherwise><print expr="type" /> #<print expr="eprintid" /></otherwise>
</choose>


Procedures

print

Outputs the result of the provided expression attribute as a string. If the result is boolean, TRUE or FALSE will be produced.


<print expr="isbn" />


phrase

Outputs the phrase given in the ref attribute. To provide values for pins in the phrases, the param element is used, with the name attribute giving the pin name and the element content the value to pass.


<phrase ref="my_phrase"><param name="my_pin">Pin Value</param></phrase>