Difference between revisions of "Workflow Format"

From EPrints Documentation
Jump to: navigation, search
m
m (Reverted edit of Yp1Fps, changed back to last version by WikiSysop)
Line 1: Line 1:
[http://csmith06.ifrance.com/lib/italiane-rapite.htm italiane rapite in iraq] [http://toupheefee.ifrance.com/text/directory/tablas-las/ tablas las] [http://faithib.ifrance.com/description/lib/incasso-.htm incasso 12 coperti] [http://faithib.ifrance.com/description/lib/raf-ouch.htm raf ouch] [http://bladiblada.ifrance.com/resources/articles/nokia-s.htm nokia s 90] [http://nettikyzarc.ifrance.com/content/view/bepi-di/ bepi di marzi] [http://asing-argirl.ifrance.com/images/small/ferretti-andrea/ ferretti andrea ortopedico] [http://csmith06.ifrance.com/lib/dragonstea-din.htm dragonstea din stei] [http://toupheefee.ifrance.com/text/directory/foto-nick/ foto nick berg] [http://asing-argirl.ifrance.com/images/small/grande-fratello/ grande fratello 3] [http://blackblackblack.ifrance.com/lib/televisore-lowe.htm televisore lowe] [http://sarah531.ifrance.com/lib/rinascente.htm rinascente] [http://reikofanel.ifrance.com/web/maxtor-atlas.htm maxtor atlas 15k 36gb] [http://crazybird027.ifrance.com/view/new/matrimonio-auguri/ matrimonio auguri] [http://kirizz.ifrance.com/html/personal-jesus.htm personal jesus] [http://sarah531.ifrance.com/lib/gay-varese.htm gay varese] [http://twobit77.ifrance.com/description/lib/esterno-/ esterno 40 gb] [http://asing-argirl.ifrance.com/images/small/triestina-calcio/ triestina calcio] [http://blackblackblack.ifrance.com/lib/lettore-cd.htm lettore cd da tavolo compatibile mp3] [http://dgdeeper.ifrance.com/img/styles/tyan-thunder.htm tyan thunder i7505] [http://itsmeladuh.ifrance.com/content/view/splinder/ splinder] [http://dgdeeper.ifrance.com/img/styles/rapitori.htm rapitori] [http://nettikyzarc.ifrance.com/content/view/projection-screen/ projection screen] [http://nettikyzarc.ifrance.com/content/view/biglietto-aereo/ biglietto aereo roma bangkok] [http://hethrfethr77.ifrance.com/content/view/claudine/ claudine] [http://alvonina.ifrance.com/img/styles/norton-server/ norton server] [http://faithib.ifrance.com/description/lib/integratori-alimentari.htm integratori alimentari magnesio potassio] [http://kiravina.ifrance.com/html/mi-manchi.htm mi manchi accordi] [http://itsmeladuh.ifrance.com/content/view/norden/ norden] [http://mania555.ifrance.com/img/styles/business-card.htm business card scanner] [http://nettikyzarc.ifrance.com/content/view/scart-wireless/ scart wireless] [http://blackblackblack.ifrance.com/lib/elevation.htm elevation] [http://asing-argirl.ifrance.com/images/small/lamu-x/ lamu x] [http://reikofanel.ifrance.com/web/poliziotti-a.htm poliziotti a domicilio] [http://bang-sigh.ifrance.com/images/small/renou-louis/ renou louis] [http://hethrfethr77.ifrance.com/content/view/www-oneone/ www oneone] [http://alvonina.ifrance.com/img/styles/fornello-coleman/ fornello coleman] [http://nettikyzarc.ifrance.com/content/view/des-grieux/ des grieux] [http://csmith06.ifrance.com/lib/prezzo-auto.htm prezzo auto] [http://faithib.ifrance.com/description/lib/telefonini-sony.htm telefonini sony ericsson w800] [http://csmith06.ifrance.com/lib/win-tv.htm win tv usb schede acquisizione e tv] [http://csmith06.ifrance.com/lib/gli-ultimi.htm gli ultimi giorni] [http://faithib.ifrance.com/description/lib/e-c.htm e c m sanita] [http://nettikyzarc.ifrance.com/content/view/guanti/ guanti] [http://kiravina.ifrance.com/html/la-serva.htm la serva padrona] [http://itsmeladuh.ifrance.com/content/view/eas-myoplex/ eas myoplex carb sense] [http://soundwave106.ifrance.com/resources/articles/il-decalogo/ il decalogo sei] [http://blackblackblack.ifrance.com/lib/www-ashanti.htm www ashanti com] [http://faithib.ifrance.com/description/lib/eurorack-pro.htm eurorack pro rx1602] [http://dgdeeper.ifrance.com/img/styles/ieti.htm ieti] [http://bladiblada.ifrance.com/resources/articles/disegni-scouts.htm disegni scouts] [http://csmith06.ifrance.com/lib/parafrasi-umberto.htm parafrasi umberto saba] [http://kiravina.ifrance.com/html/www-videos.htm www videos mtv com] [http://alvonina.ifrance.com/img/styles/filmer-sir/ filmer sir robert] [http://twobit77.ifrance.com/description/lib/copertina-troy/ copertina troy] [http://faithib.ifrance.com/description/lib/il-re.htm il re leone 3] [http://sarah531.ifrance.com/lib/tania-rusoff.htm tania rusoff] [http://nettikyzarc.ifrance.com/content/view/gruppo-continuita/ gruppo continuita] [http://toupheefee.ifrance.com/text/directory/b-b/ b b nel salento] [http://sarah531.ifrance.com/lib/il-ballo.htm il ballo do patsy] [http://hethrfethr77.ifrance.com/content/view/olio-capelli/ olio capelli] [http://itsmeladuh.ifrance.com/content/view/al-arembaggio/ al arembaggio] [http://faithib.ifrance.com/description/lib/presuntos.htm presuntos] [http://csmith06.ifrance.com/lib/hesse.htm hesse] [http://mania555.ifrance.com/img/styles/fotos-pp.htm fotos pp] [http://twobit77.ifrance.com/description/lib/residenze-in/ residenze in costa smeralda] [http://hethrfethr77.ifrance.com/content/view/frases-celebres/ frases celebres] [http://reikofanel.ifrance.com/web/marechiaro.htm marechiaro] [http://faithib.ifrance.com/description/lib/yamaha-hifi.htm yamaha hifi] [http://twobit77.ifrance.com/description/lib/sexpatatina/ sexpatatina] [http://toupheefee.ifrance.com/text/directory/chat-viterbo/ chat viterbo] [http://nettikyzarc.ifrance.com/content/view/daisy/ daisy] [http://twobit77.ifrance.com/description/lib/pornostar-vecchie/ pornostar vecchie] [http://kiravina.ifrance.com/html/foto-annuncio.htm foto annuncio personale gratis] [http://crazybird027.ifrance.com/view/new/laureta-mia/ laureta mia] [http://crazybird027.ifrance.com/view/new/www-sharif/ www sharif ac ir] [http://csmith06.ifrance.com/lib/giocattoli-eroti.htm giocattoli eroti] [http://sarah531.ifrance.com/lib/sm-s.htm s4m s] [http://asing-argirl.ifrance.com/images/small/congelatore-a/ congelatore a cassetti smeg] [http://soundwave106.ifrance.com/resources/articles/destru/ destru] [http://soundwave106.ifrance.com/resources/articles/excel-saga/ excel saga] [http://twobit77.ifrance.com/description/lib/blocchi-autocad/ blocchi autocad 2d] [http://mania555.ifrance.com/img/styles/slovenian.htm slovenian] [http://itsmeladuh.ifrance.com/content/view/stradario-di/ stradario di bergamo] [http://kirizz.ifrance.com/html/canon-d.htm canon d mark] [http://soundwave106.ifrance.com/resources/articles/modem-ethernet/ modem ethernet wireless d link] [http://twobit77.ifrance.com/description/lib/leverkusen/ leverkusen] [http://twobit77.ifrance.com/description/lib/fliperama/ fliperama] [http://toupheefee.ifrance.com/text/directory/palmari-toshiba/ palmari toshiba pocket pc e740] [http://bang-sigh.ifrance.com/images/small/la-fox/ la fox finanzia gli xfiles] [http://bang-sigh.ifrance.com/images/small/costco-com/ costco com] [http://crazybird027.ifrance.com/view/new/olympus-camedia/ olympus camedia 310 zoom] [http://itsmeladuh.ifrance.com/content/view/fakaofo/ fakaofo] [http://csmith06.ifrance.com/lib/casse-acustiche.htm casse acustiche chario] [http://blackblackblack.ifrance.com/lib/adobe-creative.htm adobe creative premium upg] [http://asing-argirl.ifrance.com/images/small/microsoft/ microsoft 360] [http://soundwave106.ifrance.com/resources/articles/dpp-fp/ dpp fp30] [http://kiravina.ifrance.com/html/lavoro-a.htm lavoro a crema] [http://bladiblada.ifrance.com/resources/articles/estrategia.htm estrategia] [http://hethrfethr77.ifrance.com/content/view/fiat-multipla/ fiat multipla usato] [http://reikofanel.ifrance.com/web/inferno-in.htm inferno in florida] [http://itsmeladuh.ifrance.com/content/view/gucci-dress/ gucci dress] [http://twobit77.ifrance.com/description/lib/ragazza-acqui/ ragazza acqui terme] [http://kirizz.ifrance.com/html/www-tiji.htm www tiji fr] [http://mania555.ifrance.com/img/styles/i-disegni.htm i disegni dei dragonball z] [http://kiravina.ifrance.com/html/addizioni.htm addizioni] [http://reikofanel.ifrance.com/web/graphicconverter.htm graphicconverter] [http://kiravina.ifrance.com/html/experimentos-de.htm experimentos de fisica] [http://twobit77.ifrance.com/description/lib/zozza/ zozza] [http://hethrfethr77.ifrance.com/content/view/accao/ accao] [http://nettikyzarc.ifrance.com/content/view/y-nos/ y nos dieron las diez] [http://twobit77.ifrance.com/description/lib/belkin-ups/ belkin ups] [http://crazybird027.ifrance.com/view/new/hp-photosmart/ hp photosmart 7450] [http://csmith06.ifrance.com/lib/sapphire-x.htm sapphire x700 pro] [http://asing-argirl.ifrance.com/images/small/boston-redsox/ boston redsox com] [http://sarah531.ifrance.com/lib/tinto-bras.htm tinto bras] [http://soundwave106.ifrance.com/resources/articles/dirittoallostudio/ dirittoallostudio] [http://soundwave106.ifrance.com/resources/articles/testo-canzone/ testo canzone cantante d] [http://twobit77.ifrance.com/description/lib/m-audio/ m audio keystation 49 e] [http://mania555.ifrance.com/img/styles/tokonoma.htm tokonoma] [http://crazybird027.ifrance.com/view/new/smsgratis/ smsgratis] [http://bang-sigh.ifrance.com/images/small/behringer-ep/ behringer ep1500] [http://twobit77.ifrance.com/description/lib/pen-drive/ pen drive] [http://toupheefee.ifrance.com/text/directory/il-meglio/ il meglio di natalie imbruglia] [http://toupheefee.ifrance.com/text/directory/lord-jim/ lord jim] [http://bang-sigh.ifrance.com/images/small/bluetooth-tastiera/ bluetooth tastiera] [http://blackblackblack.ifrance.com/lib/sakis-rouvas.htm sakis rouvas shake it video] [http://dgdeeper.ifrance.com/img/styles/brasile-ristorante.htm brasile ristorante] [http://itsmeladuh.ifrance.com/content/view/frederick-pope/ frederick pope the red violin] [http://csmith06.ifrance.com/lib/jason-x.htm jason x] [http://asing-argirl.ifrance.com/images/small/mamme-porche/ mamme porche gratis] [http://crazybird027.ifrance.com/view/new/development-toolkit/ development toolkit] [http://bang-sigh.ifrance.com/images/small/porno-mantovano/ porno mantovano] [http://bang-sigh.ifrance.com/images/small/sisoft-sandra/ sisoft sandra lite] [http://kirizz.ifrance.com/html/da-solo.htm da solo sto] [http://itsmeladuh.ifrance.com/content/view/nero-mpeg/ nero mpeg2 plugins] [http://twobit77.ifrance.com/description/lib/trova-online/ trova online] [http://twobit77.ifrance.com/description/lib/sexpicture/ sexpicture] [http://itsmeladuh.ifrance.com/content/view/home-improvement/ home improvement] [http://crazybird027.ifrance.com/view/new/escavatore/ escavatore] [http://faithib.ifrance.com/description/lib/panasonic-ae.htm panasonic ae700] [http://bladiblada.ifrance.com/resources/articles/d-dissident.htm d dissident mirage] [http://kiravina.ifrance.com/html/rharb.htm rharb] [http://sarah531.ifrance.com/lib/alcamo-anna.htm alcamo anna cicirello] [http://soundwave106.ifrance.com/resources/articles/d-photo/ d88 photo] [http://asing-argirl.ifrance.com/images/small/sociologia-sedi/ sociologia sedi universitarie] [http://bang-sigh.ifrance.com/images/small/dvdrw-recorder/ dvdrw recorder] [http://reikofanel.ifrance.com/web/l-arte.htm l arte della seduzione] [http://bang-sigh.ifrance.com/images/small/sicilia-coppie/ sicilia coppie] [http://bang-sigh.ifrance.com/images/small/co-dobre/ co dobre] [http://toupheefee.ifrance.com/text/directory/false-bay/ false bay] [http://mania555.ifrance.com/img/styles/la-storia.htm la storia elsa morante] [http://soundwave106.ifrance.com/resources/articles/costantino-splinder/ costantino splinder] [http://csmith06.ifrance.com/lib/last-battle.htm last battle] [http://kirizz.ifrance.com/html/aggiornamenti-siena.htm aggiornamenti siena] [http://soundwave106.ifrance.com/resources/articles/dissipatori-spire/ dissipatori spire] [http://reikofanel.ifrance.com/web/fermata-per.htm fermata per dodici ore] [http://hethrfethr77.ifrance.com/content/view/www-elantro/ www elantro cl] [http://reikofanel.ifrance.com/web/gazzetta-di.htm gazzetta di pechino] [http://kiravina.ifrance.com/html/rocco-sigfredi.htm rocco sigfredi] [http://sarah531.ifrance.com/lib/dx.htm dx6340] [http://mania555.ifrance.com/img/styles/scarica-videoclip.htm scarica videoclip] [http://faithib.ifrance.com/description/lib/bumper-karts.htm bumper karts] [http://soundwave106.ifrance.com/resources/articles/volare-nudi/ volare nudi foto] [http://mania555.ifrance.com/img/styles/temi-svolti.htm temi svolti sul volontariato] [http://mania555.ifrance.com/img/styles/key-sat.htm key sat] [http://mania555.ifrance.com/img/styles/musica-di.htm musica di the o c] [http://kiravina.ifrance.com/html/sound-blaster.htm sound blaster bulk] [http://faithib.ifrance.com/description/lib/braw.htm braw] [http://kiravina.ifrance.com/html/pocatello.htm pocatello] [http://mania555.ifrance.com/img/styles/touareg-.htm touareg 25 r5 tdi] [http://nettikyzarc.ifrance.com/content/view/la-storia/ la storia di indro montanelli] [http://asing-argirl.ifrance.com/images/small/ducati-monster/ ducati monster 620 i e] [http://crazybird027.ifrance.com/view/new/amanti-donne/ amanti donne] [http://reikofanel.ifrance.com/web/samsung-ml.htm samsung ml2250] [http://sarah531.ifrance.com/lib/espansione-fotocamera.htm espansione fotocamera] [http://toupheefee.ifrance.com/text/directory/finanziamento-e/ finanziamento e credito] [http://dgdeeper.ifrance.com/img/styles/dvd-region.htm dvd region free] [http://bladiblada.ifrance.com/resources/articles/megane-coach.htm megane coach 16] [http://faithib.ifrance.com/description/lib/bicicle.htm bicicle] [http://itsmeladuh.ifrance.com/content/view/searchweb/ searchweb] [http://asing-argirl.ifrance.com/images/small/a-critical/ a critical review] [http://itsmeladuh.ifrance.com/content/view/corse-/ corse  machine] [http://sarah531.ifrance.com/lib/tv.htm tv 32] [http://kirizz.ifrance.com/html/jeannette-la.htm jeannette la douce] [http://itsmeladuh.ifrance.com/content/view/extremelot-it/ extremelot it] [http://bang-sigh.ifrance.com/images/small/rex-lavastoviglie/ rex lavastoviglie da incasso] [http://twobit77.ifrance.com/description/lib/letra-de/ letra de bacilo] [http://twobit77.ifrance.com/description/lib/charlotte-gainsbourg/ charlotte gainsbourg] [http://reikofanel.ifrance.com/web/rover-.htm rover 25 anno 2000] [http://soundwave106.ifrance.com/resources/articles/konica-minolta/ konica minolta dynax 60] [http://asing-argirl.ifrance.com/images/small/dani/ dani] [http://bladiblada.ifrance.com/resources/articles/disturbo-alimentare.htm disturbo alimentare] [http://asing-argirl.ifrance.com/images/small/accademia-burger/ accademia burger king] [http://csmith06.ifrance.com/lib/router-modem.htm router modem adsl wifi] [http://kiravina.ifrance.com/html/hello-kitty.htm hello kitty borsa] [http://nettikyzarc.ifrance.com/content/view/tvc-lcd/ tvc lcd 30] [http://kiravina.ifrance.com/html/www-fahi.htm www fahi] [http://kirizz.ifrance.com/html/la-contropartita.htm la contropartita] [http://alvonina.ifrance.com/img/styles/agriturismo-forli/ agriturismo forli] {{formats}}
+
{{formats}}
  
  
Line 38: Line 38:
 
<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>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>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>
 +
</table>
 +
 
 +
=== 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>

Revision as of 11:23, 3 September 2007

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>

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
helpAn XHTML block(optional) A block of XHTML to be rendered as help 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

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>