EPrints Control Format - Revision history

Libjlrs: /* epc:list (3.3.17+ and 3.4.2+) */

2025-08-05T09:23:25Z

‎epc:list (3.3.17+ and 3.4.2+)

Drn@ecs.soton.ac.uk: subproperty and to_dataobj should be added elsewhere

2019-04-24T16:29:48Z

subproperty and to_dataobj should be added elsewhere

Drn@ecs.soton.ac.uk: Added new EPC stuff for 3.3.17 and 3.4.2

2019-04-24T16:25:12Z

Added new EPC stuff for 3.3.17 and 3.4.2

Libjlrs@leeds.ac.uk: Added epc:comment; added source blocks around code sections

2012-10-15T14:33:02Z

Added epc:comment; added source blocks around code sections

Denics@free.fr: /* $index (3.2.0+) */

2012-03-23T14:16:19Z

‎$index (3.2.0+)

Cjg: /* limit (3.2.0+) */

2010-05-18T17:34:33Z

‎limit (3.2.0+)

Cjg: /* limit */

2010-05-18T17:21:52Z

‎limit

Cjg: /* $index (3.2.0+) */

2010-05-18T17:21:43Z

‎$index (3.2.0+)

Cjg: /* $index (3.2.0+) */

2010-05-18T17:19:06Z

‎$index (3.2.0+)

Cjg: /* $index (3.2.0+) */

2010-05-18T17:18:27Z

‎$index (3.2.0+)

@@ Line 145: / Line 145: @@
   &lt;epc:list prefix=&apos;[ &apos; suffix=&apos; ]&apos; join=&quot; | &quot;&gt;
-     &lt;epc:item&gt;First&lt;&lt;/epc:item&gt;
+     &lt;epc:item&gt;First&lt;/epc:item&gt;
      &lt;epc:item&gt; &lt;/epc:item&gt;
      &lt;epc:item&gt;Third&lt;/epc:item&gt;

← Older revision		Revision as of 16:29, 24 April 2019
Line 156:		Line 156:
	[ First \| Third \| Test Title \| UNSPECIFIED \| Sixth ]		[ First \| Third \| Test Title \| UNSPECIFIED \| Sixth ]

−	If the value inside the <epc:item> is empty or only contains whitespace (spaces, tabs, newlines and carriage returns) it will be ignored. If a variable is used that is not specified, such as patent_applicant, then this will still be displayed if the default value for an unspecified value is set (e.g. like UNSPECIFIED in the example above). To avoid this put an if test for the variable and the whole item will be ignored.	+	If the value inside the <epc:item> is empty or only contains whitespace (spaces, tabs, newlines and carriage returns) it will be ignored. If a variable is used that is not specified, such as patent_applicant, then this will still be displayed if the default value for an unspecified value is set (e.g. like UNSPECIFIED in the example above). To avoid this put an if test for the variable and the whole item will be ignored.
−
−
−	~~== epc:to_dataobj (3.3.17+ and 3.4.2+) ==~~
−	~~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.
−
−	~~== epc:subproperty (3.3.17+ and 3.4.2+) ==~~
−	~~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~~.

← Older revision		Revision as of 16:25, 24 April 2019
Line 140:		Line 140:
	<epc:set name='docs' expr='$item.documents()'>		<epc:set name='docs' expr='$item.documents()'>
	</source>		</source>
		+
		+	== epc:list (3.3.17+ and 3.4.2+) ==
		+	Allows multiple variables to be printed out with a common separator, where separator is not added if any variables are not set. Also allows a prefix and suffix to the list. E.g.
		+
		+	<epc:list prefix='[ ' suffix=' ]' join=" \| ">
		+	<epc:item>First<</epc:item>
		+	<epc:item> </epc:item>
		+	<epc:item>Third</epc:item>
		+	<epc:item><epc:print expr="title"/></epc:item>
		+	<epc:item><epc:print expr="patent_applicant"/></epc:item>
		+	<epc:item>Sixth</epc:item>
		+	</epc:list>
		+
		+	Produces:
		+	[ First \| Third \| Test Title \| UNSPECIFIED \| Sixth ]
		+
		+	If the value inside the <epc:item> is empty or only contains whitespace (spaces, tabs, newlines and carriage returns) it will be ignored. If a variable is used that is not specified, such as patent_applicant, then this will still be displayed if the default value for an unspecified value is set (e.g. like UNSPECIFIED in the example above). To avoid this put an if test for the variable and the whole item will be ignored.
		+
		+
		+	== epc:to_dataobj (3.3.17+ and 3.4.2+) ==
		+	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.
		+
		+	== epc:subproperty (3.3.17+ and 3.4.2+) ==
		+	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.

@@ Line 9: / Line 9: @@
   <epc:print expr='expression' opt='key=value;key2=value2'/>
+<source lang="xml">
-  &lt;cite:citation xmlns="http://www.w3.org/1999/xhtml"
+  <cite:citation xmlns="http://www.w3.org/1999/xhtml"
             xmlns:cite="http://eprints.org/ep3/citation"
-            xmlns:epc="http://eprints.org/ep3/control"&gt;
+            xmlns:epc="http://eprints.org/ep3/control">
-      &lt;epc:print expr="$item.citation('default')" /&gt;
+      <epc:print expr="$item.citation('default')" />
-  &lt;/cite:citation&gt;
+  </cite:citation>
+</source>
 Outputs the result of the expression in the 'expr' attribute.
