Eprint render.pl

From EPrints Documentation
Revision as of 10:11, 28 January 2022 by Drn@ecs.soton.ac.uk (talk | contribs) (Added cfgd and dirs template and put filename in bold. Removed main title as superfluous.)
Jump to: navigation, search

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_render.pl defines the configuration for rendering EPrint abstract/summary pages. There are various aspects to this configuration file.

Summary Page Metadata

Abstract/summary pages display a table of metadata fields for an EPrint. This by default appears just after the abstract. The fields that appear in this table can be defined in

$c->{summary_page_metadata}

. The default configration for this is:

$c->{summary_page_metadata} = [qw/
    commentary
    note
    keywords
    subjects
    divisions
    sword_depositor
    userid
    datestamp
    lastmod
/];

Only the fields that have values set for them will be displayed in this summary table.

EPrint Render Function

This is the main function that renders the abstract summary page. It builds the various flags and fragments that will then be used by the citations/eprint/summary_page.xml. This function comes under the configuration setting:

$c->{eprint_render} 

By default this function returns three XHTML DOM trees. One for the content of the page, one for the title of the page and the final for menu links.