Difference between revisions of "Manual"

From EPrints Documentation
Jump to: navigation, search
(Technical Reference)
(Added link to glossary moved links for user and admin menus. Removed plugin types unlikely to be added to.)
 
(190 intermediate revisions by 28 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
See the [[Main Page]] for other areas of this wiki.
 
See the [[Main Page]] for other areas of this wiki.
__NOTOC__
 
= Introduction =
 
  
* [[Introduction]]
+
* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]]
* How to Get Help/Support
+
 
* [[History]]  
+
<table cellpadding="10"><tr><td width="33%" valign="top">
 +
= Releases =
 +
{{releasenotes}}
 +
''See also the note on [[EPrints Version Numbering]]''
 +
 
 +
 
 +
= Download =
 +
{{Download}}
 +
 
 +
 
 +
= Installation =
 +
* [[Recommended Platforms]]
 +
* [[Required software]]
 +
* Install Guides
 +
** [[Installing EPrints on RHEL/Fedora/CentOS]]
 +
*** Primarily RedHat Enterprise Linux (RHEL) and CentOS 7 and 8.
 +
*** Guides for installing from RPM package and from source.
 +
** [[Installing EPrints on Debian/Ubuntu]]
 +
*** Primarily Ubuntu 18.04 LTS and 20.04 LTS.
 +
*** Guides for installing from Deb package and from source.
 +
* [[Installation|Generic EPrints installation instructions]]
 +
* [[How to use EPrints with HTTPS]]
 +
** [[Setting up HTTPS using Let's Encrypt]]
 +
** [[HTTPS-only and HSTS]]
 +
* [[Installing EPrints using Docker]]
  
= Installing EPrints & Getting Started =
+
= Post Installation =
 +
* [[Getting Started with EPrints 3]]
  
* Recommended Platforms
+
= Maintenance =
* Installing Required Software]]
 
* [[Installation|Installing EPrints]]
 
* Upgrading EPrints 3 versions
 
* Migrating from EPrints 2.3
 
* Getting Started
 
 
* [[Backups]]
 
* [[Backups]]
* Troubleshooting
+
* [[Generate Scripts]]
* Advanced Installation
+
* [[Alerts]]
** [[HTTPS]]
+
* [[Log Files]]
* [[:Category:Installation|Installing]] EPrints on various platforms.
+
* [[Automating your maintenance]]
 +
* [[Troubleshooting]]
 +
</td>
 +
 
 +
<td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;">
  
= Configuring EPrints =
+
= Training Materials =
 +
* [[:Category:Training Video|EPrints Training Course]]
 +
* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services.
  
* Branding/Logos
+
 
* Deposit Types and Metadata
+
= How-to Guides =
* Organisation Hierarchy
+
''[http://en.wikipedia.org/wiki/Howto What is a how-to?]
 +
 
 +
* [[:Category:Howto|Orientation/Overview]] <span style="color: #f94; font-size: 130%">(Start here)</span>
 +
** [[Configuration orientation|New to EPrints 3?]]  - ''before diving into the how-tos, take some time to read through this brief orientation guide and familiarise yourself with the EPrints configuration landscape ...''
 +
* [[Front Page Warning | Removing the Front Page Warning]] - Your first go at branding
 +
* [[Branding with confidence]] - ''one of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface...''
 +
** [[Branding, the next level]] - ''how to completely change the interface to your own design''
 +
* [[OAI]]
 +
* [[Adding new views]]
 +
* Workflow
 +
* Deposit Types
 +
** [[Removing types]]
 +
* Metadata
 +
* Subjects (fold in with Organisation Hierarchy under "controled vocabularies")
 +
* [[EPrints_3_Organisation_Hierarchy|Organisation Hierarchy]] - ''how to put your own organisation's Hierarchy into EPrints 3''
 
* Searches
 
* Searches
 +
* [[Autocompletion and Authority Files (Romeo Autocomplete)]] - ''add autocomplete functionality to the Publication Title input field based on an authority file downloaded from EPrints Romeo...''
 +
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''
 +
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''
 +
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive.''
 +
* [[SWORD]] - ''how to configure the SWORD protocol on EPrints.''
 +
* [[Custom handlers]] - ''how to add a custom handler for intergration with third-party applications.''
 +
 +
= How to contribute =
 +
There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...
 +
 +
Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.
  
= Misc =
+
* [[:Category:Documentation Needed| Create some of the missing documentation]]
 +
* [[Contribute: Plugins | Plugins]]
 +
* [[Contribute: Scripts | Scripts]]
 +
* [[Contribute: Themes | Themes]]
 +
* [[Contribute: Translations | Translations]]
 +
* [[Contribute: Other | Other neighbourly things to do]]
 +
* [[Extension Packages]]
  
* [[Preservation Support]] in GNU EPrints 3
 
= Advanced Configuration/Howtos =
 
  
(currently linked on [[Customisation]])
+
= Misc =
 +
* [[Preservation Support]] in EPrints 3
 +
* [[:Category:Languages|Language support and translations]]
 +
</td><td valign="top" width="33%">
  
 
= Technical Reference =
 
= Technical Reference =
 
+
* [[EPrints Directory Structure]] - How code and configuation files are organised.
* [[EPrints Directory Structure]] - will be linked somewhere better, later.
+
* [[EPrints Glossary]] - A listing of terminology used within EPrints.
* [[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).
+
* [[User Menu]] - Explaining the menu options available to an EPrints user.
 +
* [[Admin|Admin Menu]] - Explaining the tools available to a repository administrator.
 
* [[Metadata]] - configuring metadata fields.
 
* [[Metadata]] - configuring metadata fields.
 
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]
 
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]
* XML Format Configuration Files
+
* [[XML Configuration]] Files
 +
** [[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).
 
** [[EPrints Control Format]] - the structure used to embed EPScript in an XML configuration file.
 
** [[EPrints Control Format]] - the structure used to embed EPScript in an XML configuration file.
 
** [[Citation Format]]
 
** [[Citation Format]]
Line 48: Line 107:
 
** [[Template Format]]
 
** [[Template Format]]
 
** [[XPAGE Format]]
 
** [[XPAGE Format]]
* EPrints data structure as a database
+
* [[XML Export Format]]
* EPrints data structure as software
+
* EPrints data structure  
 +
** of the software
 +
** of the database (relating the dataobjects to each other using eprints fields)
 
* [[Data Object]]s and data sets
 
* [[Data Object]]s and data sets
 
** The [[EPrint Object]]
 
** The [[EPrint Object]]
Line 59: Line 120:
 
** The [[Access Object]]
 
** The [[Access Object]]
 
** The [[Request Object]]
 
** The [[Request Object]]
 +
* [[:Category:Plugins|Plugins]]
 +
** [[Create Export Plugins|Export]]
 +
** Import
 +
** [[Screen Plugins|Screen]]
 +
* [[Autocompletion]]
 +
** [[Understanding IDs in Workflow Forms]]
 +
* [[API]]
 +
* [[Dynamic Template System]]
 +
 +
= The EPrints Bazaar =
 +
* [[:Category:EPrints_Bazaar|The EPrints Bazaar]] (Start Here)
 +
* The [[EPM Specification]]
 +
* [[:Category:Bazaar_Package|Bazaar Packages]]
 +
 +
</td></tr></table>

Latest revision as of 07:38, 6 March 2022

See the Main Page for other areas of this wiki.

Releases

See also the note on EPrints Version Numbering


Download


Installation

Post Installation

Maintenance

Training Materials


How-to Guides

What is a how-to?

How to contribute

There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...

Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.


Misc

Technical Reference

The EPrints Bazaar