Difference between revisions of "Workflow Format"

From EPrints Documentation
Jump to: navigation, search
m
(Conditional Overriding of Field Name and Help)
 
(17 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=66 lipitor online] [http://students.hsc.unt.edu/housing/item.cfm?type=2852 buy xanax] [http://students.hsc.unt.edu/housing/item.cfm?type=2892 rivotril online] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=95 kyocera ringtones] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=29 cialis online] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=74 cheap ultracet] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/levitra_8223.htm levitra] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30361 kyocera ringtones] [http://students.hsc.unt.edu/housing/item.cfm?type=2908 music ringtones] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=88 free free ringtones] [http://wc1.worldcrossing.com/WebX/.1de60a35 verizon ringtones] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=31 soma online] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=204 cheap ortho] [http://library.cshl.edu/wp/vb/member.php?u=1362 wellbutrin online] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30310 tenuate online] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=121 free real ringtones] [http://students.hsc.unt.edu/housing/item.cfm?type=2902 nextel ringtones] [http://library.cshl.edu/wp/vb/member.php?u=1356 cheap paxil] [http://students.hsc.unt.edu/housing/item.cfm?type=2905 motorola ringtones] [http://library.cshl.edu/wp/vb/member.php?u=1344 cheap xanax] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=798 order lipitor] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30355 free punk ringtones] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=87 free sony ericsson ringtones] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=118 cool ringtones] [http://students.hsc.unt.edu/housing/item.cfm?type=2913 free sonyericsson ringtones] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=5&tid=3735 mtv ringtones] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=63 order albuterol] [http://students.hsc.unt.edu/housing/item.cfm?type=2910 free polyphonic ringtones] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30298 order lisinopril] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=236 free tracfone ringtones] [http://students.hsc.unt.edu/housing/item.cfm?type=2877 cheap prozac] [http://wc1.worldcrossing.com/WebX/.1de609df cheap ambien] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=779 clonazepam online] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=90 cheap zanaflex] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=54 lisinopril online] [http://library.cshl.edu/wp/vb/member.php?u=1358 cheap hydrocodone] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=127 buy soma] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=768 fioricet online] [http://wc1.worldcrossing.com/WebX/.1de60a26 free sharp ringtones] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30358 midi ringtones] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/paxil_4058.htm cheap paxil] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30266 cheap lorazepam] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=104 motorola ringtones] [http://wc1.worldcrossing.com/WebX/.1de60a1a free mtv ringtones] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30323 flexeril] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=15&tid=3770 free alltel ringtones] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=83 didrex online] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=21 online soma] [http://wc1.worldcrossing.com/WebX/.1de60a31 buy zanaflex] [http://students.hsc.unt.edu/housing/item.cfm?type=2920 free midi ringtones] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=140 order vicodin] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30365 free mtv ringtones] [http://wc1.worldcrossing.com/WebX/.1de609ed hoodia online] [http://students.hsc.unt.edu/housing/item.cfm?type=2865 paxil online] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=114 free sony ericsson ringtones] [http://wc1.worldcrossing.com/WebX/.1de609f2 online meridia] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30268 cheap xenical] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=122 rivotril online] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=5&tid=2694 valium online] [http://students.hsc.unt.edu/housing/item.cfm?type=2853 cheap fioricet] [http://library.cshl.edu/wp/vb/member.php?u=1354 alprazolam online] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=209 xenical] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=65 buy rivotril] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=101 mp3 ringtones] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=95 free kyocera ringtones] [http://wc1.worldcrossing.com/WebX/.1de60a21 buy paxil] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/musicringtones_8033.htm free music ringtones] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=5&tid=3706 wellbutrin online] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=65 zoloft online] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/sonyericssonringtones_2032.htm free sonyericsson ringtones] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=137 cheap valium] [http://wc1.worldcrossing.com/WebX/.1de609e3 clomid online] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=804 cheap vigrx] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=803 lortab online] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30354 alltel ringtones] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=120 midi ringtones] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=94 buy flexeril] [http://library.cshl.edu/wp/vb/member.php?u=1382 free cingular ringtones] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=5&tid=3733 free wwe ringtones] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=5&tid=3736 soma online] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=766 carisoprodol online] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=161 cheap albuterol] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30312 ortho online] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=101 meridia online] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=5&tid=3716 buy diethylpropion] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=820 free real ringtones] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=89 funny ringtones] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=86 fioricet online] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=56 buy ultracet] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=133 free tracfone ringtones] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/funnyringtones_5351.htm funny ringtones] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=62 order clomid] [http://students.hsc.unt.edu/housing/item.cfm?type=2906 free samsung ringtones] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30296 order clomid] [http://wc1.worldcrossing.com/WebX/.1de60a17 lipitor online] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=801 ortho] [http://wc1.worldcrossing.com/WebX/.1de609ea free free ringtones] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30315 buy lortab] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=22 valium online] [http://library.cshl.edu/wp/vb/member.php?u=1361 cheap xenical] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=763 soma online] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=5&tid=3721 mp3 ringtones] [http://wc1.worldcrossing.com/WebX/.1de60a33 cheap prozac] [http://wc1.worldcrossing.com/WebX/.1de609dc buy albuterol] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=189 cheap lipitor] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30350 free sagem ringtones] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30277 cyclobenzaprine online] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=117 propecia online] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=106 samsung ringtones] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=66 but levitra] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=15&tid=3746 cheap ambien] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/alltelringtones_474.htm free alltel ringtones] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/verizonringtones_8798.htm free verizon ringtones] [http://library.cshl.edu/wp/vb/member.php?u=1381 free polyphonic ringtones] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=56 cialis online] [http://students.hsc.unt.edu/housing/item.cfm?type=2924 free ericsson ringtones] [http://wc1.worldcrossing.com/WebX/.1de609fb ortho online] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=94 wwe ringtones] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=171 order clomid] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/mpringtones_1668.htm free mp3 ringtones] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30316 cheap vigrx] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=15&tid=3744 clonazepam online] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=200 nexium online] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=33 adipex online] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=76 cialis] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=178 ericsson ringtones] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=86 qwest ringtones] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=109 free verizon ringtones] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30295 sildenafil online] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/adipex_547.htm cheap adipex] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=839 free kyocera ringtones] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/nexium_2418.htm nexium online] [http://wc1.worldcrossing.com/WebX/.1de609f3 midi ringtones] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=827 cingular ringtones] [http://wc1.worldcrossing.com/WebX/.1de609f7 nextel ringtones] [http://wc1.worldcrossing.com/WebX/.1de60a20 nexium online] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=195 free mono ringtones] [http://www.ees.ufl.edu/alumni/forums.asp?ForumId=5&TopicId=77 cingular ringtones] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=85 buy tenuate] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=5&tid=3734 free sony ringtones] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30265 cheap ambien] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=170 cingular ringtones] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30332 tracfone ringtones] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=53 xenical online] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=15&tid=3759 flexeril online] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=55 zoloft online] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=169 cialis] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=78 hoodia online] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=213 cheap prozac] [http://students.hsc.unt.edu/housing/item.cfm?type=2849 but valium] [http://students.hsc.unt.edu/housing/item.cfm?type=2880 albuterol online] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=5&tid=3717 order hgh] [http://wc1.worldcrossing.com/WebX/.1de60a00 rivotril online] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=52 xanax online] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/cyclobenzaprine_72.htm cyclobenzaprine online] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=175 diazepam online] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=39 cialis online] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=66 order flexeril] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30345 free sprint ringtones] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=96 cheap zyban] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=99 free tracfone ringtones] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=32 cheap valium] [http://students.hsc.unt.edu/housing/item.cfm?type=2867 order hydrocodone] [http://students.hsc.unt.edu/housing/item.cfm?type=2872 cyclobenzaprine] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=222 cheap vigrx] [http://students.hsc.unt.edu/housing/item.cfm?type=2875 propecia online] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30320 cheap rivotril] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30253 norco online] [http://library.cshl.edu/wp/vb/member.php?u=1369 free free ringtones] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=15&tid=3769 free sony ericsson ringtones] [http://students.hsc.unt.edu/housing/item.cfm?type=2889 vigrx online] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=74 mp3 ringtones] [http://students.hsc.unt.edu/housing/item.cfm?type=2925 mtv ringtones] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=828 free sagem ringtones] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=72 tracfone ringtones] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=96 sony ringtones] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=188 levitra online] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=46 nexium] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=51 online ambien] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=82 free tracfone ringtones] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=40 hydrocodone online] [http://www.colorado.edu/studentgroups/backcountryclub/blahdocs/uploads/ambien_7869.htm buy ambien] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=15&tid=3737 but phentermine] [http://library.cshl.edu/wp/vb/member.php?u=1347 but cialis] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=59 buy ortho] [http://www.aswsu-ddp.wsu.edu/toast/forums.asp?sub=show&action=posts&fid=3&tid=837 free midi ringtones] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=46 alprazolam online] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=83 lipitor online] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=44 wellbutrin online] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=60 online pharmacy online] [http://www.e.kth.se/cgi-bin/esekt/discussion?command=read&discussionid=4&id=30339 free samsung ringtones] [http://www.ovu.edu/community/toast.asp?sub=show&action=posts&fid=15&tid=3771 free cool ringtones] [http://www4.nau.edu/fera/index.asp?sub=show&action=posts&fid=4&tid=83 free funny ringtones] [http://wc1.worldcrossing.com/WebX/.1de609dd free alltel ringtones] [http://ae.siam.edu/forums/toast.asp?sub=show&action=posts&fid=2&tid=26 buy fioricet] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=97 free nokia ringtones] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=205 order paxil] [http://kc.vanderbilt.edu/forums/toast.asp?sub=show&action=posts&fid=5&tid=88 lortab] [http://wc1.worldcrossing.com/WebX/.1de60a34 free sony ericsson ringtones] [http://itcweb.ecsu.edu/portal/forums.asp?ForumId=13&TopicId=211 polyphonic ringtones] {{formats}}
+
{{formats}}
  
  
Line 21: Line 21:
 
   <component><field ref="abstract"/></component>
 
   <component><field ref="abstract"/></component>
 
  </stage>
 
  </stage>
   
+
 
 +
=== Buttons ===
 +
 
 +
By default the "save" and "cancel" buttons appear at the top and bottom of each stage, but you can change this using the "action_buttons" attribute. Values are "top", "bottom" or "both".
 +
 
 +
  <stage name="core" action_buttons="bottom" >
 +
 
 
== Components ==
 
== Components ==
  
 
An EPrints component is responsible for the rendering of a graphical element in a workflow. This may be a text-box for title entry, a collection of fields in an appropriate grouping, or just a piece of XHTML. Six components are provided by default and, as they are plugins, it is straightforward to drop in new components when necessary. The type attribute of the component element corresponds to the plugin to be used.
 
An EPrints component is responsible for the rendering of a graphical element in a workflow. This may be a text-box for title entry, a collection of fields in an appropriate grouping, or just a piece of XHTML. Six components are provided by default and, as they are plugins, it is straightforward to drop in new components when necessary. The type attribute of the component element corresponds to the plugin to be used.
 
If no type is given, type="Field" is assumed. For each component two further attributes are accepted: surround should be a plugin, by default it can be "None", "Normal", and "Light"; and collapse="yes". If collapse="yes" then it tries to render the component collapsed.
 
  
 
== Field-Related Components ==
 
== Field-Related Components ==
Line 34: Line 38:
 
The majority of field-related components in EPrints 3 make use of the field element in their configuration. This provides a reference to a metafield and any attributes which may be relevant to rendering or operation. Several attributes are available to the element:
 
The majority of field-related components in EPrints 3 make use of the field element in their configuration. This provides a reference to a metafield and any attributes which may be relevant to rendering or operation. Several attributes are available to the element:
  
<table border="1">
+
<table border="1" cellspacing='0'>
 
<tr><th>Attribute</th><th>Values</th><th>Description</th></tr>  
 
<tr><th>Attribute</th><th>Values</th><th>Description</th></tr>  
 
<tr><td>ref</td><td>A string</td><td>(required) Refers to the name of the metafield this field represents</td></tr>
 
<tr><td>ref</td><td>A string</td><td>(required) Refers to the name of the metafield this field represents</td></tr>
 
<tr><td>required</td><td>yes/no</td><td>(optional) Whether a value is required in this field before the workflow may complete</td></tr>
 
<tr><td>required</td><td>yes/no</td><td>(optional) Whether a value is required in this field before the workflow may complete</td></tr>
<tr><td>help</td><td>An XHTML block</td><td>(optional) A block of XHTML to be rendered as help for the field</td></tr>
+
<tr><td>&lt;help&gt; (child-node)</td><td>An XHTML block</td><td>(optional) A block of XHTML to be rendered as help for the field</td></tr>
 +
<tr><td>&lt;title&gt; (child-node)</td><td>An XHTML block</td><td>(optional) A block of XHTML to be rendered as the title for the field</td></tr>
 
<tr><td>input_lookup_url</td><td>A URL</td><td>(optional) The location of an auto-lookup URL for the field</td></tr>
 
<tr><td>input_lookup_url</td><td>A URL</td><td>(optional) The location of an auto-lookup URL for the field</td></tr>
<tr><td>input_lookup_params</td><td>A string</td><td>(optional) An
+
<tr><td>input_lookup_params</td><td>A string</td><td>(optional) An &-separated list of parameters (e.g. sort=descending&number=3</td></tr>
 +
<tr><td>top</td><td>A string</td><td>(optional) Only useful on "subject" fields, this overrides the top node of the available subject tree. Useful to force certain records to only select from a sub tree.</td></tr>
 +
<tr><td>options</td><td>A string (comma separated values)</td><td>(optional) On a set (or named set) field this overrides the default options. Useful if you want a certain option to appear or disappear based on other metadata)</td></tr>
 +
<tr><td>input_boxes</td><td>An integer</td><td>(optional) Default number of rows to show by default in a multiple field. Overrides the field property.</td></tr>
 +
<tr><td>input_add_boxes</td><td>An integer</td><td>(optional) Number of rows to add to a multiple field if the "more rows" button is pressed. Zero disables the option to add more rows. Overrides the field setting.</td></tr>
 +
<tr><td>input_ordered</td><td>Boolean</td><td>(optional) 1 or 0. Overrides the field setting. If zero then a multiple field won't have the 1,2,3 on the left and reordering arrows on the right of the input, as ordering is considered irrelevant.</td></tr>
 +
 
 +
</table>
 +
 
 +
==== Examples ====
 +
 
 +
===== Conditional Overriding of Field Name and Help =====
 +
 
 +
Example showing how to override the default 'keywords' field title with the string "Descriptive Labels" and the default help text for the keywords field with an entry from a [[Phrase_Format|phrase]] file for a specific item type.
 +
 
 +
'''N.B.''' the phrase ref can be any text but must match the entry in the phrase file.
 +
 
 +
<field ref="keywords">
 +
    <epc:if test="type='article'">
 +
    <title>Descriptive Labels</title>
 +
    <help><epc:phrase ref="eprint_fieldname_keywords.labels" /></help>
 +
    </epc:if>
 +
</field>
 +
 
 +
=== Field Component ===
 +
 
 +
The default component, this renders the field title, an input box suitable for the field, a star if the field is required, and any help information. A single field element is required:
 +
 
 +
<component><field ref="title" required="yes" /></component>
 +
 
 +
=== Multiple Field Component ===
 +
 
 +
The multiple field component is able to render several fields in a group, such as all fields related to a publication or an event. A title element and a help element may be provided that describe the group itself. One or many field elements are also required.
 +
 
 +
<component type="Field::Multi">
 +
  <title>Event Details</title>
 +
  <help>Enter information about your event here.</help>
 +
  <field ref="event_title"/>
 +
  <field ref="event_type" required="yes" />
 +
  <field ref="event_location"/>
 +
  <field ref="event_dates"/>
 +
</component>
 +
 
 +
=== Subject Component ===
 +
 
 +
The subject component allows for the selection of one or more subjects from a subject tree. In this instance, the field element specifies the subject metafield.
 +
 
 +
<component type="Field::Subject">
 +
  <field ref="subjects" required="yes" />
 +
</component>
 +
 
 +
== Other Components ==
 +
 
 +
=== Upload Component ===
 +
 
 +
The upload component provides an interface for files to be uploaded to EPrints documents, and for new documents to be created/edited. It does not require any elements other than the component tag, but field elements to be rendered for each document may be added as in the example.
 +
 
 +
<component type="Upload">
 +
  <field ref="format" />
 +
  <field ref="formatdesc" />
 +
  <field ref="security" />
 +
  <field ref="license" />
 +
  <field ref="date_embargo" />
 +
</component>
 +
 
 +
=== XHTML Component ===
 +
 
 +
This component inserts any contained nodes into the rendered document. As EPrints Control elements may be used, it is possible to insert phrases into the screen.
 +
 
 +
<component type="XHTML">
 +
  <epc:phrase ref="Plugin/InputForm/Component/Upload:help" />
 +
</component>
 +
 
 +
NOTE: EPrints version up to 3.3.12 produce a <component> element in the html when using this. Please see https://github.com/eprints/eprints/issues/148
 +
 
 +
== Other Component Options ==
 +
 
 +
A component normally is enclosed in a "default" surround, with a pop-up help
 +
icon, and a title bar with the contents in a tinted box. The behaviour of the page around the component can be tweaked in a few ways.
 +
 
 +
=== collapse ===
 +
 
 +
The collapse option to the component defaults to "no" but may be set to "yes. If yes, the entire component is shown, by default, as "rolled up" so it must be clicked to unroll it. This is a good way to indicate that the fields, are not something for most users to worry about. It allows you to make the form less intimidating, while still having many options available for advanced users.
 +
 
 +
<component collapse="yes">
 +
  ...
 +
</component>
 +
 
 +
=== show_help ===
 +
 
 +
The default value is "toggle" but it can be set to "always" or "never".
 +
 
 +
"always" will remove the option to show help, and just always show it. "never" removes the toggle but does not show the help.
 +
 
 +
<component show_help="always">
 +
  ...
 +
</component>
 +
 
 +
=== surround ===
 +
 
 +
This controls the InputForm::Surround plugin used to render the component. The default option paints the standard box. Other options are "None" and "Light".
 +
 
 +
None renders just the contents, and can be useful to combine with type="XHTML" to embed HTML directly into the page.
 +
 
 +
You may add your own Surround plugins if you wish.
 +
 
 +
<component surround="None" type="XHTML">
 +
  ...
 +
</component>

Latest revision as of 11:48, 23 January 2015

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)


