Document fields default.pl - Revision history

Drn@ecs.soton.ac.uk: Added actually file name in bold.

2022-01-27T12:15:42Z

Added actually file name in bold.

Drn@ecs.soton.ac.uk: Added infor about Document get_defaults method.

2022-01-22T00:40:07Z

Added infor about Document get_defaults method.

Drn@ecs.soton.ac.uk: Improved formatting and explanation of example.

2022-01-21T17:20:36Z

Improved formatting and explanation of example.

Pm705 at 14:54, 18 August 2010

2010-08-18T14:54:03Z

Pm705: Created page with '{{dirs}} {{cfgd}} * $data is a hash of the metadata which will make up the document object. Each field name is a key in the hash. * $session is a [[API:EPrints/Repository|Reposi…'

2010-08-18T14:40:19Z

Created page with '{{dirs}} {{cfgd}} * $data is a hash of the metadata which will make up the document object. Each field name is a key in the hash. * $session is a [[API:EPrints/Repository|Reposi…'

New page

{{dirs}}
{{cfgd}}

* $data is a hash of the metadata which will make up the document object. Each field name is a key in the hash.
* $session is a [[API:EPrints/Repository|Repository]] object (in 3.2 or later)
* $eprint is the [[API:EPrints/DataObj/EPrint|EPrint]] object to which the document belongs

==Example==
<pre>
$c->{set_document_defaults} = sub
{
my( $data, $session, $eprint ) = @_;

$data->{language} = $session->get_langid();
$data->{security} = "public";
};
</pre>

@@ Line 2: / Line 2: @@
 {{cfgd}}
-The '''set_document_defaults''' function sets the default values for a Document. This usually happens when a Document is created but before it is given to the user to edit.
+'''document_fields_default.pl''' contains the '''set_document_defaults''' function.  This function sets the default values for a Document. This usually happens when a Document is created but before it is given to the user to edit.
 * '''<tt>$data</tt>''' is a hash reference of the metadata which will make up the document object. Each field name is a key in the hash.

← Older revision		Revision as of 00:40, 22 January 2022
Line 20:		Line 20:
	};		};
	</pre>		</pre>
		+
		+	N.B. There are also a number of defaults set by the [[API:EPrints/DataObj/Document#get_defaults\|EPrints::DataObj::Document::get_defaults]] method:
		+	# '''pos''' is set to the next document position or to a bespoke position specified by <tt>$c->{ulimate_doc_pos}</tt> if it is defined.
		+	# '''placement''' is set to the same value as ''pos'' as set above.

@@ Line 2: / Line 2: @@
 {{cfgd}}
-The set_document_defaults function sets the default values for a Document. This usually happens when a Document is created but before it is given to the user to edit.
+The '''set_document_defaults''' function sets the default values for a Document. This usually happens when a Document is created but before it is given to the user to edit.
-* $data is a hash of the metadata which will make up the document object. Each field name is a key in the hash.
+* '''<tt>$data</tt>''' is a hash reference of the metadata which will make up the document object. Each field name is a key in the hash.
-* $session is a [[API:EPrints/Repository|Repository]] object (in 3.2 or later)
+* '''<tt>$session</tt>''' is a [[API:EPrints/Repository|Repository]] object (in 3.2 or later).
-* $eprint is the [[API:EPrints/DataObj/EPrint|EPrint]] object to which the document belongs
+* '''<tt>$eprint</tt>''' is the [[API:EPrints/DataObj/EPrint|EPrint]] object to which the document belongs.
 ==Example==
 <pre>
 $c->{set_document_defaults} = sub