Difference between revisions of "EPrints Glossary"
(Added Branding) |
(Added EPrint locking) |
||
Line 41: | Line 41: | ||
=== EPrint === | === EPrint === | ||
An [[EPrint Object|EPrint]] is a 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 usually hold [[#Metadata|metadata]] about a publication of some kind. | An [[EPrint Object|EPrint]] is a 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 usually 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 status === | === EPrint status === | ||
=== EPrint type === | === EPrint type === |
Revision as of 20:21, 5 March 2022
A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z
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
Admin
Advanced search
Archive
Archive ID
Archive name
B
Bazaar
Bazaar plugin
See EPM.
Box plugin
Branding
Browse views
Buffer
Shorthand for Review buffer.
C
Citation
Creator
CRUD API
Contributor
D
Data flavour
Data object
Data set
Depositing user
This is the user who created the EPrint and has deposited it to the review buffer.
Document
E
Editor
Embargo
Documents added to an 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 bin/lift_embargos script.
EPM
EPM (EPrints Package Manager) is a package of functionality, sometimes referred as a Bazaar plugin, which can be installed in an automated fashion, typically from the Bazaar. It can sometimes refer to the pages for managing the installing of these packages, (e.g. the EPrints Bazaar page available through the Admin web interface).
EPrint
An EPrint is a first class Data object in EPrints repository software. These are often referred to as items or publication records, as they usually hold metadata about a publication of some kind.
EPrint locking
Whilst a user is editing an 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 status
EPrint type
EPrint URI
EPrint URL
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 GitHub.
EPrints path
The path on your operating system under which EPrints repository software is installed. Guides on this wiki often use the placeholder EPRINTS_PATH 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 version
Same as #EPrints release but with specific reference to a version number.
Event plugin
Also see Indexer task.
Event queue
Export plugin
F
File
Flavour
G
H
Homepage
I
Import plugin
Inbox
Same as #User workarea.
Inc file
Indexer
Indexer task
Ingredient
Issue
Item
Same as EPrint.
J
K
L
Live archive
M
Metadata
Metadata field
N
Named set
O
OAI-PMH
P
Plugin
These are Perl modules that "Plug in" to the EPrints software to provide a particular piece of functionality. They break down into several categories. The most prominent being:
Other plugin categories include Box, Convert, Event, InputForm, Issues, Search and Storage.
Often the phrase Bazaar plugin is used to refer to a package of functionality (a.k.a. EPM) that can be installed from the Bazaar. Although an EPM can often contain individual plugins, it is a complex set of files rather than a single plugin file.
Phrase
Publication flavour
Publication record
Same as EPrint.
Q
R
Repository
Request copy
REST API
Retired
Review buffer
S
Screen plugin
Simple search
Staff search
Subject
Summary page
Same as Abstract page. Sometimes even referred to as the abstract/summary page.
Summary table
A table on an Abstract page that lists the names and values for specific Metadata fields for the EPrint. These can be specified, typically in the archive's cfg/cfg.d/eprint_render.pl, under $c->{summary_page_metadata}.
Sword API
T
U
User
A User is a first class Data object in EPrints repository software. It represent a user of Repository and provides an account under which that user can login. Storing metadata about that user, such as their username, given and family names, email address, department, etc.
User review scope
User search
A form for searching across the users in a repository. See here for more information.
User profile
A page displaying the metadata about a user. This often links to a page where these metadata can be modified.
User workarea
This is the status of an EPrint whilst it is being edited by the depositing user. This status is often also referred to as Inbox. User workarea can sometimes refer to the Manage deposits page where the current user can see a listing of all the EPrints they have created.