Editing Functions (section)

==Metadata Field Render Options (v2.3.0)==
Render options are settings for a metadata field which control how it is rendered (but nothing else). Some render options are only meaningful for certain types.

===Setting in Metadata Fields Configuration===
Render options can be specified as properties of a metadata field in ArchiveMetadataFieldsConfig.pm in which case they apply to that field (unless over ridden). In this case they are a hash reference, for example:


<code>
 { name => "creators", type => "name", render_opts=>{ order=>"gf" } },
</code>
This sets the "order" render option of the creators field to be "gf".

===Setting in views and citations===
Render options can also be specified in views and citations. If you don't want them to apply except in the given view or citation. For example, in citations:


<code>
 @title;magicstop@
</code>
Magicstop is a boolean option so this is the same as saying:


<code>
 @title;magicstop=1@
</code>
In views you can use


<code>
 "some_date_field;res=year"
</code>
To make a view that browses by the values of a date field as if it were a "year" field.

===Available options===
Boolean options with no value default to true (1).

; magicstop : Boolean. Applies to text and longtext fields. If true then render the value with a full stop on the end unless the value already ends with "." "!" or "?". Handy for getting citations right.
; noreturn : Boolean. Applies to text and longtext fields. Turns all Carriage Return and Line Feed characters into whitespace. Handy when you have authors entering titles with linebreaks in which should only be displayed under some circumstances.
; order : "gf" or "fg". Applies to name fields. Override how this name field will be rendered. Either "given-name family-name" or "family-name, given-name".
; quiet : Boolean. If true then and the value is not set, don't print the ugly "UNSPECIFIED" just print an empty string.
; res : "day", "month" or "year". Default is "day". Applies to date fields only. Resolution at which to deal with the dates. @foo;res=year@ will always render just the year part of the "foo" field.