Difference between revisions of "Manual"

From EPrints Documentation
Jump to: navigation, search
(Tidied up instllation links)
(Added link to glossary moved links for user and admin menus. Removed plugin types unlikely to be added to.)
(11 intermediate revisions by the same user not shown)
Line 19: Line 19:
 
* Install Guides
 
* Install Guides
 
** [[Installing EPrints on RHEL/Fedora/CentOS]]
 
** [[Installing EPrints on RHEL/Fedora/CentOS]]
*** Primarily RedHat Enterprise Linux (RHEL) / CentOS 7 and 8
+
*** Primarily RedHat Enterprise Linux (RHEL) and CentOS 7 and 8.
 
*** Guides for installing from RPM package and from source.
 
*** Guides for installing from RPM package and from source.
 
** [[Installing EPrints on Debian/Ubuntu]]
 
** [[Installing EPrints on Debian/Ubuntu]]
*** Primarily Ubuntu 16.04 LTS, 18.04 LTS and Ubuntu 20.04
+
*** Primarily Ubuntu 18.04 LTS and 20.04 LTS.
 
*** Guides for installing from Deb package and from source.
 
*** Guides for installing from Deb package and from source.
 
* [[Installation|Generic EPrints installation instructions]]
 
* [[Installation|Generic EPrints installation instructions]]
Line 28: Line 28:
 
** [[Setting up HTTPS using Let's Encrypt]]
 
** [[Setting up HTTPS using Let's Encrypt]]
 
** [[HTTPS-only and HSTS]]
 
** [[HTTPS-only and HSTS]]
* [[Files/Docker_config_files_for_EPrints_3.4.|Using EPrints with Docker]]
+
* [[Installing EPrints using Docker]]
  
 
= Post Installation =
 
= Post Installation =
 
* [[Getting Started with EPrints 3]]
 
* [[Getting Started with EPrints 3]]
* [[Upgrading EPrints 3 versions | Upgrading from an earlier version of EPrints3]]
 
* [[Migration|Migrating from EPrints 2.3]]
 
 
  
 
= Maintenance =
 
= Maintenance =
Line 57: Line 54:
 
* [[:Category:Howto|Orientation/Overview]] <span style="color: #f94; font-size: 130%">(Start here)</span>
 
* [[: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 ...''
 
** [[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 ...''
** [[EPrints_3_Configuration_orientation_for_EPrints_2_administrators|Migrated from EPrints 2?]] - ''this orientation guide is intended to help you re-orient yourselves in your new EPrints 3 set up...''
 
 
* [[Front Page Warning | Removing the Front Page Warning]] - Your first go at branding
 
* [[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 with confidence]] - ''one of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface...''
Line 74: Line 70:
 
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''
 
* [[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.''
 
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive.''
* [[Demoprints Repository]] - ''how to set up and configure the demoprints.eprints.org repository.''
 
 
* [[SWORD]] - ''how to configure the SWORD protocol on EPrints.''
 
* [[SWORD]] - ''how to configure the SWORD protocol on EPrints.''
 
* [[Custom handlers]] - ''how to add a custom handler for intergration with third-party applications.''
 
* [[Custom handlers]] - ''how to add a custom handler for intergration with third-party applications.''
Line 98: Line 93:
  
 
= Technical Reference =
 
= Technical Reference =
* [[EPrints Directory Structure]] - will be linked somewhere better, later.
+
* [[EPrints Directory Structure]] - How code and configuation files are organised.
 
+
* [[EPrints Glossary]] - A listing of terminology used within EPrints.
 +
* [[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]]
Line 124: Line 121:
 
** The [[Request Object]]
 
** The [[Request Object]]
 
* [[:Category:Plugins|Plugins]]
 
* [[:Category:Plugins|Plugins]]
** Import
+
** [[Create Export Plugins|Export]]
** [[Create Export Plugins|Export Plugins]]
+
** Import
** Components
+
** [[Screen Plugins|Screen]]
** [[Screen Plugins]]
 
** Convert
 
 
* [[Autocompletion]]
 
* [[Autocompletion]]
 
** [[Understanding IDs in Workflow Forms]]
 
** [[Understanding IDs in Workflow Forms]]
 
* [[API]]
 
* [[API]]
 
* [[Dynamic Template System]]
 
* [[Dynamic Template System]]
 
  
 
= The EPrints Bazaar =
 
= The EPrints Bazaar =

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