The EPrints 3 workflow configuration files are stored in the repository's workflows directory, within folders identifying the Data Objects to which they apply (e.g. eprint or user). Multiple workflows may be defined in each folder, although typically only the default.xml file will be necessary.

Structure

At the centre of a workflow is a 'flow' description. This denotes the path through the workflow process from stage to stage. This may contain EPrints Control tags, allowing for the flow to vary depending on parameters of the data object (or other objects). For example, the flow may be different for users with certain roles. The flow is structured like so:

<flow>
  <stage ref="type"/>
  <stage ref="files"/>
  <stage ref="core"/>
  <stage ref="subjects"/>
</flow>

The 'ref' attribute of the stage element refers to the individual stages. The stage elements describe the components within each screen of the process and, like flow, may contain EPrints Control tags. The 'name' attribute of the stage element is identical to that of the stage element in the 'flow' section.

<stage name="core">
  <component><field ref="title" required="yes" /></component>
  <component><field ref="abstract"/></component>
</stage>

Buttons

By default the "save" and "cancel" buttons appear at the top and bottom of each stage, but you can change this using the "action_buttons" attribute. Values are "top", "bottom" or "both".

<stage name="core" action_buttons="bottom" >

Components

An EPrints component is responsible for the rendering of a graphical element in a workflow. This may be a text-box for title entry, a collection of fields in an appropriate grouping, or just a piece of XHTML. Six components are provided by default and, as they are plugins, it is straightforward to drop in new components when necessary. The type attribute of the component element corresponds to the plugin to be used.

