⧼vector-jumptocontent⧽

Workflows/Components: Difference between revisions

From EPrints Documentation
Moj (talk | contribs)
No edit summary
 
Moj (talk | contribs)
No edit summary
Line 3: Line 3:
= Input Form Components =
= Input Form Components =


== Component Parameters ==
== Field Components ==


=== type ===
=== Field Component ===
 
The Field component is the default component type, and is capable of rendering a single field. It contains a single configuration line, consisting of a <field> element structured like this:


=== required ===
{{codesample|
<pre>
<component>
  <field ref="monograph_type" required="yes" />
</component>
</pre>
}}


=== collapse ===
The ref attribute is required, and indicates which metafield is handled by the component (in this case, 'monograph_type'). The required attribute is not required, but if set the component will not allow the flow to proceed without a value being entered. The component title and help are both taken from the metafield configuration.


=== surround ===
=== Field::Multi Component ===


== Bundled Components ==
The Field::Multi component is similar to the Field component, but allows for several fields to be combined into a single space. For example, publication information could incorporate journal name, ISSN, issue number, volume, and a page range. The configuration, therefore, has a list of multiple fields as well as a title and help element for the group. If no help element is provided, the help of all the fields is combined and used.


=== Field Component ===


=== MultiField Component ===
{{codesample|
<pre>
<component type="Field::Multi">
  <title>Publication Details</title>
  <field ref="pagerange" />
  <field ref="book_title" required="yes" />
  <field ref="volume" />
  ...
</component>
</pre>
}}


=== Upload Component ===
=== Upload Component ===


=== Subject Component ===
=== Subject Component ===
== Other Components ==


=== XHTML Component ===
=== XHTML Component ===


=== PlaceHolder Component ===
=== PlaceHolder Component ===

Revision as of 20:24, 4 October 2006

Workflows
Workflow Format Components Custom Components
Template:Workflows

Input Form Components

Field Components

Field Component

The Field component is the default component type, and is capable of rendering a single field. It contains a single configuration line, consisting of a <field> element structured like this:


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


The ref attribute is required, and indicates which metafield is handled by the component (in this case, 'monograph_type'). The required attribute is not required, but if set the component will not allow the flow to proceed without a value being entered. The component title and help are both taken from the metafield configuration.

Field::Multi Component

The Field::Multi component is similar to the Field component, but allows for several fields to be combined into a single space. For example, publication information could incorporate journal name, ISSN, issue number, volume, and a page range. The configuration, therefore, has a list of multiple fields as well as a title and help element for the group. If no help element is provided, the help of all the fields is combined and used.


<component type="Field::Multi">
  <title>Publication Details</title>
  <field ref="pagerange" />
  <field ref="book_title" required="yes" />
  <field ref="volume" />
  ...
</component>


Upload Component

Subject Component

Other Components

XHTML Component

PlaceHolder Component