Difference between revisions of "Eprint search staff.pl"

From EPrints Documentation
Jump to: navigation, search
(Added page about config file)
 
m
 
Line 2: Line 2:
 
{{cfgd}}
 
{{cfgd}}
  
'''eprint_search_staff.pl''' contains configuration for the eprint staff search on eprint data objects, which can be found under the ''Admin page's ''Editorial Tools'' tab with the name ''Search Items'' (e.g. https://eprints.example.org/cgi/search/eprint/staff). This is different from advanced search as it allows searching over eprints not in the live archive as well as on additional potential non-public fields.  
+
'''eprint_search_staff.pl''' contains configuration for the eprint staff search on eprint data objects, which can be found under the ''Admin'' page's ''Editorial Tools'' tab with the name ''Search Items'' (e.g. https://eprints.example.org/cgi/search/eprint/staff). This is different from advanced search as it allows searching over eprints not in the live archive as well as on additional potential non-public fields.  
  
 
This configuration is stored under <code>$c->{datasets}->{eprint}->{search}->{staff} </code> hash reference.  This contains the following parts:
 
This configuration is stored under <code>$c->{datasets}->{eprint}->{search}->{staff} </code> hash reference.  This contains the following parts:

Latest revision as of 12:41, 28 January 2022

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


Back to cfg.d

eprint_search_staff.pl contains configuration for the eprint staff search on eprint data objects, which can be found under the Admin page's Editorial Tools tab with the name Search Items (e.g. https://eprints.example.org/cgi/search/eprint/staff). This is different from advanced search as it allows searching over eprints not in the live archive as well as on additional potential non-public fields.

This configuration is stored under $c->{datasets}->{eprint}->{search}->{staff} hash reference. This contains the following parts:

  • search_fields - The fields that the eprint staff search will query. This by default is the [[[eprint_search_advanced.pl]] fields plus the eprint ID, the depositing user's username and full name, the eprint's status and directory.
  • preamble_phrase - The HTML phrase that will appear at the top of the eprint staff search form explaining who to use it.
  • title_phrase - The HTML phrase title, which appears as the main heading on the eprint staff search page.
  • citation - The citation format for items in the results page of eprint statff search.
  • page_size - The number of results that should appear per page.
  • order_methods - Ordering options provided at the top of the eprint staff search results page.
  • default_order - The default order search results will appear for eprint staff search.
  • show_zero_results - Should the eprint staff search go to the results page if there are no results of stay on the search form page with a warning about no results.

See Also