Editing Template:EPrints Metadata Fields Content (section)

=== Rendering Properties ===

These properties affect how values of the metadata in this field are rendered.

Certain of these properties can be turned on temporarily by the [[Citation Format]] files - render_magicstop for example.

{| cellpadding="3" cellspacing="0" border="1"
! Name !! Default Value !! Required !! Description !! Notes
|-
| '''as_list''' || <tt>undef</tt> || NO || Whether to display a collection sub-fields values as a table row or a separate list in the input form || This is only applicable for [[Compound field]]s that have <code>multiple => 1</code>.  It is useful where the length of the table row would exceed the width of a typical user's window.
|-
| '''browse_link''' || <tt>undef</tt> || NO || This is the name of a view which values of this field should be linked to. || E.g. if there was a <tt>Browse by Publishers</tt> view configured named <tt>pubs</tt>, then adding <code>browse_link => 'pubs'</tt> to the <tt>publisher</tt> field would cause it to be linked into the browse view page for the named publisher whenever it is rendered.
|-
| '''render_custom''' || <tt>undef</tt> || NO || Whether to use a pre-defined way of rendering the value for this field. || E.g. for [[Name field]]s by default the name will link to the creators browse view for that name.  This property can be re-used within bespoke render functions to specify whether some custom way of rendering this field' svalue (e.g. with a link) should be used.
|-
| '''render_dont_link''' || <tt>0</tt> || NO || Whether rendered field is not encapsulated in a hyperlink. || Currently only affects [[Url field]]s and [[Email field]]s.
|-
| '''render_dynamic''' || <tt>0</tt> || NO || Whether the rendering of this field can use JavaScript to make it dynamic. || [[limit_names_shown.pl]] uses this property to determine if the list of hidden creators/editors can be expanded to show all creators/editors.
|-
| '''render_limit''' || <tt>undef</tt> || NO || How many values for this field should be displayed. || [[limit_names_shown.pl]] uses this property to determine how many creators/editors to display.  If <code>undef</code> just render all values.
|-
| '''render_magicstop''' || <tt>0</tt> || NO || Whether to render a full stop at the end of this field, unless the last character is a dot, question mark or exclamation mark. || This helps avoid the ugly <tt>World without Cheese?.</tt> effect you get when titles end in <tt>?</tt> or <tt>!</tt>.
|-
| '''render_noreturn''' || <tt>0</tt> || NO || Whether CR (Carriage Return) and LF (Line Feed) characters are turned into normal spaces. ||
|-
| '''render_quiet''' || <tt>0</tt> || NO || Whether to prevent a big ugly <tt>UNSPECIFIED</tt> being rendered if field is unset. || E.g. setting <code>render_quiet => 1</code> on a field means it just gets rendered as nothing if it is unset.
|-
| '''render_single_value''' || <tt>undef</tt> || NO || The value of this property is the name of a function to call to render individual values from this field. || For a multiple field this is called once per value in the list of values. The function should take the following parameters: (<code>$session, $field, $value, $object</code>). It should return a [[XHTML DOM]] object of the rendered value.
|- 
| '''render_value''' || <tt>undef</tt> || NO || The value of this property is the name of a function to call to render the the field as a whole.  || As with <tt>render_single_value</tt>, but this gets passed the entire list of values (an array reference) if it is a multiple field. Parameters passed are: ( code>$session, $self, $value, $all_langs, $no_link, $object</code> ). <code>$all_langs</code> indicates that all language variants should be shown and is only really useful for [[Multilang field]]s. <code>$no_link</code> being true is a request to place no hyperlinks in the resulting HTML. The function should return an [[XHTML DOM]] object of the rendered value.
|}