@@ Line 27: / Line 27: @@
 So you can do something like
+<source lang="xml">
- <nowiki><a href="http://eprints.badger.edu/cgi/myscript.pl?eprintid={eprintid}">run myscript on this eprint</a></nowiki>
+<a href="http://eprints.badger.edu/cgi/myscript.pl?eprintid={eprintid}">run myscript on this eprint</a>
 === epc:phrase ===
 simple:
   <epc:phrase ref='phraseid' />
+</source>
 with pins:
   <epc:phrase ref='phraseid'>
     <epc:param name='somepin'>Content</epc:param>
   </epc:phrase>
+</source>
 Outputs the content of the phrase refered to by 'ref'. Any necessary parameters may be set using the <epc:param> tag, with the contents inserted into the pin with the name corresponding to the name attribute.
@@ Line 45: / Line 48: @@
 === epc:if ===
+<source lang="xml">
   <epc:if test='expr'>
   ...
   </epc:if>
+</source>
 Outputs any XHTML content and evaluates any EPrints Control structures within the epc:if block if the expression in the test attribute is true.
 === epc:choose, epc:when, epc:otherwise ===
+<source lang="xml">
   <epc:choose>
     <epc:when test='expr'>
@@ Line 65: / Line 68: @@
     </epc:otherwise>
   </epc:choose>
-epc:choose allows for the construction of a complex conditional. Each epc:when block's 'test' attribute is evaluated, and the content of the block is returned if the result is true. If no expressions return true, the optional epc:otherwise block is returned. Note that no subsequent epc:when blocks are evaluated once the first block to return true is reached.
+=== epc:comment ===
 == Loops ==
 Multiple values can be iterated over. For example.
+<source lang="xml">
    <epc:foreach expr="creators_name" iterator="name">
      ( <epc:print expr="$name" /> )
    </epc:foreach>
+</source>
 === $index (3.2.0+) ===
@@ Line 82: / Line 106: @@
 This can be used with the modulus "%" to add a strip effect, if wanted, eg.
-  <nowiki><table>
+<source lang="xml">
    <epc:foreach expr="creators_name" iterator="name">
      <epc:if test="$index % 2">
@@ Line 91: / Line 116: @@
      </epc:if>
    </epc:foreach>
-   </table></nowiki>
+   </table>
 === limit (3.2.0+) ===
 You can set a limit of how many iterations to process using a "limit" attribute on the epc:foreach element. For example,
+<source lang="xml">
    <epc:foreach expr="creators_name" iterator="name" limit="3">
+</source>
 == epc:debug (3.2.0+) ==
 The epc:debug element has identical syntax to epc:print, but the result is sent to the error log -- either the command line, or to the apache error log.
+<source lang="xml">
    <epc:debug expr='expression' opt='key=value;key2=value2'/>
 == epc:set (3.2.0+) ==
@@ Line 110: / Line 137: @@
 $item.documents() requires some database access, and the results are not cached, so using this speeds things up.
+<source lang="xml">
    <epc:set name='docs' expr='$item.documents()'>

@@ Line 84: / Line 84: @@
    <nowiki><table>
    <epc:foreach expr="creators_name" iterator="name">
-     <epc:if expr="$index % 2">
+     <epc:if test="$index % 2">
        <tr class='odd'><td><epc:print expr="$name" /></td></tr>
      </epc:if>
-     <epc:if expr="!($index % 2)">
+     <epc:if test="!($index % 2)">
        <tr class='even'><td><epc:print expr="$name" /></td></tr>
      </epc:if>

← Older revision		Revision as of 17:34, 18 May 2010
Line 98:		Line 98:

	<epc:foreach expr="creators_name" iterator="name" limit="3">		<epc:foreach expr="creators_name" iterator="name" limit="3">
		+
		+	== epc:debug (3.2.0+) ==
		+
		+	The epc:debug element has identical syntax to epc:print, but the result is sent to the error log -- either the command line, or to the apache error log.
		+
		+	<epc:debug expr='expression' opt='key=value;key2=value2'/>
		+
		+	== epc:set (3.2.0+) ==
		+
		+	This allows a variable to be set for any print or if elements within the epc:set. This is useful if creating the value has a notable cost which you wish to minimise.
		+
		+	$item.documents() requires some database access, and the results are not cached, so using this speeds things up.
		+
		+	<epc:set name='docs' expr='$item.documents()'>

← Older revision		Revision as of 17:21, 18 May 2010
Line 92:		Line 92:
	</epc:foreach>		</epc:foreach>
	</table></nowiki>		</table></nowiki>
		+
		+	=== limit ===
		+
		+	You can set a limit of how many iterations to process using a "limit" attribute on the epc:foreach element. For example,
		+
		+	<epc:foreach expr="creators_name" iterator="name" limit="3">

@@ Line 80: / Line 80: @@
 Within a foreach block you can use $index to find what iteration of the loop is on. The first value is zero.
-This can be used with the "%" to add a strip effect, if wanted, eg.
+This can be used with the modulus "%" to add a strip effect, if wanted, eg.
    <nowiki><table>