Difference between revisions of "Manual"

From EPrints Documentation
Jump to: navigation, search
m
(Technical Reference)
 
(122 intermediate revisions by 14 users not shown)
Line 1: Line 1:
[http://primonona.info/content/view/benny/ benny] [http://xionny.cn/topic/progettazione-giardino/ progettazione giardino calabria] [http://wedner.info/content/view/fujifilm-finepix.htm fujifilm finepix f601z] [http://polex.com.cn/resources/articles/agrigento-hotel.htm agrigento hotel] [http://manoke.cn/topic/mercedes-c/ mercedes c sw] [http://xionny.cn/topic/vecina/ vecina] [http://joperan.org/data/masturbazione-singole/ masturbazione singole] [http://veggis.org.cn/resources/articles/gale-force.htm gale force] [http://soler.net.cn/data/foto-di.htm foto di linda batista] [http://joperan.org/data/lavatrice-rex/ lavatrice rex incasso] [http://budget7i.info/lib/je-veux/ je veux vivre] [http://svike.info/view/new/monitor-.htm monitor 17 schermo piatto] [http://funkall.us/images/small/attrezzatura-sportiva/ attrezzatura sportiva articolo sportivo] [http://funkall.us/images/small/quattrocchi-filmato/ quattrocchi filmato] [http://joperan.org/data/la-boda/ la boda de belen] [http://wedner.info/content/view/voli-verona.htm voli verona olbia] [http://soler.net.cn/data/registratori-vocale.htm registratori vocale memoria] [http://svike.info/view/new/janet-leigh.htm janet leigh] [http://wedner.info/content/view/mercedes-c.htm mercedes c220 d sw] [http://soler.net.cn/data/codici-sky.htm codici sky] [http://xionny.cn/topic/key-polsat/ key polsat] [http://budget7i.info/lib/soggiorno-taranto/ soggiorno taranto] [http://wedner.info/content/view/come-seminare.htm come seminare un prato inglese] [http://polex.com.cn/resources/articles/contestazione-generale.htm contestazione generale] [http://klohy.info/img/styles/asus-an.htm asus a8n nforce4] [http://soler.net.cn/data/grammaticale.htm grammaticale] [http://klohy.info/img/styles/plafoniere-casa.htm plafoniere casa] [http://funkall.us/images/small/fifa-futbal/ fifa futbal 2004] [http://polex.com.cn/resources/articles/las-vegas.htm las vegas travel] [http://veggis.org.cn/resources/articles/segreteria-don.htm segreteria don carlo gnocchi] [http://veggis.org.cn/resources/articles/diendan.htm diendan] [http://soler.net.cn/data/la-famiglia.htm la famiglia sullivan] [http://veggis.org.cn/resources/articles/seat-toledo.htm seat toledo 2 serie] [http://soler.net.cn/data/diritti-della.htm diritti della donna] [http://klohy.info/img/styles/notizie-di.htm notizie di maria teresa di calcutta] [http://soler.net.cn/data/e-c.htm e c m] [http://primonona.info/content/view/la-ragazza/ la ragazza con il bastone] [http://xionny.cn/topic/hit-mania/ hit mania dance summer 2004] [http://sneck.info/data/batteria-np/ batteria np] [http://budget7i.info/lib/new-hotel/ new hotel arles camargue] [http://primonona.info/content/view/piastra-per/ piastra per bistecchiera] [http://manoke.cn/topic/timcafe-it/ timcafe it] [http://polex.com.cn/resources/articles/lumix-fz.htm lumix fz-30] [http://budget7i.info/lib/schede-memoria/ schede memoria mmc] [http://veggis.org.cn/resources/articles/mostra-doltremare.htm mostra doltremare napoli] [http://budget7i.info/lib/www-patriciello/ www patriciello it] [http://soler.net.cn/data/tesina-matematica.htm tesina matematica] [http://funkall.us/images/small/santa-fe/ santa fe ristorante] [http://klohy.info/img/styles/tiziano-ferro.htm tiziano ferro sito unofficial] [http://primonona.info/content/view/macchina-per/ macchina per hot-dog] [http://primonona.info/content/view/capuccetto-rosso/ capuccetto rosso] [http://veggis.org.cn/resources/articles/twentieth-centuryfox.htm twentieth century-fox] [http://veggis.org.cn/resources/articles/passeggino-loola.htm passeggino loola] [http://primonona.info/content/view/come-controllare/ come controllare i cavi] [http://svike.info/view/new/firenze-ibiza.htm firenze ibiza biglietti aerei] [http://svike.info/view/new/batteria-philips.htm batteria philips genie] [http://manoke.cn/topic/the-sims/ the sims ps2 videogiochi] [http://klohy.info/img/styles/voli-isola.htm voli isola del giglio] [http://budget7i.info/lib/gefen-hdtv/ gefen hdtv splitter] [http://wedner.info/content/view/silicon-case.htm silicon case] [http://klohy.info/img/styles/sms-anonimi.htm sms anonimi] [http://manoke.cn/topic/classe-/ classe 15 con attestato di rischio] [http://sneck.info/data/me-libere/ me libere] [http://primonona.info/content/view/ami-mouse/ ami mouse 250s cordless] [http://budget7i.info/lib/canon-/ canon - selphy] [http://svike.info/view/new/milano-bergamo.htm milano bergamo siviglia biglietti aerei] [http://xionny.cn/topic/mobili-per/ mobili per ospedali] [http://manoke.cn/topic/agarum/ agarum] [http://joperan.org/data/trampolin/ trampolin] [http://wedner.info/content/view/borse-gucci.htm borse gucci] [http://sneck.info/data/accessori-gps/ accessori gps] [http://xionny.cn/topic/cantu-siciliano/ cantu siciliano] [http://soler.net.cn/data/hard-disk.htm hard disk case esterno] [http://svike.info/view/new/video-sex.htm video sex free] [http://soler.net.cn/data/o-zone.htm o zone dragonstea din dei] [http://joperan.org/data/mappa-porto/ mappa porto recanati] [http://svike.info/view/new/make-me.htm make me an island] [http://joperan.org/data/jvc-gr/ jvc gr d245] [http://svike.info/view/new/sita-salerno.htm sita salerno] [http://veggis.org.cn/resources/articles/libretto-nero.htm libretto nero] [http://joperan.org/data/frozenfrenzy/ frozen.frenzy] [http://soler.net.cn/data/luis-royo.htm luis royo libri] [http://polex.com.cn/resources/articles/la-ragazza.htm la ragazza del prete] [http://veggis.org.cn/resources/articles/piastre-di.htm piastre di cottura] [http://joperan.org/data/bordeaux-henry/ bordeaux, henry] [http://budget7i.info/lib/televisore-schermo/ televisore schermo piatto a 32 pollici] [http://klohy.info/img/styles/foto-moglie.htm foto moglie esibizionista] [http://veggis.org.cn/resources/articles/www-tommyvee.htm www tommyvee] [http://sneck.info/data/efs/ ef-s 10-22] [http://funkall.us/images/small/morris/ morris] [http://joperan.org/data/il-mondo/ il mondo dei cartoni] [http://soler.net.cn/data/duello-nel.htm duello nel pacifico] [http://wedner.info/content/view/nepalese-hostage.htm nepalese hostage killed] [http://soler.net.cn/data/agenzia-pubblicitaria.htm agenzia pubblicitaria] [http://veggis.org.cn/resources/articles/la-playa.htm la playa] [http://veggis.org.cn/resources/articles/try-tradotta.htm try tradotta] [http://polex.com.cn/resources/articles/accessori-passeggino.htm accessori passeggino] [http://xionny.cn/topic/www-cori/ www cori milan mp3] [http://xionny.cn/topic/desideri/ desideri] [http://klohy.info/img/styles/il-linguaggio.htm il linguaggio dei fiori] [http://joperan.org/data/fifa-calcio/ fifa calcio 2004] [http://polex.com.cn/resources/articles/en-dag.htm en dag tilbage] [http://polex.com.cn/resources/articles/cursori-animati.htm cursori animati gif] [http://funkall.us/images/small/pegperego-navetta/ peg-perego navetta] [http://svike.info/view/new/video-mutu.htm video mutu a luci rosse] [http://manoke.cn/topic/gta-libertycitystories/ gta libertycitystories] [http://svike.info/view/new/laser-ad.htm laser ad eccimeri] [http://wedner.info/content/view/pista-reggaeton.htm pista reggaeton] [http://wedner.info/content/view/on-oublie.htm on oublie jamais rien on vie avec] [http://polex.com.cn/resources/articles/macchina-elettrica.htm macchina elettrica per pasta] [http://xionny.cn/topic/foto-dei/ foto dei gatti piu belli] [http://primonona.info/content/view/archilochus/ archilochus] [http://funkall.us/images/small/gayangos-pascual/ gayangos, pascual de-] [http://joperan.org/data/ntsc-pal/ ntsc pal] [http://primonona.info/content/view/www-cannondale/ www cannondale] [http://primonona.info/content/view/best-of/ best of acoustic] [http://funkall.us/images/small/memory-card/ memory card lettore hard] [http://wedner.info/content/view/supporto-auto.htm supporto auto pda mitac mio 168] [http://wedner.info/content/view/la-primavera.htm la primavera hitleriana eugenio montale] [http://budget7i.info/lib/specchi-del/ specchi del desiderio] [http://xionny.cn/topic/ricetta-bimby/ ricetta bimby] [http://primonona.info/content/view/ibiza-annual/ ibiza annual 2005] [http://primonona.info/content/view/benq-fp/ benq fp931 19 lcd tft] [http://funkall.us/images/small/pellegrino-di/ pellegrino di puglia] [http://wedner.info/content/view/mario-.htm mario  bross] [http://xionny.cn/topic/hs-w/ hs 21w] [http://svike.info/view/new/sesso-e.htm sesso e fica] [http://soler.net.cn/data/wwe-survivor.htm wwe survivor series] [http://soler.net.cn/data/un-maledetto.htm un maledetto imbroglio] [http://primonona.info/content/view/carlo-cracco/ carlo cracco libri] [http://sneck.info/data/summer-madness/ summer madness] [http://soler.net.cn/data/marcela-morelo.htm marcela morelo musica] [http://joperan.org/data/star-wars/ star wars. clone wars. vol. 01] [http://manoke.cn/topic/club-azzurro/ club azzurro] [http://svike.info/view/new/suteki-da.htm suteki da ne] [http://joperan.org/data/darna/ darna] [http://manoke.cn/topic/udine-manifestazioni/ udine manifestazioni] [http://klohy.info/img/styles/calma-e.htm calma e sngue freddo] [http://funkall.us/images/small/saintmichel/ saint-michel] [http://funkall.us/images/small/orata/ orata] [http://sneck.info/data/epson-t/ epson t041] [http://budget7i.info/lib/air-classic/ air classic bw] [http://joperan.org/data/lumix/ lumix 8] [http://polex.com.cn/resources/articles/maquillaje-artistico.htm maquillaje artistico] [http://primonona.info/content/view/antonello-de/ antonello de pierro calendari donne] [http://budget7i.info/lib/sean-pul/ sean pul] [http://wedner.info/content/view/ww-gov.htm ww gov cba ar] [http://primonona.info/content/view/software-videoscrittura/ software videoscrittura] [http://joperan.org/data/macchina-a/ macchina a vapore] [http://svike.info/view/new/nikon-d.htm nikon d100] [http://klohy.info/img/styles/petula-clark.htm petula clark. this is my song - the ultimate portrait of petula clark] [http://soler.net.cn/data/concorsi-miss.htm concorsi miss 2004] [http://manoke.cn/topic/flash-ttl/ flash ttl] [http://svike.info/view/new/coralia-dahab.htm coralia dahab] [http://primonona.info/content/view/z-yamaha/ z9 yamaha] [http://polex.com.cn/resources/articles/dule-el.htm dule el amor] [http://svike.info/view/new/morti-sospette.htm morti sospette] [http://budget7i.info/lib/copertina-cd/ copertina cd saro migliore] [http://polex.com.cn/resources/articles/chicken-little.htm chicken little  amici per le penne] [http://svike.info/view/new/wharfedale-wh.htm wharfedale wh 20] [http://klohy.info/img/styles/acer-mp.htm acer mp3 flashstick 512] [http://manoke.cn/topic/km-alfa/ km0 alfa romeo 147 2005 diesel auto km 0] [http://sneck.info/data/nuove-immagini/ nuove immagini per legend of kay] [http://sneck.info/data/claudia-de/ claudia de falco] [http://wedner.info/content/view/breathe.htm breathe] [http://svike.info/view/new/tezza-verona.htm tezza verona] [http://klohy.info/img/styles/cerco-maschi.htm cerco maschi] [http://primonona.info/content/view/ventole-raffreddamento/ ventole raffreddamento case] [http://polex.com.cn/resources/articles/prato-citta.htm prato citta] [http://soler.net.cn/data/anoressia-e.htm anoressia e bulimia] [http://funkall.us/images/small/foto-mogli/ foto mogli] [http://manoke.cn/topic/si-estoy/ si estoy facil] [http://klohy.info/img/styles/to-mei.htm to mei] [http://primonona.info/content/view/oh-boy/ oh boy mp3] [http://veggis.org.cn/resources/articles/http-my.htm http my caledonian ac uk] [http://joperan.org/data/liviu/ liviu] [http://budget7i.info/lib/liceo-e/ liceo e pascal] [http://funkall.us/images/small/rover/ rover 25 1.4] [http://klohy.info/img/styles/epson-stilus.htm epson stilus color] [http://svike.info/view/new/b-c.htm b c d e f g h i j k l m n o p q r s t u v w x y z] [http://svike.info/view/new/prestito-artigiano.htm prestito artigiano] [http://funkall.us/images/small/ristorazione-scolastica/ ristorazione scolastica del comune di ve] [http://veggis.org.cn/resources/articles/traduzione-sacrifice.htm traduzione sacrifice] [http://budget7i.info/lib/nero/ nero.2] [http://primonona.info/content/view/magik-lnb/ magik lnb] [http://budget7i.info/lib/la-fine/ la fine] [http://funkall.us/images/small/la-capra/ la capra di u saba] [http://wedner.info/content/view/henry-kissinger.htm henry kissinger] [http://joperan.org/data/duello-nel/ duello nel ventre della terra] [http://budget7i.info/lib/volkswagen-golf/ volkswagen golf 2.0 tdi sportline] [http://xionny.cn/topic/subsonica-colpo/ subsonica colpo pistola] [http://joperan.org/data/calendari-feticisti/ calendari feticisti] [http://svike.info/view/new/divinita-e.htm divinita e personaggi mitologici] [http://manoke.cn/topic/golf-/ golf 1.6 sportline] [http://soler.net.cn/data/acer.htm acer 16] [http://budget7i.info/lib/les-amants/ les amants de saint jean] [http://budget7i.info/lib/iceberg-profumi/ iceberg profumi donna] [http://polex.com.cn/resources/articles/da-.htm da 32 pollici tv televisori lcd] [http://klohy.info/img/styles/immaggini-di.htm immaggini di bellissime studentesse] [http://veggis.org.cn/resources/articles/amanti-nelle.htm amanti nelle tenebre] 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
+
<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]]
 +
 
 +
