EPScript/XML Syntax

From EPrints Documentation
Revision as of 02:23, 21 February 2022 by Drn@ecs.soton.ac.uk (talk | contribs) (Added formats template)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


XML Configuration: EPScript - Control Format (EPC) - Citation - Workflow - Phrase - Template - XPAGE (static pages)


EPScript

XML Syntax

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>