EPrints 3 Configuration orientation for EPrints 2 administrators

From EPrints Documentation
Revision as of 13:41, 8 February 2010 by Pm705 (Talk | contribs)

Jump to: navigation, search

Warning This page is under development as part of the EPrints 3.0 manual. It may still contain content specific to earlier versions. Manuals for previous versions of EPrints are also available.

Whereas EPrints 2 had comparatively fewer (but larger) configuration files, EPrints 3 splits these up into several smaller files (with filenames that make finding specific configuration options much easier!). The configuration directory structure has also been reshuffled to organise the configuration files more logically. The migration tool converted your EPrints 2 configuration automatically - this orientation guide is intended to help you re-orient yourselves in your new EPrints 3 set up.

Where did my configuration settings go?

Both EPrints 2 and EPrints 3 store the repository configuration settings in the same place:


This section covers each EPrints 2 configuration file in turn, describing where the settings can now be found in EPrints 3.


The configuration settings in the top level repository settings file have been split into several EPrints 3 files:


The main ArchiveConfig.pm module from EPrints 2 has also been split into several smaller files.

The way in which the configuration files are loaded has also changed. In EPrints 2, ArchiveConfig.pm was responsible for loading the other configuration files. EPrints 3 makes this process simpler by automatically loading all the configuration files in the main repository configuration directory:


ArchiveConfig.pm contained lots of different configuration settings, some of which are more likely to have been changed than others:

In EPrints 2 you may have changed:

You probably didn't change:

And there are still some miscellaneous bits left over in misc.pl.

Submission customisation (the submission_stage_skip and submission_hide_* options} is now defined within the deposit workflow itself. Also, entities like archivename and base_url are no longer created; instead the {..} notation is used to include configuration strings in the site template, phrases and static content pages.


In EPrints 2, the ArchiveMetadataFieldsConfig.pm file defined the relevant metadata for eprints, users and documents, and also the default and derived (automatic) values. In EPrints 3, these definitions have been split into individual files for each type.

eprint metadata

user metadata

document metadata


The settings for the OAI 2.0 interface have been moved from ArchiveOAIConfig.pm to oai.pl. OAI 1.1 is no longer supported.

The mapping between the repository metadata and Dublin Core (any other metadata schemas you may have added support for) are now defined using export plugins.


The configuration file responsible for rendering the individual information pages for each eprint (the abstract pages) and user (user record pages) has been split into eprint_render.pl and user_render.pl accordingly.


The text indexing settings have been moved to indexing.pl.


The validation rules for individual metadata fields have been split off into the field_validate.pl configuration file. Similarly, validation rules for eprints, users and documents have been moved to eprint_validate.pl, user_validate.pl and document_validate.pl respectively.


Citation styles for eprints (article, book, thesis...), users (editor, admin...) and documents (html, pdf...) have been moved into their own directory structure:


EPrints 3 no longer defines an individual citation style for each type. For example, in EPrints 2 an individual article citation style is defined. In EPrints 3 there is no article-specific style, but the default citation style now includes conditional syntax so that appropriate metadata (journal title, publisher etc) is displayed if the style is being applied to an article.

See also: Citation_Format


In EPrints 2, the metadata-types.xml file listed the available types for eprints (article, book, thesis..), users (editor, administrator..) and documents (html, pdf).. and defined the workflow for each eprint and user type.

In EPrints 3, the list of available types are defined in named sets. Each named set has its own file (which lists the contents of the set) in the namedset directory.

Similarly, workflows for eprints and users have been split into separate files and moved to the workflows directory. As with citations, EPrints 3 no longer defines an individual workflow for each type but instead uses a single workflow which is tailored to individual types (or other contexts) using the new conditional syntax.

See also: Workflow_Format


The repository phrases file has been split into several smaller files.

The way in which phrases are loaded has changed. In EPrints 2, all phrases had to be defined in a specific phrases file (one for each supported language). EPrints 3 makes this process simpler by loading all the phrase files it finds in each language-specific phrases directory:



The site template for the repository has also been moved to a language-specific directory:


See also: Template_Format

static directory

In EPrints 2, the static directory contained both language-specific static content (index page, help page, information page etc) and non language-specific content (stylesheets, images etc). In EPrints 3, the language-specific static content has been moved to the appropriate language-specific configuration directory:


See also: XPAGE Format

The non language-specific content has been moved to its own static directory:



The subjects file remains in the same location:



Not often changed, the ruler definition has been moved to a file in the global language-specific phrases directory:



In EPrints 2, the entities-en.dtd file provided useful entities (such as adminemail and base_url) for use in the template and static content files. In EPrints 3, the {..} notation is used instead to include configuration strings in the site template, phrases and static content pages.

The character-based entities provided by entities-en.dtd (copyright symbol, accented characters etc) have been moved to the [configuration directory]: