Eprint fields.pl - Revision history

Drn@ecs.soton.ac.uk at 00:36, 6 March 2022

2022-03-06T00:36:02Z

← Older revision		Revision as of 00:36, 6 March 2022
Line 9:		Line 9:

	Note removing fields from eprint_fields.pl does not usually cause data to be deleted from the database. To add or remove fields from eprint_fields.pl you must run:		Note removing fields from eprint_fields.pl does not usually cause data to be deleted from the database. To add or remove fields from eprint_fields.pl you must run:
	EPRINTS_PATH/bin/epadmin update_database_structure ~~ARCHIVE_NAME~~		EPRINTS_PATH/bin/epadmin update_database_structure ARCHIVEID
	and then reload your configuration (or restart the webserver).		and then reload your configuration (or restart the webserver).

Drn@ecs.soton.ac.uk at 08:50, 30 January 2022

2022-01-30T08:50:16Z

← Older revision		Revision as of 08:50, 30 January 2022
Line 2:		Line 2:
	{{cfgd}}		{{cfgd}}

	~~= EPrint Fields =~~
	'''eprint_fields.pl''' defines all the optional fields which an EPrint object has. These fields all have mappings to the database. There are a variety of field types which you can see here [[:Category:EPrints_Metadata_Fields\|here]].		'''eprint_fields.pl''' defines all the optional fields which an EPrint object has. These fields all have mappings to the database. There are a variety of field types which you can see here [[:Category:EPrints_Metadata_Fields\|here]].

Drn@ecs.soton.ac.uk: Put actual filename in bold. Add to dirs and cfgd templates.

2022-01-27T10:12:02Z

Put actual filename in bold. Add to dirs and cfgd templates.

← Older revision		Revision as of 10:12, 27 January 2022
Line 1:		Line 1:
			{{dirs}}
			{{cfgd}}

	= EPrint Fields =		= EPrint Fields =
	eprint_fields.pl defines all the optional fields which an EPrint object has. These fields all have mappings to the database. There are a variety of field types which you can see here [[:Category:EPrints_Metadata_Fields\|here]].		'''eprint_fields.pl''' defines all the optional fields which an EPrint object has. These fields all have mappings to the database. There are a variety of field types which you can see here [[:Category:EPrints_Metadata_Fields\|here]].

	EPrints have a broad range of field types which enforce various constraints. Each field type has its own method of storing in the database, retrieving the value from the database, rendering the value in HTML, and rendering the input component HTML for use in workflows, etc.		EPrints have a broad range of field types which enforce various constraints. Each field type has its own method of storing in the database, retrieving the value from the database, rendering the value in HTML, and rendering the input component HTML for use in workflows, etc.

Drn@ecs.soton.ac.uk: Added Configuration category to page

2021-12-30T19:17:32Z

Added Configuration category to page

← Older revision		Revision as of 19:17, 30 December 2021
Line 21:		Line 21:
	...		...
	];</pre>		];</pre>

			[[Category:Configuration]]

Drn@ecs.soton.ac.uk: /* EPrint Fields */

2021-12-30T19:10:58Z

EPrint Fields

← Older revision		Revision as of 19:10, 30 December 2021
Line 2:		Line 2:
	eprint_fields.pl defines all the optional fields which an EPrint object has. These fields all have mappings to the database. There are a variety of field types which you can see here [[:Category:EPrints_Metadata_Fields\|here]].		eprint_fields.pl defines all the optional fields which an EPrint object has. These fields all have mappings to the database. There are a variety of field types which you can see here [[:Category:EPrints_Metadata_Fields\|here]].

	EPrints have a broad range of field types which enforce various constraints. Each field type has its own method of storing in the database, retrieving the value from the database, rendering the value in HTML, and rendering the input component HTML for use in workflows etc.		EPrints have a broad range of field types which enforce various constraints. Each field type has its own method of storing in the database, retrieving the value from the database, rendering the value in HTML, and rendering the input component HTML for use in workflows, etc.

	EPrints also has [[Compound_field\|compound]] fields. This is a field made up of compound field definitions. This allows you to make very powerful data structures without having to worry about the complexities of how they are stored in the database.		EPrints also has [[Compound_field\|compound]] fields. This is a field made up of compound field definitions. This allows you to make very powerful data structures without having to worry about the complexities of how they are stored in the database.

	Note removing fields from eprint_fields.pl does not usually cause data to be deleted from the database. To add or remove fields from eprint_fields.pl you must run ~~<eprintsroot>~~/bin/epadmin update_database_structure ~~<repo_id>~~ and then reload your configuration (or restart the webserver).		Note removing fields from eprint_fields.pl does not usually cause data to be deleted from the database. To add or remove fields from eprint_fields.pl you must run:
			EPRINTS_PATH/bin/epadmin update_database_structure ARCHIVE_NAME
			and then reload your configuration (or restart the webserver).

	==Field Definition==		==Field Definition==

