Editing EPrints Glossary (section)

== S ==
=== Saved search ===
This is a [[#Second 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 (or even some [[Additional_Recipients_on_Saved_Searches|additional recipients]]) to receive regular email updates about results that meet these 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 [[#Bazaar|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 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 single 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 [[#Archive|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|overridden]] 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 [[#Homepage|homepage]]
* 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]] commands.

=== 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 field|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.

=== System field ===
A [[#Metadata field|metadata field]] that is core to a [[#Data object|data object]].  Usually this field is for administrative field of little interest to a visitor or regular user but required for the management of the data object.  Typically such fields are hard-coded into the data object rather than customisable in configuration.  E.g. the <tt>dir</tt> field for an [[#EPrint|eprint]] that records the location where uploaded [[#Document|documents]] to an eprint should be store on the filesystem.