= Post Installation =
 +
* [[Getting Started with EPrints 3]]
 +
 
 +
= Maintenance =
 +
* [[Backups]]
 +
* [[Generate Scripts]]
 +
* [[Alerts]]
 +
* [[Log Files]]
 +
* [[Automating your maintenance]]
 +
* [[Troubleshooting]]
 +
* [[Apache Hardening]]
 +
</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?]
 +
 
 +
* [[: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
 +
* [[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.''
 +
* [[User Deposit Agreement]] - ''How to add a user deposit agreement to the workflow.''
 +
* [[ORCID]]
 +
** [[Import From ORCID]]
 +
* Javascript
 +
** [[Include Javascript in the workflow]]
 +
* DKIM email verification
 +
** [[How to configure DKIM email verification (using sendmail on Rocky9)]]
 +
 
 +
= 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]] - 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.
 +
* [[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]]
 +
** [[Create Export Plugins|Export]]
 +
** Import
 +
** [[Screen Plugins|Screen]]
 +
* [[Autocompletion]]
 +
** [[Understanding IDs in Workflow Forms]]
 +
* [[API]]
 +
* [[Dynamic Template System]]
 +
* [[Config Options by File]]
 +
* [[Triggers|Trigger functions]]
 +
 
 +
= 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 17:26, 25 July 2024

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