Workflow Format - Revision history

Af05v@ecs.soton.ac.uk: /* Conditional Overriding of Field Name and Help */

2015-01-23T11:48:21Z

Conditional Overriding of Field Name and Help

← Older revision		Revision as of 11:48, 23 January 2015
Line 63:		Line 63:

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

Af05v@ecs.soton.ac.uk: /* Examples */

2015-01-23T11:48:10Z

Examples

← Older revision		Revision as of 11:48, 23 January 2015
Line 56:		Line 56:
	==== Examples ====		==== Examples ====

	===== Conditional Overriding of Name and Help =====		===== 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.		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.

Af05v@ecs.soton.ac.uk: /* Field Element */

2015-01-23T11:47:26Z

Field Element

← Older revision		Revision as of 11:47, 23 January 2015
Line 54:		Line 54:
	</table>		</table>

	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.		==== Examples ====

			===== Conditional Overriding of 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.		'''N.B.''' the phrase ref can be any text but must match the entry in the phrase file.

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

Alan.stiles@open.ac.uk: Moved example from Field Component to Field Element

2015-01-22T16:28:19Z

Moved example from Field Component to Field Element

@@ Line 53: / Line 53: @@
 </table>
 === Field Component ===
@@ Line 59: / Line 68: @@
   <component><field ref="title" required="yes" /></component>
 === Multiple Field Component ===

Alan.stiles@open.ac.uk: Added an example to /* Field Component */

2015-01-22T16:25:00Z

Added an example to Field Component

← Older revision		Revision as of 16:25, 22 January 2015
Line 59:		Line 59:

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

			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.

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

			<component>
			<field ref="keywords">
			<title>Descriptive Labels</title>
			<help><epc:phrase ref="eprint_fieldname_keywords.labels" /></help>
			</field>
			</component>

	=== Multiple Field Component ===		=== Multiple Field Component ===

Libjlrs: /* Field Element */ help and title aren't attributes.

2013-11-18T15:14:33Z

Field Element: help and title aren't attributes.

← Older revision		Revision as of 15:14, 18 November 2013
Line 42:		Line 42:
	<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><help> (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>title</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><title> (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 &-separated list of parameters (e.g. sort=descending&number=3</td></tr>		<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>

Libjlrs: /* XHTML Component */

2013-11-11T16:50:17Z

XHTML Component

← Older revision		Revision as of 16:50, 11 November 2013
Line 102:		Line 102:
	<epc:phrase ref="Plugin/InputForm/Component/Upload:help" />		<epc:phrase ref="Plugin/InputForm/Component/Upload:help" />
	</component>		</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 ==		== Other Component Options ==

Cjg: /* Structure */

2010-05-19T11:53:02Z

Structure

← Older revision		Revision as of 11:53, 19 May 2010
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 ==

Cjg: /* Field Element */

2010-05-19T11:51:01Z

Field Element

← Older revision		Revision as of 11:51, 19 May 2010
Line 40:		Line 40:
	<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 &-separated list of parameters (e.g. sort=descending&number=3</td></tr>		<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>
	top		<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>
	options		<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>
	input_boxes		<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>
	input_add_boxes		<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>
	input_ordered		<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>		</table>

Cjg: /* Field Element */

2010-05-19T11:45:52Z

Field Element

← Older revision		Revision as of 11:45, 19 May 2010
Line 32:		Line 32:
	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>
Line 40:		Line 40:
	<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 &-separated list of parameters (e.g. sort=descending&number=3</td></tr>		<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>
			top
			options
			input_boxes
			input_add_boxes
			input_ordered
	</table>		</table>