Editing EPrints Glossary (section)

== 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 software]] 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 [[#Bazaar|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 and 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 [[#Archive|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 task|tasks]] yet to be successfully completed by the indexer.  Commonly referred to as the ''[[#Event 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|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 single row in a [[#Compound metadata field|compound]] [[#Multiple metadata field|multiple]] [[#Metadata field|metadata field]] that is part of an [[#EPrint|eprint]] [[#Data object|data object]]. It describes a potential problem discovered about a particular eprint. Unlike validation errors for specific 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]].