Difference between revisions of "Manual"
(→How-to Guides) |
m (minor tweaks) |
||
(156 intermediate revisions by 27 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. | ||
− | |||
− | |||
− | * [[Introduction]] | + | * [[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]]'' | ||
+ | |||
+ | |||
+ | = Download = | ||
+ | {{Download}} | ||
+ | |||
+ | |||
+ | = 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]] | * [[Backups]] | ||
− | * | + | * [[Generate Scripts]] |
− | * | + | * [[Alerts]] |
− | ** [[ | + | * [[Log Files]] |
− | * [[:Category: | + | * [[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 = | = 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?] | ||
Line 28: | Line 64: | ||
** [[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'' | ||
+ | * [[OAI]] | ||
* [[Adding new views]] | * [[Adding new views]] | ||
− | * Deposit Types | + | * Workflow |
− | * Organisation Hierarchy | + | * 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)...'' | * [[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 = | = Misc = | ||
− | + | * [[Preservation Support]] in EPrints 3 | |
− | * [[Preservation Support]] in | + | * [[:Category:Languages|Language support and translations]] |
− | * | + | </td><td valign="top" width="33%"> |
= Technical Reference = | = Technical Reference = | ||
− | |||
* [[EPrints Directory Structure]] - will be linked somewhere better, later. | * [[EPrints Directory Structure]] - will be linked somewhere better, later. | ||
Line 68: | Line 130: | ||
** The [[Access Object]] | ** The [[Access Object]] | ||
** The [[Request Object]] | ** The [[Request Object]] | ||
− | * Plugins | + | * [[:Category:Plugins|Plugins]] |
** Import | ** Import | ||
− | ** Export | + | ** [[Create Export Plugins|Export Plugins]] |
** Components | ** Components | ||
− | ** Screen | + | ** [[Screen Plugins]] |
** Convert | ** Convert | ||
− | * | + | * [[Autocompletion]] |
+ | ** [[Understanding IDs in Workflow Forms]] | ||
* [[API]] | * [[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> |
Revision as of 10:21, 8 September 2017
See the Main Page for other areas of this wiki.
ReleasesRelease Notes 3.4 | 3.4.1 | 3.4.2 | 3.4.3 | 3.4.4 | 3.4.5 | 3.4.6 3.3 | 3.3.5 | 3.3.6 | 3.3.7 | 3.3.8 | 3.3.9 | 3.3.10 | 3.3.11 | 3.3.13 | 3.3.14 | 3.3.15 | 3.3.16 3.2.0 | 3.2.1 | 3.2.2 | 3.2.3 | 3.2.4 | 3.2.5 | 3.2.6 | 3.2.7 | 3.2.8 | 3.2.9 See also the note on EPrints Version Numbering
Download
Installation
Post Installation
Maintenance |
Training Materials
How-to Guides
How to contributeThere'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
|