Drn@ecs.soton.ac.uk: Added page about config file

2022-01-31T09:03:49Z

Added page about config file

New page

{{dirs}}
{{cfgd}}

'''user_search.pl''' contains configuration for the search on user data objects, which can be found under the '''Search users''' in the ''Editorial tools'' tab of the ''Admin'' menu. This configuration is stored under <code>$c->{search}->{user}</code> hash reference. This contains the following parts:
* '''<code>search_fields</code>''' - The fields that the user search will query.
* '''<code>citation</code>''' - The citation format for items in the results page of user search.
* '''<code>page_size</code>''' - The number of results that should appear per page.
* '''<code>order_methods</code>''' - Ordering options provided at the top of the user search results page.
* '''<code>default_order</code>''' - The default order search results will appear for user search.
* '''<code>show_zero_results</code>''' - Should the user search go to the results page if there are no results of stay on the search form page with a warning about no results.

== Example ==
$c->{search}->{user} ={
search_fields => [
{ meta_fields => [ "name", ] },
{ meta_fields => [ "username", ] },
{ meta_fields => [ "userid", ] },
{ meta_fields => [ "dept","org" ] },
{ meta_fields => [ "address","country", ] },
{ meta_fields => [ "usertype", ] },
{ meta_fields => [ "email" ] },
],
citation => "result",
page_size => 20,
order_methods => {
"byname" => "name/joined",
"byjoin" => "joined/name",
"byrevjoin" => "-joined/name",
"bytype" => "usertype/name",
},
default_order => "byname",
show_zero_results => 1,
};

== See Also ==
* [[API:EPrints/Search]]

User search.pl - Revision history

Drn@ecs.soton.ac.uk: Added page about config file