Adb1a11@ecs.soton.ac.uk: Fix typos

2012-08-10T10:20:50Z

Fix typos

← Older revision		Revision as of 10:20, 10 August 2012
Line 2:		Line 2:
	eprint_fields.pl defines all the optional fields which an EPrint object has. These fields all have mappings to the database. There are a variety of field types which you can see here [[:Category:EPrints_Metadata_Fields\|here]].		eprint_fields.pl defines all the optional fields which an EPrint object has. These fields all have mappings to the database. There are a variety of field types which you can see here [[:Category:EPrints_Metadata_Fields\|here]].

	EPrints have a broad range of field types which enforce various constraints. Each field type has ~~it's~~ own method of storing in the database, ~~retriving~~ the value from the database, rendering the value in HTML, and rendering the input component HTML for use in workflows etc.		EPrints have a broad range of field types which enforce various constraints. Each field type has its own method of storing in the database, retrieving the value from the database, rendering the value in HTML, and rendering the input component HTML for use in workflows etc.

	EPrints also has [[Compound_field\|compound]] fields. This is a field made up of compound field ~~definations~~. This allows you to make very powerful data structures without having to worry about the complexities of how they are stored in the database.		EPrints also has [[Compound_field\|compound]] fields. This is a field made up of compound field definitions. This allows you to make very powerful data structures without having to worry about the complexities of how they are stored in the database.

	Note removing fields from eprint_fields.pl does not usually cause data to be deleted from the database. To add or remove fields from eprint_fields.pl you must run <eprintsroot>/bin/epadmin update_database_structure <repo_id> and then reload ~~you~~ configuration (or restart the webserver).		Note removing fields from eprint_fields.pl does not usually cause data to be deleted from the database. To add or remove fields from eprint_fields.pl you must run <eprintsroot>/bin/epadmin update_database_structure <repo_id> and then reload your configuration (or restart the webserver).

	==Field Definition==		==Field Definition==
	The field list is represented by an arrayref of hashrefs. Each hashref has at minimum a <code>name</code> which is the field name used when ~~refering~~ to the field (e.g in search) and a <code>type</code> which describes the type of data the field will hold. Depending on a ~~fields~~ type there may also be other compulsory fields and some optional ones. [[:Category:EPrints_Metadata_Fields \|See the details of field definition on the page for that <code>type</code>.]]		The field list is represented by an arrayref of hashrefs. Each hashref has at minimum a <code>name</code>, which is the field name used when referring to the field (e.g. in search) and a <code>type</code>, which describes the type of data the field will hold. Depending on a field's type there may also be other compulsory fields and some optional ones. [[:Category:EPrints_Metadata_Fields \|See the details of field definition on the page for that <code>type</code>.]]

	<pre>$c->{fields}->{eprint} = [		<pre>$c->{fields}->{eprint} = [

Pm705 at 22:07, 19 July 2010

2010-07-19T22:07:08Z

← Older revision		Revision as of 22:07, 19 July 2010
Line 9:		Line 9:

	==Field Definition==		==Field Definition==
	The field list is represented by an arrayref of hashrefs. Each hashref has at minimum a <code>name</code> which is the field name used when refering to the field (e.g in search) and a <code>type</code> which describes the type of data the field will hold. Depending on a fields type there may also be other compulsory fields and some optional ones. [[:Category:EPrints_Metadata_Fields \|See the details of field definition on the page for that <code>type<code>.]]		The field list is represented by an arrayref of hashrefs. Each hashref has at minimum a <code>name</code> which is the field name used when refering to the field (e.g in search) and a <code>type</code> which describes the type of data the field will hold. Depending on a fields type there may also be other compulsory fields and some optional ones. [[:Category:EPrints_Metadata_Fields \|See the details of field definition on the page for that <code>type</code>.]]

	<pre>$c->{fields}->{eprint} = [		<pre>$c->{fields}->{eprint} = [

Pm705 at 22:06, 19 July 2010

2010-07-19T22:06:45Z

← Older revision		Revision as of 22:06, 19 July 2010
Line 4:		Line 4:
	EPrints have a broad range of field types which enforce various constraints. Each field type has it's own method of storing in the database, retriving the value from the database, rendering the value in HTML, and rendering the input component HTML for use in workflows etc.		EPrints have a broad range of field types which enforce various constraints. Each field type has it's own method of storing in the database, retriving the value from the database, rendering the value in HTML, and rendering the input component HTML for use in workflows etc.

	EPrints also has compound fields. This is a field made up of compound field definations. This allows you to make very powerful data structures without having to worry about the complexities of how they are stored in the database.		EPrints also has [[Compound_field\|compound]] fields. This is a field made up of compound field definations. This allows you to make very powerful data structures without having to worry about the complexities of how they are stored in the database.

	Note removing fields from eprint_fields.pl does not usually cause data to be deleted from the database. To add or remove fields from eprint_fields.pl you must run <eprintsroot>/bin/epadmin update_database_structure <repo_id> and then reload you configuration (or restart the webserver).		Note removing fields from eprint_fields.pl does not usually cause data to be deleted from the database. To add or remove fields from eprint_fields.pl you must run <eprintsroot>/bin/epadmin update_database_structure <repo_id> and then reload you configuration (or restart the webserver).

	==~~Properties~~==		==Field Definition==
			The field list is represented by an arrayref of hashrefs. Each hashref has at minimum a <code>name</code> which is the field name used when refering to the field (e.g in search) and a <code>type</code> which describes the type of data the field will hold. Depending on a fields type there may also be other compulsory fields and some optional ones. [[:Category:EPrints_Metadata_Fields \|See the details of field definition on the page for that <code>type<code>.]]

	<pre>$c->{fields}->{eprint} = [		<pre>$c->{fields}->{eprint} = [
	{		{
Line 15:		Line 17:
	'input_rows' => 3,		'input_rows' => 3,
	},		},
			...
	];</pre>		];</pre>

Pm705 at 21:54, 19 July 2010

2010-07-19T21:54:06Z

← Older revision		Revision as of 21:54, 19 July 2010
Line 9:		Line 9:

	==Properties==		==Properties==
			<pre>$c->{fields}->{eprint} = [
	{~~\| border~~=~~"1" cellpadding="4" cellspacing="0"~~		{
	~~\|name~~		'name' => 'note',
	~~\|The identifier used for this field in EPrints. The~~ name ~~used to refer to a field whe you $eprint-~~>~~value()~~, ~~as part of a search, in citations etc.~~		'type' => 'longtext',
	\|-		'input_rows' => 3,
	\|type		},
	~~\|The type of the field. Different types of field can result in different data structures begin returned when $eprint-~~>~~value() is called. Types also enforce some basic validation again what is entered into them. Types include: text,~~ longtext, ~~name, email, compound, int, set, namedset, subject and so on. For a full list of possible field types you can see a full list of types [[:Category:EPrints_Metadata_Fields]]~~		];</pre>
	\|-
	~~\|multiple~~
	~~\|A <code>multiple~~=>~~1</code> field can have many values. Say for example: an item can have multiple tags~~, ~~the tags field in this case would be a multiple field. Note if you use $eprint->value() on a multiple field it returns and array ref rather than a single scalar.~~
	\|-
	~~\|input_style~~
	~~\|The width of the input elements which are rendered when this field is viewed (in a workflow for example). Possible values are: small,medium~~, ~~large. If this value is not specifed the field will pick a sensible default.~~
	\|-
	~~\|input_rows~~
	\|
	\|}

Pm705: /* Properties */

2010-07-18T10:12:37Z

Properties

← Older revision		Revision as of 10:12, 18 July 2010
Line 22:		Line 22:
	\|input_style		\|input_style
	\|The width of the input elements which are rendered when this field is viewed (in a workflow for example). Possible values are: small,medium, large. If this value is not specifed the field will pick a sensible default.		\|The width of the input elements which are rendered when this field is viewed (in a workflow for example). Possible values are: small,medium, large. If this value is not specifed the field will pick a sensible default.
			\|-
			\|input_rows
			\|
	\|}		\|}