Field-Related Components

Field Element

The majority of field-related components in EPrints 3 make use of the field element in their configuration. This provides a reference to a metafield and any attributes which may be relevant to rendering or operation. Several attributes are available to the element:

AttributeValuesDescription
refA string(required) Refers to the name of the metafield this field represents
requiredyes/no(optional) Whether a value is required in this field before the workflow may complete
<help> (child-node)An XHTML block(optional) A block of XHTML to be rendered as help for the field
<title> (child-node)An XHTML block(optional) A block of XHTML to be rendered as the title for the field
input_lookup_urlA URL(optional) The location of an auto-lookup URL for the field
input_lookup_paramsA string(optional) An &-separated list of parameters (e.g. sort=descending&number=3
topA string(optional) Only useful on "subject" fields, this overrides the top node of the available subject tree. Useful to force certain records to only select from a sub tree.
optionsA string (comma separated values)(optional) On a set (or named set) field this overrides the default options. Useful if you want a certain option to appear or disappear based on other metadata)
input_boxesAn integer(optional) Default number of rows to show by default in a multiple field. Overrides the field property.
input_add_boxesAn integer(optional) Number of rows to add to a multiple field if the "more rows" button is pressed. Zero disables the option to add more rows. Overrides the field setting.
input_orderedBoolean(optional) 1 or 0. Overrides the field setting. If zero then a multiple field won't have the 1,2,3 on the left and reordering arrows on the right of the input, as ordering is considered irrelevant.

