Difference between revisions of "Manual"

From EPrints Documentation
Jump to: navigation, search
m (Reverted edit of LuvM0g, changed back to last version by Tom)
m (more-link moved)
 
(106 intermediate revisions by 15 users not shown)
Line 1: Line 1:
See the [[Main Page]] for other areas of this wiki.
 
 
__NOTOC__
 
__NOTOC__
= Introduction =
+
See the [[Main Page]] for other areas of this wiki.
  
* [[Introduction]]
+
* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]]  
* How to Get Help/Support
+
* [[History]]  
+
  
= Installing EPrints & Getting Started =
+
<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]]
 
* [[Required software]]
* [[Installation|Installing EPrints]]
+
* Install Guides
** [[Recommended Platforms]]
+
** [[Installing EPrints on RHEL/Fedora/CentOS]]
** [[Installing Eprints 3 on Fedora Core 6]]
+
*** RedHat Enterprise Linux / CentOS 7 and Fedora 25+.
** [[Installing EPrints 3 on RedHat Enterprise 4]]
+
*** Guides for installing from RPM package and from source.
** [[Installing EPrints 3 on OS X]]
+
** [[Installing EPrints on Debian/Ubuntu]]
** [[Installing EPrints 3 on Ubuntu 6.10]]
+
*** Debian 7 and 8 and Ubuntu 14.04 LTS and 16.04 LTS.
** ''[[:Category:Installation|other platforms]]''
+
*** Guides for installing from Deb package and from source.
* [[Upgrading EPrints 3 versions]]
+
** [[Installing EPrints 3 on OS X|Installing EPrints on OS X]] - Not recommended
 +
** [[Installing in a chroot Debian/Ubuntu]]
 +
** [[:Category:Installation|Installing]] EPrints on various platforms.
 +
* [[Https3|Installing EPrints 3 with an https server]]
 +
** [[Setting up HTTPS using Let's Encrypt]]
 +
* Using EPrints in the Cloud
 +
** [[EPrints EC2]] - Running both a vanilla and training repository!
 +
* Using the Live CD
 +
** [[EPrints Live CD Help]]
 +
** [[Building the Live CD]]
 +
 
 +
 
 +
= Post Installation =
 +
* [[Getting Started with EPrints 3]]
 +
* [[Upgrading EPrints 3 versions | Upgrading from an earlier version of EPrints3]]
 
* [[Migration|Migrating from EPrints 2.3]]
 
* [[Migration|Migrating from EPrints 2.3]]
* [[Getting Started with EPrints 3|Getting Started]]
+
 
 +
 
 +
= Maintenance =
 
* [[Backups]]
 
* [[Backups]]
 +
* [[Generate Scripts]]
 +
* [[Alerts]]
 +
* [[Log Files]]
 +
* [[Automating your maintenance]]
 
* [[Troubleshooting]]
 
* [[Troubleshooting]]
* Advanced Installation
+
</td>
** [[Https3]]
+
* [[:Category:Installation|Installing]] EPrints on various platforms.
+
  
= How-to Guides =
+
<td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;">
  
 +
= Training Materials =
 +
* [[:Category:Training Video|EPrints Training Course]]
 +
* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services.
 +
 +
 +
= How-to Guides =
 
''[http://en.wikipedia.org/wiki/Howto What is a how-to?]
 
''[http://en.wikipedia.org/wiki/Howto What is a how-to?]
  
* Orientation <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...''  
+
** [[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
 
* [[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...''
 
** [[Branding, the next level]] - ''how to completely change the interface to your own design''
 
** [[Branding, the next level]] - ''how to completely change the interface to your own design''
 +
* [[OAI]]
 
* [[Adding new views]]
 
* [[Adding new views]]
 
* Workflow
 
* Workflow
Line 47: Line 80:
 
* [[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
* [[Customisation|more]]
+
* [[Demoprints Repository]] - ''How to set up and configure the demoprints.eprints.org repository.
 +
* [[SWORD]] - ''How to configure the SWORD protocol on EPrints.
  
= Misc =
+
= 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...
  
* [[Preservation Support]] in GNU EPrints 3
+
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.
* [[i18n]]
+
* [[How to contribute]]
+
** [[Extension Packages]]
+
  
= Technical Reference =
+
* [[: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]]
  
 +
 +
= Misc =
 +
* [[Preservation Support]] in EPrints 3
 +
* [[:Category:Languages|Language support and translations]]
 +
</td><td valign="top" width="33%">
 +
 +
= Technical Reference =
 
* [[EPrints Directory Structure]] - will be linked somewhere better, later.
 
* [[EPrints Directory Structure]] - will be linked somewhere better, later.
  
Line 83: Line 128:
 
** The [[Access Object]]
 
** The [[Access Object]]
 
** The [[Request Object]]
 
** The [[Request Object]]
* Plugins
+
* [[:Category:Plugins|Plugins]]
 
** Import
 
** Import
** [[Export Plugins]]
+
** [[Create Export Plugins|Export Plugins]]
 
** Components
 
** Components
** Screen
+
** [[Screen Plugins]]
 
** Convert
 
** Convert
 
* [[Autocompletion]]
 
* [[Autocompletion]]
Line 93: Line 138:
 
* [[API]]
 
* [[API]]
 
* [[Dynamic Template System]]
 
* [[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:24, 29 August 2018

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