View source for EPrints Glossary

{{glossary}}
__NOTOC__
EPrints repository software uses a long list of terminology.  Sometimes this terminology overloads existing terminology in similar realms.  Other times different terms are used interchangeably to mean the same of similar things.  This glossary is intended to help clarify the various terminology you may come across whilst installing, configuring or using EPrints repository software.

== A ==
=== Abstract page ===
An abstract page (sometimes referred to as a [[#Summary page|summary page]]) is a web page for an [[#Archive|archive]] providing [[#Metadata|metadata]] about a particular [[#EPrint|eprint]] (a.k.a [[#Publication record|publication record]]).  Most prominently it displays the abstract for the publication but also its title, [[#Citation|citation]] links to download associated [[#Document|documents]] and further metadata in a [[#Summary table|summary table]].

Abstract pages are cached.  This cache is cleared when an eprint is modified.  Otherwise, these caches can be cleared, (so new cached version will be generated on next request), by running the following command or by clicking on the "[[Admin/System Tools/Regenerate Abstracts|Regenerate Abstracts]]" button in the [[#Admin menu|admin menu]]:
 EPRINTS_PATH/bin/epadmin refresh_abstracts ARCHIVEID
One or all abstracts pages can be regenerated by using the [[API:bin/generate_abstracts|bin/generate_abstracts]] command.

=== Access ===
An [[Access Object|access]] is a [[#Data object|data object]] that represent a HTTP request accessing either an [[#Abstract page|abstract page]] or [[#Document|document]].
=== Actions tab ===
The actions tab appears on the [[#View page|view page]] for a [[#Data object|data object]].  However it typically the term in used in the context of an [[#EPrint|eprint]].  This tab include buttons to carry out various action against the data object.  For an eprint this may include:
* Depositing an item.
* Creating a new version (i.e. one that succeeds the current item).
* Using as a template to create a completely new item based on the current item.
* Editing an item.
* Removing an item (i.e. full deleting it from the [[#Archive|archive]]).  With or without a notification.
* Moving to the [[#Live archive|live archive]].
* Moving to the [[#Review buffer|review buffer]].
* Reindexing the item.
* Changing the [[#Depositing user|depositing user]] of the item.
* Exporting the item in one of various formats.

=== Admin menu ===
The [[Admin|admin menu]] is only accessible to [[#Repository admin|repository admins]] that provides access to various adminstrative tools to manage their [[#Repository|repository]].
=== Advanced search ===
An advanced search over [[#EPrint|eprints]] in the [[#Live archive|live archive]].  Unlike [[#Simple search|simple search]] this provides multiple input fields to individually search against particular [[#Metadata field|metadata fields]].  Advanced search configuration can be found in [[eprint_search_advanced.pl]].

=== Archive ===
Often conflated with [[#Repository| repository]].  [[#EPrints repository software|EPrints repository software]] provides a repository that can host multiple archives.  Commonly a repository will only host a single archive, so the terms are often used interchangeably.

New archives can be created using the [[API:bin/epadmin|epadmin command]], as follows:
 EPRINTS_PATH/bin/epadmin create <zero|pub>
Where <tt>zero</tt> is to create an archive with no [[#Flavour|flavour]] and <tt>pub</tt> is to create an archive using the [[#Publication flavour|publication flavour]].  See [[Getting Started]] for more information.

Content, configuration and sometimes code for an archive will be found at its [[#Archive level|archive level]], i.e.
 EPRINTS_PATH/archives/ARCHIVEID/
E.g. <tt>/opt/eprints3/archives/example/</tt>

=== Archive ID ===
The ID of an [[#Archive|archive]].  This is set by the first input when the archive is created using the [[API:bin/epadmin|bin/epadmin]] command line tool.  This will also be the directory name for the archive under [[#EPrints repository software|EPrints']] ''archives/'' sub-directory.   Guides on this wiki often use the placeholder <tt>ARCHIVEID</tt>.
=== Archive level ===
This is a shorthand term to describe a configuration file that appears under the [[#Archive|archive]]'s directory structure or to an effect that will only apply to a specific archive rather than the [[#Repository|repository]] as a whole, (which may have multiple archives). 
=== Archive name ===
The name of an [[#Archive|archive]].  This is set by an early input when the archive is created using the [[API:bin/epadmin|bin/epadmin]] command line tool.  WHere the value set will be copied as a [[#Phrase|phrase]] to the archive's ''archive_name.xml'' under [[archives/ARCHIVEID/cfg/lang/en/phrases/]].

== B ==
=== Bazaar ===
The [https://bazaar.eprints.org/ Bazaar] hosts EPrints packages of functionality ([[#EPM|EPMs]]), which can be installed on a [[#Repository|repository]] via the [[Admin/System Tools/EPrints Bazaar|EPrints Bazaar]] tool in the [[Admin]] web interface.

=== Bazaar plugin ===
See [[#EPM|EPM]].
=== Box plugin ===
This is a type of [[#Plugin|plugin]] that generates a box containing some content or functionality, typically to be display at the top, bottom, left or right of an [[#EPrint|eprint]]'s [[#Abstract page|abstract page]].  A common box plugin is the ''Tools'' plugin that typically appears at the top of abstract page provides the user with various export formats for the eprint.  [[#EPM|Bazaar plugins]] often include box plugins such as for [http://bazaar.eprints.org/555/ Altmetric] and the [http://bazaar.eprints.org/466/ CORE Recommender].

=== Branding ===
Branding refers to the changing of the appearance of the web pages for your [[#Repository|repository]] or just a single [[#Archive|archive]].  Typically to line up with your institutional branding used on its other websites.  Advice is available on [[Branding with confidence]].  Branding is typically done by editing [[#Template|template]] configuration files and adding your own bespoke CSS, JavaScript and images/icons.  This can be done at an [[#Archive level|archive level]] of by creating a [[#Theme|theme]] so it can be applied to multiple archives hosted on the same repository.

=== Browse view ===
A browse view is a collection of pages that display menus and listings of for all [[#Live archive|live archive]] [[#EPrint|eprints]] in an [[#Archive|archive]], organised by a particular [[#Metadata field|metadata field]]. By default these fields are: ''year'', ''subjects'', ''divisions'' and ''creators''.
All the browse views can be found under the equivalent URL for archive to the following:
 https://example.eprints.org/view/
The configuration for browse views can be found in [[views.pl]], which by default is found under [[flavours/pub_lib/cfg.d/]] but should be copied to the archive's ''cfg/cfg.d/'' for editing.  See [[:Category:Browse_Views|browse views category]] for more information.

Browse view pages are cached for a set period of time, by default 24 hours. However, these caches can be cleared earlier, (so new cached version will be generated on next request), by running the following command or by clicking on the "[[Admin/System Tools/Regenerate Views|Regenerate Views]]" button in the [[#Admin menu|admin menu]]:
 EPRINTS_PATH/bin/epadmin refresh_views ARCHIVEID
One, some or all browse views can be regenerated by using the [[API:bin/generate_views|bin/generate_views]] command.  Often these used as a cron job (i.e. scheduled task) so browse views caches can be updated overnight, when the server hosting the archive is less busy.

=== Buffer ===
Shorthand for [[#Review buffer|Review buffer]].

== C ==
=== Citation ===
In [[#EPrints repository software|EPrints repository software]] a citation means something slightly different from what in means in research publication.  For the former it refers to a text string describing a publication, which may more commonly described in research publications as a ''reference''.  

EPrints repository software has citation style files, which describe how to generate the text string, not just for [[#EPrint|eprints]] but also other [[#Data object|data objects]], each of which can have different citation style files for different purposes.  These files can be found under [[lib/citations/]]. [[flavours/pub_lib/citations/]] and the [[#Archive|archive]]'s ''cfg/citations/'' directory.  

See here for more information about the [[Citation Format|citation formats]] and a training video about [[Training_Video:Citation_Styles|citation styles]].

=== Core codebase ===
The core codebase refers to the main code directories of the [[#EPrints repository software|EPrints repository software]].  In some contexts this refers to all directories except the archives directory which contains the configuration for individual [[#Archive|archives]].  In other contexts this refers to just the following directories (i.e. excludes [[#Flavour|flavours]], [[#Ingredient|ingredients]] and [[#Site lib|site_lib]], as well as non-code directories).
* [[bin/]]
* [[cgi/]]
* [[lib/]]
* [[perl_lib/]]
* [[tools/]]

=== Contact page ===
This is a [[#Static page|static page]] that is accessible on an [[#Archive|archive]] at the equivalent URL to the following:
 https://example.eprints.org/contact.html
This page is intended to provided contact information, so to those accessing the archive can contact those responsible for it to report problems or ask questions.

This page can be found at ''EPRINTS_PATH/lib/lang/en/static/contact.xpage'' but should be copied to the archive's ''cfg/lang/en/static/'' directory for [[How_to_modify_static_pages|editing]].  The email address displayed on this page comes from the <tt>$c->{adminemail}</tt> in [[adminemail.pl]].

=== Contributor ===
Sometimes an [[#EPrint|eprint]] has a contributor who could not usefully be described as a [[#Creator|creator]] or [[#Editor|editor]].  The contributor [[#Metadata field|metadata field]] is intended to allow these people to be associated with the eprint.  As well as being able to add the contributor's family and given name, the type of contributor can be specified.  This list of types is defined in ''EPRINTS_PATH/lib/namedsets/contributor_type''.  If additional types are needed, then this file should be copied to the [[#Archive|archive]]'s ''cfg/namedsets/'' directory for editing.

=== Creator ===
Creator (or creators) is a [[#Metadata field|metadata field]] for an [[#EPrint|eprint]].  Sometimes this is alternatively referred to as author but creator is a more generic term better suited to audiovisual/artistic as well as more traditional research publication items.

A creator typically has several separate sub-fields:
* Given name (a.k.a. first name)
* Family name (a.k.a. surname)
* ID (typically email address)

=== CRUD API ===
CRUD API (Create, Read, Update Delete Application Programming Interface) refers to a programmatic interface used for the management of [[#Data object|data objects]].  It is often also referred to as the [[#REST API|REST API]] as when it is called over HTTP it meets the requirements of a REST API.

== D ==
=== Data flavour ===
As of [[#EPrints repository software|EPrints]] [https://www.eprints.org/uk/index.php/eprints-3.4/ 3.4] there are different flavours to service different purposes for a [[#Repository|repository]].  The data flavour is intended for repository hosted research data items, as opposed to research publications.

=== Data object ===
A [[:Category:Data Objects|data object]] is a single record made up of [[#Metadata field|metadata fields]]. [[#EPrints repository software|EPrints repository software]] has various types of data object.  The most prominent are:
* [[EPrint Object]]
* [[User Object]]
* [[Document Object]]
* [[File Object]]
All the data objects of the same type make a [[#Dataset|dataset]].

=== Dataset ===
A [[API:EPrints/DataSet|dataset]] is all the [[#Data object|data objects]] of a particular type within a single repository. (E.g. [[#EPrint|eprint]], [[#User|user]], [[#Document|document]], etc.).  Virtual datasets exist for subsets of datasets such as [[#Live archive|live archive]], [[#Review buffer|review buffer]], etc.

=== Depositing user ===
This is the user who created the [[#EPrint|eprint]] and has deposited it to the [[#Review buffer|review buffer]].

=== Details tab ===
This is a tab in a [[#Data object|data object]]'s [[#View page|view page]] that lists all its [[#Metadata field|metadata fields]] and their values.  Where a [[#Workflow|workflow]] exists for the data objects these metadata fields are separated into separate sections, depending on the workflow stage in which they appear.

=== Division ===
This is a generic term to refer to a part of an organisation or institution, at any level of its hierarchy.  A division may be a faculty, school, department, academic unit or even research group.  If [[#EPrints repository software|EPrints repository software]] is used outside an academic context other names for sub-divisions may be applicable.

Divisions is a default [[#Metadata field|metadata field]] in the [[#EPrint|eprint]] [[#Data object|data object]].  It allows one or more divisions to be selected from a hierarchical list provided by the the [[#Archive|archive]]'s [[#Subject tree|subject tree]].  This can in turn be used to generate a [[#Browse view|browse view]] for divisions.

=== Document ===
A [[Document Object|document]] is a [[#Second class data object|second class]] [[#Data object|data object]] in [[#EPrints repository software|EPrints repository software]].  Documents must be part of an [[#EPrint|eprint]] object.  Sometimes the term is used interchangeably with the actual document file (e.g. a PDF, Word document, etc.).  To avoid confusion, it is best to refer to a document within EPrints as a "document object".  A document object can be associated with multiple [[#File|file objects]].  Typically because derived files are generated to provide preview and thumbnail image but also because multiple files can be uploaded for a single document object.

=== Document content ===
Document content is a [[#Metadata field|metadata field]] for the [[#Document|document object]].  It allow selections of a single value from a pre-defined list (i.e. a [[#Named set|named set]]) metadata field.  The options provided are intended to help describe the version of the document (e.g. draft, submitted version, accepted, updated) within the publication lifecycle or other types of content that may be uploaded (e.g. supplemental, presentation, coverimage, metadata, bibliography, other).  These are based on the [http://eprints.lse.ac.uk/64948/1/LSE%20Library_Versions%20toolkit_Author_2008.pdf Versions toolkit for authors] but are analogous to other definitions, such as:
* Author's Original Manuscript (AOM) is equivalent to submitted.
* Accepted Manuscript (AM) is equivalent to accepted.
* Version of Record (VoR) is equivalent to published.

=== Document security ===
Document security is a [[#Metadata field|metadata field]] for the [[#Document|document object]].  It defines who can access document file and any files in derived document objects (e.g. [[#Preview image|preview images]]).  By default this is one of three values:
* public - anyone
* validuser - registered [[#User|users]] (for the [[#Archive|archive]]) only.
* staffonly - repository staff (i.e. [[#Editor|editor]] and [[#Repository administrator|repository administrator]] users) only.
If one of the last two option is applied with an [[#Embargo|embargo]] that expires on a certain date, then the security value for that document will be updated to ''public'' on that date.

=== Documents directory ===
This is a directory found under the [[#Archive|archive's]] directory structure, (i.e. ''EPRINTS_PATH/archives/ARCHIVEID/documents/'').  This is where the uploaded [[#Document|documents]] for an [[#EPrint|eprint]] are stored under the latter's own sub-directory (e.g. eprint 1234 has documents sub-directory ''documents/00/00/12/34/''). Each document is stored in its own two-digit sub-directory based on its ''pos'' [[#Metadata field|metadata field]], which is zero-padded if the number is less than 10. The sub-directory also stores derived "documents" for those uploaded (e.g. preview and thumbnail images).  It also stores [[#Revision file|revision files]] in the eprint's own ''revisions'' sub-directory.

== E ==
=== Editor ===
On [[#EPrints repository software|EPrints repository software]] '''editor''' could refer to one of two different things:
# A type of EPrints [[#User|user]] that has permissions to access some or all [[#Publication item|publication items]] in the [[#Review buffer|review buffer]] to make ammendments and either push the item to the [[#Live archive|live archive]] or return it to the [[#User workarea|user's workarea]].
# A [[#Metadata field|metadata field]] in the [[#EPrint|eprint]] [[#Data object|data object]] to record editors of the publication, e.g. the editors for a book.  Like [[#Creator|creator]], by default this field has family name, given name and ID (i.e. email address) sub-fields.

=== Education flavour ===
This is a [[#Flavour|flavour]] of [[#EPrints repository software|EPrints repository software]] version 3.4+. It is intended to produce repositories for open education.  I.e. for hosting files such as presentation slides, videos of lectures/seminars, instructions for learning tasks, in-class quizzes, etc.

=== Embargo ===
[[#Document|Documents]] added to an [[#EPrint|EPrint]] can have their access restricted.  Sometimes this access need only be restricted for a set amount of time.  These documents can be embargoed until a set embargo date.  These can then be lifted of this date using thge [[API:bin/lift_embargos|bin/lift_embargos]] script.  More recently embargoes allow a reason to be chosen from a pre-determined set of options provided by the ''embargo_reason'' [[#Named set|named set]].

=== EPM ===
EPM (EPrints Package Manager) is a package of functionality, sometimes referred to as a ''Bazaar plugin'', which can be installed in an automated fashion, typically from the [[#Bazaar|Bazaar]].  It can sometimes refer to the pages for managing the installing of these packages, (e.g. the [[Admin/System Tools/EPrints Bazaar|EPrints Bazaar]] page available through the [[Admin]] web interface).

=== EPrint ===
An [[EPrint Object|eprint]] is a [[#First class data object|first class]] [[#Data object|data object]] in [[#EPrints repository software|EPrints repository software]]. These are often referred to as ''[[#Items|items]]'' or ''[[#Publication record|publication records]]'' as they are generally intended hold [[#Metadata|metadata]] about a publication of some kind.

=== EPrint locking ===
Whilst a user is editing an [[#EPrint|EPrint]] it is best that another user does not try to edit it as well.  When an EPrint is locked even permitted users will not be able to edit the record unless they remove the edit lock.  Locks are automatically released when a user saves or cancels editing an EPrint or (by default) 1 hour after the user started editing the EPrint.
=== EPrint revision ===
An EPrint revision is a numbered version of the [[#EPrint|eprint's]] [[#Metadata|metadata]] stored in the ''rev_number'' [[#Metadata field|metadata field]].  Revisions of eprints metadata are exported as XML [[#Revision file|revision files]] and stored under the [[#Documents directory|documents directory]] of the [[#Archive|archive]].

=== EPrint status ===
The status of an [[#EPrint|eprint]] represent the stage it is in the depositing lifecycle.  By default in [[#EPrints repository software|EPrints repository software]] this can be one of four states:
# [[#User workarea|User workarea]] - The eprint is still being edited by the [[#Depositing user|depositing user]] as there is still metadata they need to add or change.
# [[#Review buffer|Review buffer]] - The eprint has been submitted for review by an [[#Editor|editor]] for the [[#Archive|archive]].
# [[#Live archive|Live archive]] - The eprint has been reviewed by the editor and they have deposited it into the live archive for public access.
# [[#Retired|Retired]] - The eprint has been removed from the live archive as it is not longer appropriate for it to have public access.

=== EPrint type ===
This is the type of publication the [[#EPrint|eprint]] represents.  The available types for a [[#Repository|repository]] are specified in a [[#Namedsets|namedsets]] file. ( ''lib/namedsets/eprint'' or ''flavours/pub_lib/namedsets/eprint'') or can be copied to the archive's [[archives/ARCHIVEID/cfg/namedsets/]] directory to add extra types for a specific archive.  By default [[#EPrints repository software|EPrints]]' [[#Publication flavour|publication flavour]] has the following type options:
 article
 book_section
 monograph
 conference_item
 book
 thesis
 patent
 artefact
 exhibition
 composition
 performance
 image
 video
 audio
 dataset
 experiment
 teaching_resource
 other
Type is by default presented on the first [[#Workflow stage|stage]] of the [[#EPrint workflow|EPrint workflow]], as the option chosen will affect the fields that can/need to be completed in later stages.

=== EPrint URI ===
The URI for an [[#EPrint|eprint]] is its globally unique identifier.  In a form like:
 http://example.eprints.org/id/eprint/1234
Technically, a URI only need be an identifier and therefore not return the resource itself.  However, in the case of [[#EPrints repository software|EPrints repository software]], this will return the resource.  Prior to EPrints 3.4, this would be by redirecting to the [[#EPrint URL|eprint URL]] but since then the [[#Publication flavour|publication flavour]] uses the same string for the eprints URL and URI with the old style URL redirecting the the longer URI format URL.

=== EPrint URL ===
The URL of an [[#EPrint|eprint]] is the location it can be found at on the World Wide Web.  Historically with [[#EPrints repository software|EPrints repository software] it has taken a form like:
 http://example.eprints.org/1234/
However, since EPrints 3.4, it has been possible to configure the URL to take a long format like that of the [[#EPrint URI|eprint URI]]:
 http://example.eprints.org/id/eprint/1234
By using the following setting (typically in the [[#Archive|archive]]'s ''cfg/cfg.d/[[20_baseurls.pl]]''): 
 $c->{use_long_url_format] = 1;
By making this change the old style URL will still work but will redirect to the new format.  The reason for the change was to make it more apparent that the URL represented a publication within EPrints repository.  Web crawlers and bots often record links (i.e. URLs) they find on web pages but they don't actually access them.  In particular [https://scholar.google.com Google Scholar] would disregard these URLs without checking them, as there was nothing from the URL to indicate they represented a publication.  By adding ''/id/eprint/'' into the URL it makes it the URL distinct from other common URLs of the form ''<nowiki>http://HOSTNAME/ID</nowiki>'', which are mostly not URLs for EPrints [[#Abstract page|abstract pages]].

=== EPrint view page ===
The view page for an [[#EPrint|eprint]] is a multi-tabbed management page for that particular item.  It can typically be reached by clicking on the ''View Item'' link towards the bottom of an eprint's [[#Abstract page|abstract page]].  This page will tend to have the following tabs:
# [[#Preview tab|Preview]] - What will the abstract page look like when the eprint is moved to the live archive.
# [[#Details tab|Details]] - The values for all the [[#Metadata field|metadata fields]] for the eprint.
# [[#Actions tab|Actions]] - All the actions that can be carried out against the eprint.
# [[#History tab|History]] - The [[#EPrint revision|revision]] history of the eprint.
# [[#Issues tab|Issues]] - The [[#Issue|issues]] detected for this eprint, if any.

=== EPrint workflow ===
This is the [[#Workflow|workflow]] that pertains specifically to the [[EPrint Object|eprint data object]].

=== EPrints repository software ===
Often shortened to just '''EPrints''' but not to be confused with multiple EPrint data objects. The actual software that can be used to create Open Access repositories and available as Open Source from [https://github.com/eprints/eprints3.4 GitHub].

=== EPrints path ===
The path on your operating system under which EPrints repository software is installed.  Guides on this wiki often use the placeholder <tt>EPRINTS_PATH</tt> to represent this.  Typically EPrints path will either be '''/opt/eprints3/''' or '''/usr/share/eprints/''' depending on how installed EPrints repository software was installed.

=== EPrints release ===
A release of the [[#EPrints repository software|EPrints repository software]].

=== EPrints version ===
Same as [[#EPrints release|EPrints release]] but with specific reference to a version number.

=== EPrints XML ===
[[#EPrints repository software|EPrints repository software]] has its own XML schema for defining how [[#Data object|data objects]] should be described.  This schema can be found at the equivalent URL to:
 http://example.eprints.org/cgi/schema

=== Event plugin ===
A type of [[#Plugin|plugin]] that generates [[#Indexer task|Indexer tasks]] to get the [[#Indexer|indexer]] to perform some asynchronous and potential long-running task.

=== Event queue ===
The event queue contains all generated and yet to be successfully completed [[#Indexer task|indexer tasks]].  It can be accessed through the [[#Admin menu|admin menu]]'s [[Admin/System Tools|System tools]] tab using the [[Admin/System Tools/Status|Status]] button and then clicking on the number next to the '''Background Task Queue'''.  There is also the [[Event Queue Object]], which is a [[#Data object|data object]] to represent an individual indexer task.

=== Export plugin ===
This is a [[#Plugin|plugin]] designed to provide a formatted export of a [[#Data object|data object]]'s [[#Metadata|metadata]], typically for an [[#EPrint|eprint]].  By default, [[#EPrints repository software|EPrints repository]] has export plugins for many different formats, which can be found in the ''[[perl_lib/EPrints/Plugin/Export/]]'' and ''[[flavours/pub_lib/plugins/EPrints/Plugin/Export/]]'' directories.  Bespoke export plugins can also be added to the archive's ''cfg/plugins/EPrints/Plugin/Export/'' directory or may be installed from the [[#EPrints Bazaar|EPrints Bazaar]] into the ''lib/plugins/EPrints/Plugin/Export/'' directory.

== F ==
=== File ===
A file is a [[#third class data object|third class]] [[#Data object|data object]].  This is because it is a sub-object of a [[#Document|document]] data object, which in turn is a sub-object of an [[#EPrint|eprint]] data object.  A file data object store metadata relevant to the file such as its filename, size, MIME type and modified time and a hash (by default MD5) to maintain the integrity of the file.  Typically uploading a document to an eprint will only create a single data object but it is possible to add additional files to a document after it is uploaded.

File data objects are also used to capture XML [[#Revision file|revision files]] created for the [[#EPrint history|eprint's history]].

=== First class data object ===
[[#Data object|Data objects]] in [[#EPrints repository software|EPrints repository software]] take a particular order.  First class data objects are those that are not a sub-objects of other data objects, such as:
* [[#EPrint|eprint]]
* [[#User|user]]
Other data object may be described as either [[#Second class data object|second class]] or [[#Third class data object|third class]].  Usually a data object is only described as "first class" if it contains sub-objects.  Technically, [[#Subject|subject]] is a first class data object but as it contains no sub-objects, it in unnecessary to make the distinction.

=== Flavour ===
From version 3.4 of [[#EPrints repository software|EPrints repository software]] different flavours have been introduced.  EPrints was originally designed as a [[#Repository|repository]] for research publications but over the years it has been repurposed for different tasks, which has led to the codebase getting a little messy.  So in [https://www.eprints.org/uk/index.php/eprints-3.4/ EPrints 3.4] a separate sub-directory structure was created to store code and configuration that makes EPrints suitable for a particular task, (i.e. a flavour).  There are three main flavours but most development has continued to focus on research publication:
# [[#Publications flavour|Publications flavour]] - For research publications.  Provided in ''[[flavours/pub_lib/]]''.
# [[#Data flavour|Data flavour]] - For research data.  Provided in ''flavours/data_lib/''.
# [[#Education flavour|Education flavour]] - For Open Education, i.e. teaching materials.  Provided in ''flavours/edu_lib/''.
As well as flavours in EPrints 3.4, there are also ''[[#Ingredients|ingredients]]'', which provide additional functionality, similar to a [[#Bazaar plugin|Bazaar plugin]] / [[#EPM|EPM]].  Any EPrints flavour has an ''inc'' file found in its top-level directory (e.g. ''flavours/pub_lib/inc'').  This tells the flavour which paths to include.  By default, this would include the flavour itself.  It may also contain various ingredients and potential [[#Site lib|site lib]] if the [[#Repository|repository]] has multiple [[#Archive|archives]], which require the same bespoke functionality.  However, it is better if this bespoke functionality can be converted into ingredients to separate out discrete parts of functionality.

== G ==
== H ==
=== Help text ===
A help text is associated with a [[#Metadata field|metadata field]], providing advice on how this should be filled in as part of the [[#Workflow|workflow]].  This text is defined using a [[#Phrase|phrase]].  E.g. the phrase ID for the ''title'' metadata field of the [[#EPrint|eprint]] [[#Data object|data object]] is ''eprint_fieldhelp_title''.

=== History tab ===
This tab refers to [[#EPrint history|eprint history]] or [[#User history|user history]] both make reference to changes between [[#EPrint revision|EPrint revisions]].

=== Homepage ===
The homepage for an [[#Archive|archive]] is found at the top-level URL for a repository.  Usually, that is something like:
 https://example.eprints.org/
The homepage is a [[#Static page|static page]] although often contains dynamic elements, like the list of latest publications.  By default, the file is located at either ''[[lib/lang/en/static/|lib/lang/en/static]]/index.xpage'' or ''[[flavours/pub_lib/lang/en/static/|flavours/pub_lib/lang/en/static]]/index.xpage'' with the latter taking precedence if it exists.  Configuration for the archive ensure this page display bespoke information for your archive such as the [[#Archive name|archive name]].  However, you will most likely want to [[How_to_modify_static_pages|make changes to your homepage]], so you should copy the appropriate ''index.xpage'' to your archive's ''cfg/lang/en/static/'' directory, creating the directory if it does not already exist.

== I ==
=== Import plugin ===
This is a [[#Plugin|plugin]] designed to provide a formatted import of [[#Metadata|metadata]] for a [[#Data object|data object]], typically for an [[#EPrint|eprint]].  By default, [[#EPrints repository software|EPrints repository]] has import plugins for numerous different formats, which can be found in the ''[[perl_lib/EPrints/Plugin/Import/]]'' and ''[[flavours/pub_lib/plugins/EPrints/Plugin/Import/]]'' directories.  Bespoke import plugins can also be added to the archive's ''cfg/plugins/EPrints/Plugin/Import/'' directory or may be installed from the [[#EPrints Bazaar|EPrints Bazaar]] into the ''lib/plugins/EPrints/Plugin/Import/'' directory.

=== Inbox ===
Same as [[#User workarea|User workarea]].

=== Inc file ===
The ''inc'' file is the critical part of a [[#Flavour|flavour]], which defines the paths that should be included for code and configuration.  It is found in the top-level directory of the flavour (e.g. ''/flavours/pub_lib/inc''). Initially from the first sub-version of [[#EPrints repository software|EPrints]] 3.4 this will be just the path for the flavour (e.g. ''flavours/pub_lib'') but increasingly core [[#Ingredient|ingredients]] will be added to this (e.g. for providing integration with the [[#Bazaar|Bazaar]] or for enabling different JavaScript libraries.  This is the only file outside the [[Archives/ARCHIVEID/|archive's directory structure]] that should need to be modified, unless you have a [[#Site lib|site_lib]].  However, the default inc file will probably not need changing in the case of most [[#Repository|repositories]].

The ordering of paths within the inc file is important, as it determines, which configuration files get loaded an which takes precedence.  If you have a configuration file with the same filename in the ''cfg.d/'' directories for all three paths in the example inc file below, the file in ''site_lib'' will be used in precedence to the other two:
 flavours/pub_lib
 ingredients/bazaar
 site_lib
However, if you also have the same filename is the [[#Archives|archive]]'s ''cfg/cfg.d/'' directory this will take precedence, although only for that archive, if you have a multi-archive repository.

=== Indexer ===
The indexer is used by [[#EPrints repository software|EPrints repository software]] to carry out asynchronously tasks that may take a long time.  Typically, this would be indexing tasks, which include indexing of both the [[#Metadata|metadata]] for an [[#EPrint|eprint]] [[#Data object|data object]] and the full text (i.e. all the words in the PDF, Word, etc. document) for [[#Document|documents]] uploaded for those eprints.

The Indexer can be managed through the [[#Admin menu|admin menu]] specifically, its [[Admin/System Tools|System Tools]] tab, which provides options to stop, start and force start the indexer.  Also, the [[Admin/System Tools/Status|Status]] option takes you to a page that lists the number of [[#Indexer tasks|tasks]] yet to be successfully completed by the indexer.  Commonly referred to as the ''[[#Events queue|event queue]]'' or ''background task queue''.

=== Indexer task ===
An indexer task is a scheduled operation to be carried out by the [[#Indexer|indexer]].  It is also a [[#Data object|data object]] in its own right but in this context is referred to as an [[Event Queue Object]].  As until it is successfully completed it will appear in the [[#Event queue|event queue]].  An indexer task has several significant attributes:
* Status - Whether the task is ''Waiting'', ''In Progress'' or ''Failed''.
* Start time - The earliest time the indexer task can start.
* Plugin - The [[#Event plugin|Event plugin]] that can perform this indexer task.
* Action - The specific action of the Event plugin for this indexer task.
* Parameters - The parameters needed to run the indexer task (e.g. the data object and potentially [[#Metadata field|metadata fields]] to be used by the indexer task.

=== Ingredient ===
Since [[#EPrints repository software|EPrints]] version 3.4, the concept of [[EPrints Ingredients|ingredients]] has been introduced along with [[#Flavour|flavours]].  The main purpose of ingredients is to allow complex functionality to be developed but deployed in a way that does not make a mess of the existing [[#Core codebase|core codebase]] by spewing files in different places, like some [[#Bazaar plugin|Bazaar plugins]] can do.  Also, as Bazaar plugins are designed to be one-click install, they should require limited configuration, as this takes away from ease of deployment that one-click install implies.  Instead, ingredients can be much more complex.  Although effort should be taken to avoid mixing distinctly separate pieces of functionality when they could be kept apart.  

Typically, an ingredient would be deployed by checking out a tagged version of the Git repository for that ingredient on [https://github.com/ GitHub].  Although that requires more technical knowledge than a one-click install, this is also inherently a safety feature, to avoid accidental installation of new functionality that could damage the data stored by the [[#Repository|repository]], which could happen when installing some of the more complex Bazaar plugins, without understanding of how they behave.

=== Issue ===
An issue is a secondary [[#Data object]] defining a potential problem discovered about an [[#EPrint|eprint]] [[#Data object|data object]]. Unlike validation errors for specific [[#Metadata fields|metadata fields]] displayed whilst navigating the [[#EPrint workflow|eprint workflow]] issues are determined by comparing eprints across the [[#Dataset|dataset]] or checking for more subjective problems.  By default this includes:
* Duplicate titles - Two or more eprints have the exact same title.
* Similar titles - Two or more eprints share very similar titles.
* Old but unpublished - Date set for eprint is more than two years in the past but its publication status is still not published.
* Short family name - Family name for a creator is less than two characters or not set.  (Single name creators should always put this under family name).
Issues are checked for across all eprints in the [[#Live archive|live archive]] and [[#Review buffer|review buffer]] through a scheduled task running the ''bin/issues_audit'' script.  This can be deployed with a cron job similar to the following in the ''eprints'' user's crontab (substituting ''EPRINTS_PATH'' and ''ARCHIVEID'' as appropriate''):
 38 23 * * * EPRINTS_PATH/bin/issues_audit ARCHIVEID --quiet
Additional types of issue can be added in one of two ways:
# Creating a new Issues [[#Plugin|plugin]].
# Adding XML markup to the [[#Archive|archive]]'s ''cfg/issues.xml''.
Issues for a particular eprint can be found under its [[#Issues tab|Issues tab]] of its [[#EPrint view page|view page]] or searched for through the [[#Admin menu|admin menu]]'s [[Admin/Editorial Tools/Search issues|Search issues]] tool (under the [[Admin/Editorial Tools|Editorial Tools]] tab).

=== Issues tab ===
This is a tab that appear on the [[#EPrint view page|eprint view page]] and lists the [[#Issue|issues]] associated with that [[#EPrint|eprint]].

=== Item ===
Same as [[#EPrint|eprint]].

== J ==
== K ==
== L ==
=== Latest tool ===
The latest tool is a piece of functionally that allows JavaScript to be used to include a dynamically updating list of the latest [[#EPrint|eprints]] to be put into the [[#Live archive|live archive]] on to a [[#Static page|static page]] like the [[#Homepage|homepage]].  This is provide through a script that can be requested at the equivalent following URL:
 http://example.eprints.org/cgi/latest_tool
It can be configured in the archive's ''cfg/cfg.d/[[latest_tool.pl]]'' to set the number of eprints shown and the [[#Citation|citation]] style used.

=== License ===
Sometimes spelt ''licence'', is the licence under which a [[#Document|document]] is made available in an [[#Archive|archive]].  By default, [[#EPrints repository software|EPrints repository software]] provides the [https://creativecommons.org/licenses/|Creative Commons (v4) licenses] as options in the [[#Namedset|named set]] file ''licenses'' in [[lib/namedsets/]]. These include:
* [https://creativecommons.org/licenses/by/4.0/ Creative Commons Attribution 4.0 International]
* [https://creativecommons.org/licenses/by-sa/4.0/ Creative Commons: Attribution-ShareAlike 4.0 International]
* [https://creativecommons.org/licenses/by-nc/4.0/ Creative Commons: Attribution-NonCommercial 4.0 International]
* [https://creativecommons.org/licenses/by-nd/4.0/ Creative Commons: Attribution-NoDerivatives 4.0 International]
* [https://creativecommons.org/licenses/by-nc-sa/4.0/ Creative Commons: Attribution-NonCommercial-ShareAlike 4.0 International]
* [https://creativecommons.org/licenses/by-nc-nd/4.0/ Creative Commons: Attribution-NonCommercial-NoDerivatives 4.0 International]
* [https://creativecommons.org/licenses/publicdomain/ Creative Commons: Public Domain Dedication]
* [https://creativecommons.org/licenses/GPL/2.0/ Software: Creative Commons: GNU GPL 2.0]
* [https://creativecommons.org/licenses/LGPL/2.1/ Software: Creative Commons: GNU LGPL 2.1]

=== Live archive ===
Live archive refers to both the [[#EPrint status|status]] or an [[#EPrint|eprint]] as well as a [[#Virtual dataset|virtual dataset]] of all eprints that have their status set to ''live archive''.  When an editor reviews and is happy with an eprint, they will change its status to live archive, so it becomes publicly accessible.

== M == 
=== Main menu ===
The [[#EPrints repository software|EPrints]] main menu by default contains links to the main pages of interest for a visitor to an [[#Archive|archive]], this includes:
* Home - A link back to the archive's [[#Homepage|homepage]].
* About - A [[#Static page|static page]] providing information about the archive.
* Browse - A listing of browse views available for the archive.
** Browse by Year
** Browse by Subject
** Browse by Division
** Browse by Author

=== Metadata ===
[[Metadata]] is all the values for the [[#Metadata field|metadata fields]] for a particular [[#Data object|data object]].

=== Metadata field ===
A [[:Category:EPrints_Metadata_Fields|metadata field]], sometimes shortened to '''metafield''' (or even just ''field'') is part of a [[#Data object|data object]] and store a particular piece of pieces of information for that data object.  Metadata fields have different [[:Category:EPrints_Metadata_Fields#Metadata Field Types|types]] and have different types of properties roughly broken down into the following categories:
* '''[[:Category:EPrints_Metadata_Fields#Core Properties|Core]]''' - This includes the ''name'', aforementioned ''type'', whether it should have ''multiple'' values and whether to add an SQL index for it.
* '''[[:Category:EPrints_Metadata_Fields#Rendering Properties|Rendering]]''' - This includes how the render the metadata field within [[#Abstract page|abstract pages]], [[#Browse view|browse views]] and search results, where applicable.
* '''[[:Category:EPrints_Metadata_Fields#Input and Validation Properties|Input and validation]]''' -  This is includes how to display the input for the metadata field within a [[#Workflow|workflow]] and any additional functionality to how this field is used of subsequently validated.
* '''[[:Category:EPrints_Metadata_Fields#Ordering, Indexing and Searching|Ordering, indexing and searching]]''' - Whether the metadata field should be included in [[#EPrints repository software|EPrints repository software]]'s full-text indexing and how the data object can be ordered or search over using this field.
* '''[[:Category:EPrints_Metadata_Fields#Other Properties|Other]]''' - Miscellaneous properties, such as whether the metadata field's value(s) should be copied across to a cloned version of the data object or be able to be set through an import.  Also, whether the field its value should appear in various management pages within the [[#Repository|repository]] or in exports.

=== Minimal User ===
Sometimes also referred to as "min user".  This is a type of user account that only has minimal access to an [[#Archive|archive]].  Typically, these accounts are intended for those users that may need to access restricted [[#Document|documents]] but do not need to submit their own [[#EPrint|eprints]].  Also, if you have open [[#User registration|user registration]] enabled, you may want to prevent newly registered users from submitting eprints until you can confirm you are happy with their registration.

== N == 
=== Named set ===
A [[Namedset_field|named set]] refers to both a type of [[#Metadata field|metadata field]] with the type name ''namedset'' and the file that defines the options for this type of metadata field.  A named set metadata field is much like a ''set'' field.  However, rather than defining the options within [#EPrints repository software|EPrints repository software]]'s Perl-based configuration, they can be added to a simple text file where each new option is separated by a new line.  Such as for [[#EPrint type|eprint types]].  

Named set files by default can be found in either the [[lib/namedsets/]] or [[flavours/pub_lib/namedsets/]] directories.  If you need to edit them to add or remove options, then the file should be copied to the [[#Archive|archive]]'s ''cfg/namedsets/'' directory before editing.  It is generally advised not to modify an option in this file once your archive is in use.  It is better to change the [[#Phrase|phrase]] that relates to that option.  E.g.  the ''type'' field for an ''[[#EPrint|eprint]]'' would have the phrase <tt>eprint_typename_article</tt> for the value ''article'' in ''flavours/pub_lib/namedsets/eprint''.

== O ==
=== OAI-PMH ===
[https://www.openarchives.org/pmh/ Open Archives Initiative - Protocol for Metadata Harvesting (OAI-PMH)] is a standard for harvesting metadata from Open Acesss [[#Archive|repository archives]] like those provided by [[#EPrints repository software|EPrints repository software]].  For this EPrints has a [[OAI_FAQ|separate interface for accessing OAI-PMH]], which is available at the equivalent following URL:
 http://example.eprints.org/cgi/oai2

=== Order key ===
An '''order key''' or '''orderkey''' is the (potentially language-specific) string used to order by a particular[[#Metadata field|metadata field]]. [[#EPrints repository software|EPrints repository software]]'s default orderkey generation can be overridden by defining your own orderkey method and assigning it to the ''make_value_orderkey'' or ''make_single_value_orderkey'' property of the metadata field. This property is passed value(s) and returns (an) ''ordervalue'' string(s) after processing the value(s) for that metadata field.  Typically, you may want to define your own order keys to manage special characters, maybe to avoid accented characters appearing separately in a browse view.  Some examples of bespoke order keys can be found in [[make_orderkey.pl]].

== P ==
=== Plugin ===
These are Perl modules that "Plug in" to the EPrints software to provide a particular piece of functionality.  Default plugins for [[#EPrints repository software|EPrints repository software]] can be found under the ''[perl_lib/EPrints/Plugin/]'' and ''[flavours/pub_lib/plugins/EPrints/Plugin/]]'' directories  They break down into several categories.  The most prominent being:
* [[EPrints Glossary#Export plugin|Export plugins]]
* [[EPrints Glossary#Import plugin|Import plugins]]
* [[EPrints Glossary#Screen plugin|Screen plugins]]
Other plugin categories include [[#Box plugin|Box]], Convert, [[#Event plugin|Event]], InputForm, [[#Issues Plugin|Issues]], Search and Storage.  

[[How_to_contribute#Write_a_Plugin|Bespoke plugins]] can be written for an [[#Archive|archive]] and located in the archive's ''cfg/plugins/EPrints/Plugin/'' directory.

Often the term "[[#Bazaar plugin|Bazaar plugin]]" is used to refer to a package of functionality (a.k.a. [[#EPM|EPM]]) that can be installed from the [[#Bazaar|Bazaar]].  Although an EPM can often contain individual plugins, it is a complex set of files rather than a single plugin file.  If an EPM does contain individual plugins, they will be installed to the ''lib/plugins/EPrints/Plugin/'' directory.

=== Phrase ===
A phrase in [[#EPrints repository software|Prints repository software]] is some text or HTML markup associated with an associated placeholder ID defined using [[Phrase_Format|EPrints' bespoke XML markup]].  Phrases have various purposes.  One is to ensure consistent use of terminology throughout the [[#Archive|archive]].  It also essential for supporting multi-language archives.  They are used for defining all [[#Metadata field|metadata field]] names and their [[#Help text|help texts]].  They are also used extensively in [[#Screen plugin|screen plugins]] to allow them to be customised with informative messages.

A prominent example of a phrase is an archive's name which is appears in the archive's ''[[archives/ARCHIVEID/cfg/lang/en/phrases/|cfg/lang/en/phrases]]/archive_name.xml'', as follows:
 <epp:phrase id="archive_name">Example Archive</epp:phrase>

=== Policies page ===
The policies page is a [[#Static page|static page]] available at the equivalent URL to:
 http://example.eprints.org/policies.html
The page contains policies for use of the [[#Archive|archive]] typically based on [https://scholarlycommunications.jiscinvolve.org/wp/2020/04/03/an-update-from-opendoar-policy-support-and-repositories-galore/ OpenDOAR].  This contains sections for:
* '''Metadata Policy''' stating the access rights and permissions for information describing items in the repository, and the minimum metadata requirements.
* '''Data Policy''' stating the access rights and (re-)use permissions for full-text and other full data items.
* '''Content Policy''' stating the types and versions of documents and datasets held.
* '''Submission Policy''' concerning eligible depositors, quality control and copyright statements.
* '''Preservation Policy''' concerning the long-term retention, migration, and withdrawal protocols.

=== Preview image ===
This is a thumbnails or larger image that is a snapshot of the uploaded [[#Document|document]].  This is typically displayed on the [[#Abstract page|abstract page]], where hovering over it will display a larger version, which may be useful in determining if the document in the one the [[#Visitor|visitor]] expected.  Preview images for a document can be generate from the command line using the [[API:bin/epadmin|epadmin]] command's ''redo_thumbnails'' option.

=== Preview tab ===
The preview tab is part of the [[#EPrint view page|eprint view page]] which displays a preview of the [[#Abstract page|abstract page]] for the [[#EPrint|eprint]].

=== Publication flavour ===
This is a [[#Flavour|flavour]] of [[#EPrints repository software|EPrints repository software]] version 3.4+.  It is intended to produce [[#Repository|repositories]] for research publications.  This code for this flavour was separated from the [[#Core codebase|core codebase]] for EPrints 3.4, so that EPrints as a whole could be more easily customisable for other purpose such as [[#Data flavour|research data]] and [[#Education flavour|open education]].  The separated code and configuration can be found under [[flavours/pub_lib/]], where configuration files override those under [[lib/]] but are overriden by those at an [[#Archive level|archive level]].

=== Publication record ===
Same as [[#EPrint|eprint]].

== Q ==
== R ==
=== Regular user ===
This is a [[#User|user]] whose account provides them with standard access to an [[#Archive|archive]] allowing then to deposit [[#EPrints|eprints]] for [[#Review buffer|review]] and manage their [[#User profile|user profile]].  With [[#EPrints repository software|EPrints repository software]] this type of user account just referred to as "user".  When describing this user, the adjective "regular" is used to distinguish this specific type of user from users more generally.

=== Repository ===
This is an individual installation of the [[#EPrints repository software|EPrints repository software]] onto a server.  A repository may host many [[#Archives|archives]] but they all use the same [[#Core codebase|core codebase]].  Sometimes a repository will host only a single archive and therefore, the terms repository and archive are often used interchangeably and often the latter is referred to as a "repository archive".

=== Repository admin ===
Short for repository administrator, this is a level of [[#User|user]] account that give maximum access to an [[#Archive|archive]].  Allowing the user to carry out [[#Regular user|regular user]] actions such as depositing an [[#Eprint|eprint]], [[#Editor|editorial]] actions like reviewing eprints submitted by a regular user and adminstrative actions, in particular those available through the [[#Admin menu|admin menu]].

=== Request ===
This is a [[#Data object|data object]] that relates to a request made by a [[#User|user]] or visitor about a specific [[#EPrint|eprint]] or [[#Document|document]].  The most common request is [[#Request copy|request copy]] by a visitor for access to a document that is [[#Document security|restricted]].  In some [[#Archive|archives]] it may also be enabled to allow users to submit change requests to eprints in the [[#Live archive|live archive]], if they notice an error in their [[#Metadata|metadata]].

=== Request copy ===
Sometimes also referred to as "request a copy" this is a button or link on an [[#Abstract page|abstract page]], allowing a visitor to request a copy of a [[#Document|document]] that is [[#Embargo|currently]] [[#Document security|restricted]].  If the [[#EPrint|eprint]] has its ''contact email'' [[#Metadata field|metadata field]] this will email that address with the request sent by the visitor.  If that email addresses matches that of a [[#User|user]] the email sent will contain accept and reject links.  Where the former will provide a link in the email response to the visitor, giving them temporary access to the restricted document.

=== REST API ===
[[#EPrints repository software|EPrints repository software]] provides a standard [https://www.redhat.com/en/topics/api/what-is-a-rest-api REST API] that allows third-party applications to create, read, update and destroy various [[#Data object|data objects]] within an [[#Archive|archive]].  In EPrints, the REST API provides similar functionality to the [[#CRUD API|CRUD API]], albeit under a URL path like:
 https://example.eprints.org/rest/

=== Retired ===
This is an [[#EPrint status|eprint status]] for [[#EPrint|eprints]] that have been in the [[#Live archive|live archive]] but have been removed for some reason.  The advantage of retirng an eprint rather than deleting it, is that it can be restored, if it was removed erroneously from the live archive.  Also, the [[#Abstract page|abstract page]] will display a message saying the eprint has been removed rather than a "404 Not Found".

=== Review buffer ===
This is an [[#Eprint status|eprint status]] of [[#EPrint|eprints]] that have be deposited by a [[#User|user]] but need to be reviewed by an [[#Editor|editor]] before being added to the [[#Live archive|live archive]].  Review buffer also refers to all eprints that currently have this status and can be accessed view the ''Review'' link in the [[#User menu|user menu]].

=== Revision ===
Often used as shorthand for [[#EPrint revision|EPrint revision]].
=== Revision file ===
This is a file on disk that stores [[#EPrints XML|EPrints XML]] markup for the [[#Metadata|metadata]] for a [[#Data object|data object]].  By default, revision files are only generated for [[#EPrints|eprints]] and can be found within the ''revisions'' directory for that eprint's ''documents'' sub-directory.  E.g.
 EPRINTS_PATH/archives/ARCHIVEID/documents/disk0/00/00/00/01/revisions/1.xml
The revisions are used in an eprint's [[#History tab|history tab]] to generate a listing of changes between one [[#EPrint revision|revision]] and the next.

== S ==
=== Saved search ===
This is a [[#Secord class data object|second class]] [[#Data object|data object]] that records the criteria of a particular search made by a [[#User|user]].  Its purpose is to allow the user to receive regular email updates about results that meet this criteria.

=== Screen plugin ===
This is a [[#Plugin|plugin]] designed to provide a "screen", which is effectively a dynamic page to allow the [[#User|user]] to carry out some action on the [[#Archive|archive]].  Some of the most significant screen plugins are for:
# Logging in and out of the archive.
# Managing a [[#Data object|data object]]'s [[#Workflow|workflow]].
# Providing the [[#Admin menu|admin menu]].
# Reviewing [[#EPrint|eprints]].
# Editing [[#Subject|subjects]].
# Searching for users or eprints.
By default, screen plugins can be found in the ''[[perl_lib/EPrints/Plugin/Screen/]]'' directory.  Bespoke screen plugins can also be added to the archive's ''cfg/plugins/EPrints/Plugin/Screen/'' directory or may be installed from the [[#EPrints Bazaar|EPrints Bazaar]] into the ''lib/plugins/EPrints/Plugin/Screen/'' directory.

=== Second class data object ===
These are [[#Data object|data objects]] that are [[#Sub-object|sub-objects]] of a [[#First class data object|first class data object]].  These include:
* [[Document Object]] (sub-object of [[#EPrint|eprint]]).
* [[History Object]] (sub-object of [[#EPrint|eprint]] or potentially any data object that has its history recorded).
* [[Saved Search Object]] (sub-object of [[#User|user]]).

=== Simple search ===
A simple search over [[#EPrint|EPrints]] in the [[#Live archive|live archive]].  Unlike [[#Advanced search|advanced search]] this provides a simgle input field to search against multiple [[#Metadata field|metadata fields]].  Simple search configuration can be found in [[eprint_search_simple.pl]].
=== Site lib ===
Creating a directory in the [[#EPrints path|EPrints path]] with the name ''site_lib'', will allow you modify [[#Core codebase|core code and configuration]], which will apply to all of the [[#Archives|archives]] in your [[#Repository|repository]].  If you are running EPrints version 3.4+, be sure to also add ''site_lib'' to your [[#Flavour|flavour's]] [[#Inc file|inc file]].

Sometimes you may need modify the functionality of files in the core codebase but you don't want to change them, as this will involve having to merge any future changes when you upgrade [[#EPrints repository software|EPrints repository software]].  This is particularly useful if you need to modify a non-plugin code file, ([[#Plugin|plugin]] files can be [[Instructions_for_local_plugins|overriden]] by [[#Archive level|archive level]] versions), E.g. ''[[API:EPrints/Repository|perl_lib/EPrints/Repository.pm]]'', which can simply be copied to ''site_lib/EPrints/plugins/Repository.pm'' rather than modifying it in place.  However, when you do upgrade EPrints, you will still need to reconcile any updates to the ''perl_lib/'' version of this file with your version in ''site_lib/plugins/''.  This will be a much more straightforward task, (than if you had just modified the version in ''perl_lib/''), as both files will still be in place to compare.  One particular use of ''site_lib'' is for inter-version patches from [https://github.com/eprints/eprints3.4|EPrints' GitHub].  As when it comes to an upgrade, the versions of the files in ''site_lib/plugins/'' can just be removed, as their modifications will be present in their ''perl_lib/'' equivalents.

=== Staff search ===
Search across all [[#EPrint|EPrints]] whatever their [[#EPrint status|EPrint status]].  See [[Admin/Editorial Tools/Search items]] for more information.
=== Static page ===
This is a page for an [[#Archive|archive]] that contains static content that can be cached.  Although it may also contain dynamic elements through the use of JavaScript and [https://en.wikipedia.org/wiki/Ajax_(programming) Ajax].  Examples of static pages are:
* The [[#Home page|home page]]
* The about/information page (e.g. <tt>http://example.eprints.org/information.html</tt>)
* The [[#Contact page|contact page]] 
* The [[#Policies page|policies page]]
To clear the caches of old static pages and other static content (like JavaScript and CSS) and generate new cached versions, the [[API:bin/generate_static|bin/generate_static]] command can be used.

Other pages like [[#Browse view|browse view]] menus and listings and [[#Abstract page|abstract pages]] are also cached as they contain static content, which only need be updated periodically or when the underlying [[#EPrint|eprint]] changes.  These are sometimes also referred to as static pages but can be refreshed using [[API:bin/epadmin#|bin/epadmin]] command (or through the [[Admin/System Tools|Admin menu]]) or regenerated using the [[API:bin/generate_views|bin/generate_views]] and [[API:bin/generate_abstracts|bin/generate_abstracts]] comands.

=== Sub-object ===
This is a concept where a [[#Data object|data object]] is part of another data object, such as a [[#Document|document]] being part of an [[#EPrint|eprint]].  Where the former is known as a [[#Second class data object|second class data object]] and the latter is known as a [[#First class data object|first class data object]].  

[[API:EPrints/DataObj/SubObject|EPrints::DataObj::SubObject]] is an abstract class within [[#EPrints repository software|EPrints repository software]], which second class (and [[#Third class data object|third class]]) data object classes extend.

=== Subject ===
A [[Subject Object|subject]] is a [[#Data object|data object]] that stores a node for the [[#Subject tree|subject tree]] of an [[#Archive|archive]].  

A subject has three separate [[#Metadata field|metadata fields]] to describe the value it represents:
* '''ID''' - A short text string providing the unique ID for that subject.
* '''Name''' - The human-readable name for that subject.
* '''Sort value''' - The value used to determine the ordering of the subject amongst its siblings in the subject tree (e.g. in a [[#Browse view|browse view]]).

A subject also contains a '''parent''' metadata field that links it into the rest of the subject tree and a '''depositable''' metadata field that indicate whether it is an option that can be selected when the subject tree or part thereof is used to provide a metadata field for another data object (e.g. [[#EPrint|eprint]]).

=== Subject tree ===
This is made up of [[#Subject|subject]] [[#Data object|data objects]] and is used to provide hierarchical sets of options for various [[#Metadata field|metadata fields]] or other data objects, such as [[#EPrint|eprints]], as a [[Subject_field|subject metadata field]].  In particular:
* '''eprint subjects''' - Records one or more subjects (e.g. from the Library of Congress or Dewey decimal classifications) under which the publication represented by this eprint covers.
* '''eprint [[#Division|divisions]]''' - Records one or more divisions within an organisation/institution (e.g. faculty, school, department, etc.) for which authors of the publication represented by the eprint are members.
The subject tree can be edited by the [[#Admin menu|admin menu]] using the "[[Admin/Config. Tools/Edit subject|Edit subject]]" page.

=== Succeeds ===
An [[#EPrint|eprint]] [[#Data object|data object]] contains a [[#Metadata field|metadata field]] called ''succeeds''.  This metadata field can store the ID of an eprint for which the current eprint supersedes.  This may be used where a new version of the publication is produced but you don't want to or cannot replace the [[#Document|document]] in the original eprint.  By using the succeeds field, the original eprint will be removed from search and its [[#Abstract page|abstract page]] will display a warning saying it is not the latest version of the eprint.

=== Summary page ===
Same as [[#Abstract page|Abstract page]].  Sometimes even referred to as the abstract/summary page.
=== Summary table ===
A table on an [[#Abstract page|Abstract page]] that lists the names and values for specific [[#Metadata fields|Metadata fields]] for the [[#EPrint|EPrint]].  These can be specified, typically in the archive's ''cfg/cfg.d/[[eprint_render.pl]]'', under <tt>$c->{summary_page_metadata}</tt>.

=== Sword API ===
This is an API provided by [[#EPrints repository software|EPrints repository software]] that complies with the [https://guides.dataverse.org/en/latest/api/sword.html SWORD specification]] for a RESTful API.  It is similar to EPrints' [[#CRUD API|CRUD]] and [[#REST API|REST]] APIs but is intended to facilitate smoother interoperability between different types of Open Access repository, using an [https://datatracker.ietf.org/wg/atompub/about/ atompub]] based XML format and the [https://www.dublincore.org/specifications/dublin-core/dcmi-terms/ Dublin Core schema] for [[#Metadata|metadata]] terms.

== T ==
=== Template ===
=== Theme ===
=== Third order data object ===
These are [[#Data object|data objects]] that are sub-objects of [[#Second class data object|second class data objects]] to exist, which in turn are sub-objects of [[#first class data object|first class data objects]].  The main example of such a data object in [[#EPrints repository software|EPrints repository software]] is a [[#File|file]] data object.
 File --sub-object of--> Document --sub-object of--> EPrint

== U ==
=== User ===
A [[User Object|User]] is a [[#First class data object|first class]] [[#Data object|Data object]] in [[#EPrints repository software|EPrints repository software]].  It represent a user of [[#Repository|Repository]] and provides an account under which that user can login.  Storing [[#Metadata|metadata]] about that user, such as their username, given and family names, email address, department, etc.

=== User history ===
=== User menu ===
=== User registration ===
=== User review scope ===
=== User search ===
A form for searching across the [[#User|users]] in a [[#Repository|repository]].  See [[Admin/Editorial Tools/Search users|here]] for more information.
=== User profile ===
A page displaying the [[#Metadata|metadata]] about a [[#User|user]].  This often links to a page where these metadata can be modified.
=== User workarea ===
This is the status of an [[#EPrint|EPrint]] whilst it is being edited by the [[#Depositing user|depositing user]].  This status is often also referred to as [[#Inbox|inbox]].  User workarea can sometimes refer to the ''Manage deposits'' page where the current [[#User|user]] can see a listing of all the EPrints they have created.

== V ==
=== View page ===
The view page displays information about a [[#Data object|data object]], typically an [[#EPrint|eprint]].  This is why "view page" is often used as shorthand for [[#EPrint view page|eprint view page]].

=== Virtual dataset ===
A virtual [[#Dataset|dataset]] is one that is derived from a real dataset.  In particular, [[#EPrints repository software|EPrints repository software]] has virtual datasets for:
* [[#Live archive|Live archive]] 
* [[#Review buffer|Review buffer]] 
* [[#User workarea|User workarea]] 
* [[#Retired|Retired]] 
All of these are sub-sets of the [[#EPrint|eprint]] dataset where the [[#EPrint status|eprint status]] is a particular value.  

Additional virtual datasets can be configured for a [[#Repository|repository]] or at an [[#Archive level|archive level]]. 

=== Virtual field ===

=== Vistitor ===
A visitor to an [[#Archive|archive]] is distinguished from a [[#User|user]], as they are not logged in and they are accessing the archive anonymousl.  They are probably just wanting to view an [[#Abstract page|abstract page]] or download an an open access publication [[#Document|document]].

=== Volatile field ===

== W ==
=== Workflow ===
First order [[#Data object|Data objects]] in [[#EPrints repository software|EPrints repository software]] have a workflow to allow the metadata they store to be edited via a set of forms.  The most common of these is the [[#EPrint workflow|eprint workflow]] for the [[EPrint Object|eprint data object]].  By default the configuration for this workflow is written in XML and can be found in ''default.xml'' in either [[lib/workflows/eprint/]] or [[flavours/pub_lib/workflows/eprint/]]. If this needs to be modified it should be copied to the archive's [[Archives/ARCHIVEID/cfg/workflows/eprint/|cfg/workflows/eprint/]] directory before editing.  Explanation of the various elements and attributes are described in the [[Workflow_Format|workflow format guide]].

== X ==
=== Xapian search ===
== Y ==
== Z ==

[[Category:Work in Progress]]
[[Category:FAQ]]