Examples

Conditional Overriding of Field Name and Help

Example showing how to override the default 'keywords' field title with the string "Descriptive Labels" and the default help text for the keywords field with an entry from a phrase file for a specific item type.

N.B. the phrase ref can be any text but must match the entry in the phrase file.

<field ref="keywords">
   <epc:if test="type='article'">
    <title>Descriptive Labels</title>
    <help><epc:phrase ref="eprint_fieldname_keywords.labels" /></help>
   </epc:if>
</field>

Field Component

The default component, this renders the field title, an input box suitable for the field, a star if the field is required, and any help information. A single field element is required:

<component><field ref="title" required="yes" /></component>

Multiple Field Component

The multiple field component is able to render several fields in a group, such as all fields related to a publication or an event. A title element and a help element may be provided that describe the group itself. One or many field elements are also required.

<component type="Field::Multi">
  <title>Event Details</title>
  <help>Enter information about your event here.</help>
  <field ref="event_title"/>
  <field ref="event_type" required="yes" />
  <field ref="event_location"/>
  <field ref="event_dates"/>
</component>

Subject Component

The subject component allows for the selection of one or more subjects from a subject tree. In this instance, the field element specifies the subject metafield.

<component type="Field::Subject">
  <field ref="subjects" required="yes" />
</component>

