Difference between revisions of "Manual"

From EPrints Documentation
Jump to: navigation, search
m (minor tweaks)
(200 intermediate revisions by 28 users not shown)
Line 1: Line 1:
[[:Category:Installation|Installing]] EPrints on various platforms.
+
__NOTOC__
 +
See the [[Main Page]] for other areas of this wiki.
 +
 
 +
* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]]
 +
 
 +
<table cellpadding="10"><tr><td width="33%" valign="top">
 +
= Releases =
 +
{{releasenotes}}
 +
''See also the note on [[EPrints Version Numbering]]''
 +
 
  
{{manual}}
+
= Download =
 +
{{Download}}
  
The pages linked on the right represent the core pages of the EPrints manual. Other pages on this wiki may be useful as well, but new users should start here.
 
  
See the [[Main Page]] for other areas of this wiki.
+
= Installation =
 +
* [[Recommended Platforms]]
 +
* [[Required software]]
 +
* Install Guides
 +
** [[Installing EPrints on RHEL/Fedora/CentOS]]
 +
*** RedHat Enterprise Linux / CentOS 7 and Fedora 25+.
 +
*** Guides for installing from RPM package and from source.
 +
** [[Installing EPrints on Debian/Ubuntu]]
 +
*** Debian 7 and 8 and Ubuntu 14.04 LTS and 16.04 LTS.
 +
*** Guides for installing from Deb package and from source.
 +
** [[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]]
 +
 
 +
 
 +
= Maintenance =
 +
* [[Backups]]
 +
* [[Generate Scripts]]
 +
* [[Alerts]]
 +
* [[Log Files]]
 +
* [[Automating your maintenance]]
 +
* [[Troubleshooting]]
 +
</td>
 +
 
 +
<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?]
 +
 
 +
* Orientation <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...''
 +
** [[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, 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
 +
* [[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
 +
* [[Demoprints Repository]] - ''How to set up and configure the demoprints.eprints.org repository.
 +
* [[SWORD]] - ''How to configure the SWORD protocol on EPrints.
 +
* [[:Category:Howto|more ...]]
 +
 
 +
 
 +
= 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.
 +
 
 +
* [[: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.
+
* [[Metadata]] - configuring metadata fields.
 +
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]
 +
* [[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.
 +
** [[Citation Format]]
 +
** [[Workflow Format]] - the structure of the EP3 workflow files
 +
** [[Phrase Format]]
 +
** [[Template Format]]
 +
** [[XPAGE Format]]
 +
* [[XML Export Format]]
 +
* EPrints data structure
 +
** of the software
 +
** of the database (relating the dataobjects to each other using eprints fields)
 +
* [[Data Object]]s and data sets
 +
** The [[EPrint Object]]
 +
** The [[User Object]]
 +
** The [[Document Object]]
 +
** The [[Subject Object]]
 +
** The [[Saved Search Object]]
 +
** The [[History Object]]
 +
** The [[Access Object]]
 +
** The [[Request Object]]
 +
* [[:Category:Plugins|Plugins]]
 +
** Import
 +
** [[Create Export Plugins|Export Plugins]]
 +
** Components
 +
** [[Screen Plugins]]
 +
** Convert
 +
* [[Autocompletion]]
 +
** [[Understanding IDs in Workflow Forms]]
 +
* [[API]]
 +
* [[Dynamic Template System]]
  
[[Workflows]] - the structure of the EP3 workflow files
 
  
[[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).
+
= The EPrints Bazaar =
 +
* [[:Category:EPrints_Bazaar|The EPrints Bazaar]] (Start Here)
 +
* The [[EPM Specification]]
 +
* [[:Category:Bazaar_Package|Bazaar Packages]]
  
[[Preservation Support]] in GNU EPrints 3
+
</td></tr></table>

Revision as of 10:21, 8 September 2017

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