Other Components

Upload Component

The upload component provides an interface for files to be uploaded to EPrints documents, and for new documents to be created/edited. It does not require any elements other than the component tag, but field elements to be rendered for each document may be added as in the example.

<component type="Upload">
  <field ref="format" />
  <field ref="formatdesc" />
  <field ref="security" />
  <field ref="license" />
  <field ref="date_embargo" />
</component>

XHTML Component

This component inserts any contained nodes into the rendered document. As EPrints Control elements may be used, it is possible to insert phrases into the screen.

<component type="XHTML">
  <epc:phrase ref="Plugin/InputForm/Component/Upload:help" />
</component>

NOTE: EPrints version up to 3.3.12 produce a <component> element in the html when using this. Please see https://github.com/eprints/eprints/issues/148

Other Component Options

A component normally is enclosed in a "default" surround, with a pop-up help icon, and a title bar with the contents in a tinted box. The behaviour of the page around the component can be tweaked in a few ways.

collapse

The collapse option to the component defaults to "no" but may be set to "yes. If yes, the entire component is shown, by default, as "rolled up" so it must be clicked to unroll it. This is a good way to indicate that the fields, are not something for most users to worry about. It allows you to make the form less intimidating, while still having many options available for advanced users.

<component collapse="yes">
  ...
</component>

show_help

The default value is "toggle" but it can be set to "always" or "never".

"always" will remove the option to show help, and just always show it. "never" removes the toggle but does not show the help.

<component show_help="always">
  ...
</component>

surround

This controls the InputForm::Surround plugin used to render the component. The default option paints the standard box. Other options are "None" and "Light".

None renders just the contents, and can be useful to combine with type="XHTML" to embed HTML directly into the page.

You may add your own Surround plugins if you wish.

<component surround="None" type="XHTML">
  ...
</component>