EPrints Documentation - Recent changes [en-gb]

REF 2029

EDumbill — Thu, 16 Jul 2026 15:03:33 GMT

Adding some extra detail

File:REF Reports.png

EDumbill — Thu, 16 Jul 2026 14:55:33 GMT

EDumbill uploaded File:REF Reports.png

New page

Generating a report of selections in a UoA

File:Selection Workflow.png

EDumbill — Thu, 16 Jul 2026 14:52:22 GMT

EDumbill uploaded File:Selection Workflow.png

New page

Editing the REF selection information

File:Adding Review.png

EDumbill — Thu, 16 Jul 2026 14:51:20 GMT

EDumbill uploaded File:Adding Review.png

New page

Adding a review to the selection

File:Assigning Reviewers.png

EDumbill — Thu, 16 Jul 2026 14:49:38 GMT

EDumbill uploaded File:Assigning Reviewers.png

New page

Assigning reviews to a selection

REF 2029

EDumbill — Thu, 16 Jul 2026 14:47:59 GMT

‎Units of Assessment Champions

File:Selecting for REF.png

EDumbill — Thu, 16 Jul 2026 14:44:20 GMT

EDumbill uploaded File:Selecting for REF.png

New page

Selecting an output for a UoA. The current user is not a champion for B07 so cannot interact with it but can see it has been selected.

REF 2029

EDumbill — Thu, 16 Jul 2026 14:41:28 GMT

‎Benchmarks

User talk:Polyrobin

Drn@ecs.soton.ac.uk — Wed, 15 Jul 2026 10:10:49 GMT

Welcome!

New page

'''Welcome to ''EPrints Documentation''!'''
We hope you will contribute much and well.
You will probably want to read the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents help pages].
Again, welcome and have fun! [[User:Drn@ecs.soton.ac.uk|Drn@ecs.soton.ac.uk]] ([[User talk:Drn@ecs.soton.ac.uk|talk]]) 10:10, 15 July 2026 (UTC)

User:Polyrobin

Drn@ecs.soton.ac.uk — Wed, 15 Jul 2026 10:10:49 GMT

Creating user page for new user.

New page

Administrateur de PolyPublie pour Polytechnique Montréal
Repository admin for Polytechnique Montréal's PolyPublie

« Rien n’est plus permanent qu’un hack temporaire dans EPrints. »

User:Polyrobin

Drn@ecs.soton.ac.uk — Wed, 15 Jul 2026 10:10:49 GMT

User account Polyrobin was created by Drn@ecs.soton.ac.uk and password was sent by email EPrints community developer

User talk:EDumbill

Drn@ecs.soton.ac.uk — Wed, 15 Jul 2026 10:00:23 GMT

Welcome!

New page

User:EDumbill

Drn@ecs.soton.ac.uk — Wed, 15 Jul 2026 10:00:23 GMT

User account EDumbill was created by Drn@ecs.soton.ac.uk and password was sent by email EPrints developer at CoSector

User:EDumbill

Drn@ecs.soton.ac.uk — Wed, 15 Jul 2026 10:00:23 GMT

Creating user page for new user.

New page

I work at CoSector and have been developing EPrints since 2020. My github account with the same username includes some of my contributions :)

DataCite DOI

Drn@ecs.soton.ac.uk — Wed, 15 Jul 2026 09:29:46 GMT

Added info about Test API

EPrints 3.5.0 Release Candidate 1

Drn@ecs.soton.ac.uk — Fri, 03 Jul 2026 17:17:42 GMT

‎Things to try next

EPrints 3.5.0 Testing

Drn@ecs.soton.ac.uk — Fri, 03 Jul 2026 17:15:43 GMT

‎Things for beta testers to test?

EPrints 3.5.0 Testing

Drn@ecs.soton.ac.uk — Fri, 03 Jul 2026 17:10:13 GMT

Added testing 3.5.0 page

New page

This page discusses the various testing carried out and to be carried out as part of the EPrints 3.5.0 release

== Continuous Integration Testing ==
A build of [https://github.com/eprints/eprints3.5/ EPrints 3.5 GitHub head] is carried out every day with the following tested:
1. Unit tests as found under https://github.com/eprints/eprints3.5/tree/master/tests
2. User acceptance tests (written using the [https://www.selenium.dev/selenium-ide/ Selenium IDE]) described at https://github.com/eprints/eprints_ci/blob/main/sides/templates/eprints35_pub.side.tmpl

Also, we are currently in the process of integrating CI with pull requests to test a build of the pull request to informed reviewers of whether it is OK to merge. These tests are written in [https://playwright.dev/ Playwright] and can be found under https://github.com/eprints/eprints3.5/tree/master/ci/pytest/eprints/ but there are only a few tests at the moment and it is a work in progress to build up a suite of tests that will ultimately be more comprehensive than the current Selenium IDE acceptance tests

== Accessibility Testing ==
A full survey of pages in a vanilla EPrints research publication repository has been carried out using the WAVE Accessibility plugin for Firefox. The current results for this survey can be found at https://raw.githubusercontent.com/eprints/eprints3.5/refs/heads/master/lib/lang/en/static/accessibility/report.xpage or if you have deployed an EPrints instance at http://YOUR.REPOSITORY.HOSTNAME/accessibility/report.html

== Spell Checking ==
[https://github.com/codespell-project/codespell Codespell] has been run across the EPrints 3.5 codebase to detect spelling errors using a combination of the [https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt standard] and [ https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary_rare.txt rare] Codespell dictionaries, which list common typos->correct spellings (e.g. seperator->separator).

== Things for beta testers to test? ==
Obviously when developing a new EPrints repository a lot of the testing falls into two categories:
1. Testing the new features being implemented.
2. Doing stock testing of generic functionality.
What is often gets missed is more niche features or just using an EPrints repository in non-standard ways. Therefore testing ingredients, plugins, etc. that don't come as part of the initial install would be really useful to get feedback. As EPrints 3.5 has quite a few changes to 3.4, then trying to deploying the whole configuration, ingredients, plugins for an archive is unrealistic. However, testing individual ingredients/plugins you will want to use on 3.5 or interesting bespoke changes to your EPrints repository, are just the sort of things we are looking for as beta test feedback.

However, to start with you probably just want to follow the current [[EPrints_3.5.0_Release_Candidate_1#Installation_Instructions|EPrints 3.5.0 RC1 installation instructions]] and make sure you can get an EPrints repository up and running.

== Suggestions for features/aspects to test ==
If you have an EPrints wiki account and want to suggest things that should be tested (which don't look to have been covered above) then please add these below.

Denial-of-Service Symptoms

Drn@ecs.soton.ac.uk — Thu, 02 Jul 2026 16:38:44 GMT

‎Common Apache Error messages

Denial-of-Service Symptoms

Drn@ecs.soton.ac.uk — Thu, 02 Jul 2026 16:37:21 GMT

Added page about DoS

New page

This page is intended to details some of the symptoms experienced if your EPrints repository is suffering from a (Distributed) Denial-of-Service attack or at least does not have enough resources to service the scale of requests it is getting

== Common Apache Error messages ==
Line numbers may not be the same in the current HEAD of this git repository:
# (Broken pipe / The timeout specified has expired / Connection reset by peer) at **/opt/eprints3/perl_lib/EPrints/Page.pm line 78**
# (Broken pipe / Connection reset by peer) at **/opt/eprints3/perl_lib/EPrints/Plugin/Export.pm line 283**
# (Broken pipe / Connection reset by peer) at **opt/eprints3/cgi/exportview line 126**
# Broken pipe at **/opt/eprints3/perl_lib/EPrints/Apache/CRUD.pm line 1670**

Issues with Installing EPrints on Ubuntu 26.04

Drn@ecs.soton.ac.uk — Thu, 02 Jul 2026 11:37:05 GMT

@@ Line 20: / Line 20: @@
 By default, all 34 UoAs being used in [https://2029.ref.ac.uk/panels/units-of-assessment/ REF 2029] are made available. Any UoAs that your institution is not submitting to can be removed.
 ==For Developers==
@@ Line 37: / Line 62: @@
      </epc:if>
 </source>

@@ Line 10: / Line 10: @@
 Only users who are assigned as a REF Unit of Assessment (UoA) champion are able to select EPrints records for a UoA.
-Users can be assigned as a UoA champion in their user profiles.
+Users can be assigned as a UoA champion in their user profiles. Users can be champions for as many or as few UoAs as necessary.
 [[File:UoA Champions.jpg|600px|thumb|none]]
-Benchmarks may be active or inactive. When a REF Selection is made, it is added to the current benchmark.
+If a user is a champion for a limited number of UoAs, they can see when outputs have been assigned for other UoAs and assign the UoA of which they are a champion but cannot assign reviewers or interact with reviews and reports for other UoAs.
 ==For Developers==

@@ Line 4: / Line 4: @@
 ==Benchmarks==
 Before any REF selections can be made, a REF Benchmark needs to be created. This can be achieved using the REF 2029 screen.
+Multiple benchmarks can be added but only one can be active at any given time. New items that are selected for REF are automatically assigned to the active benchmark.
 [[File:REF 2029 Benchmarks.jpg|600px|thumb|none]]

← Older revision		Revision as of 09:29, 15 July 2026
Line 279:		Line 279:
	</cite:citation>		</cite:citation>
	</pre>		</pre>
		+
		+	=Test and Production APIs=
		+	After initially installing the DataCiteDoi plugin it will be configured to use the test API and MDS URLs, using the following configuration in ''cfg.d/z_datacitedoi.pl'' (either in your archive's cfg/ directory if installed from the Bazaar or as an EPM but under ingredients/DataCiteDoi/ if installed as an ingredient):
		+
		+	$c->{datacitedoi}{mdsurl} = "https://mds.test.datacite.org/";
		+	$c->{datacitedoi}{apiurl} = "https://api.test.datacite.org/";
		+
		+	If you want to use the real API and MDS, you will need to take out the ".test" to become:
		+
		+	$c->{datacitedoi}{mdsurl} = "https://mds.datacite.org/";
		+	$c->{datacitedoi}{apiurl} = "https://api.datacite.org/";
		+
		+	However, whilst you are using the test API, be aware that although the DataCiteDoi plugin will generate DOI links of the form:
		+	https://doi.org/10.1234/5678
		+	these will resolve to a page saying the DOI is not found. To check the the DOI has successfully been minted you should replace '''doi.org''' with '''handle.test.datacite.org'''. E.g.
		+	https://handle.test.datacite.org/10.1234/5678
		+	If the minting has been successful, like the production DOIs, this should redirect to the EPrints abstract/summary page for the relevant item.

@@ Line 14: / Line 14: @@
   yum config-manager --enable crb
 . Install prerequite packages and tools. (Some extra packages may be required to build CPAN packages later on).
-  yum install git libxml2 libxslt httpd mod_perl mod_ssl openssl-devel perl-DBD-MySQL tetex-latex wget gzip tar ImageMagick elinks poppler-utils chkconfig unzip cpan python3-html2text expat-devel libxslt-devel xapian-core xapian-core-devel
+  yum install git libxml2 libxslt httpd mod_perl mod_ssl openssl-devel perl-DBD-MySQL tetex-latex wget gzip tar ImageMagick elinks poppler-utils chkconfig unzip cpan python3-html2text expat-devel libxslt-devel
   yum install ffmpeg-free # if you need to process videos
 . Add the eprints user
@@ Line 54: / Line 54: @@
   /opt/eprints3/bin/indexer start
-=== Things to try next ===
+==== Things to try next ====
 Set up HTTPS using LetsEncrypt certificates
 As the eprints user

@@ Line 6: / Line 6: @@
 . User acceptance tests (written using the [https://www.selenium.dev/selenium-ide/ Selenium IDE]) described at https://github.com/eprints/eprints_ci/blob/main/sides/templates/eprints35_pub.side.tmpl
-Also, we are currently in the process of integrating CI with pull requests to test a build of the pull request to informed reviewers of whether it is OK to merge.  These tests are written in [https://playwright.dev/ Playwright] and can be found under https://github.com/eprints/eprints3.5/tree/master/ci/pytest/eprints/ but there are only a few tests at the moment and it is a work in progress to build up a suite of tests that will ultimately be more comprehensive than the current Selenium IDE acceptance tests
+Also, we are currently in the process of integrating CI with GitHub pull requests to test a build of the pull request to informed reviewers of whether it is OK to merge.  These tests are written in [https://playwright.dev/ Playwright] and can be found under https://github.com/eprints/eprints3.5/tree/master/ci/pytest/eprints/ but there are only a few tests at the moment and it is a work in progress to build up a suite of tests that will ultimately be more comprehensive than the current Selenium IDE acceptance tests
 == Accessibility Testing ==
@@ Line 12: / Line 12: @@
 == Spell Checking ==
-[https://github.com/codespell-project/codespell Codespell] has been run across the EPrints 3.5 codebase to detect spelling errors using a combination of the [https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt standard] and [ https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary_rare.txt rare] Codespell dictionaries, which list common typos->correct spellings (e.g. seperator->separator).
+[https://github.com/codespell-project/codespell Codespell] has been run across the EPrints 3.5 codebase to detect spelling errors using a combination of the [https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt standard] and [https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary_rare.txt rare] Codespell dictionaries, which list common typos->correct spellings (e.g. seperator->separator).
 == Things for beta testers to test? ==
 Obviously when developing a new EPrints repository a lot of the testing falls into two categories:
-. Testing the new features being implemented.
+# Testing the new features being implemented.
-. Doing stock testing of generic functionality.
+# Doing stock testing of generic functionality.
 What is often gets missed is more niche features or just using an EPrints repository in non-standard ways. Therefore testing ingredients, plugins, etc. that don't come as part of the initial install would be really useful to get feedback.  As EPrints 3.5 has quite a few changes to 3.4, then trying to deploying the whole configuration, ingredients, plugins for an archive is unrealistic.  However, testing individual ingredients/plugins you will want to use on 3.5 or interesting bespoke changes to your EPrints repository, are just the sort of things we are looking for as beta test feedback.

@@ Line 3: / Line 3: @@
 == Common Apache Error messages ==
 Line numbers may not be the same in the current HEAD of this git repository:
-# (Broken pipe / The timeout specified has expired / Connection reset by peer) at **/opt/eprints3/perl_lib/EPrints/Page.pm line 78**
+# (Broken pipe / The timeout specified has expired / Connection reset by peer) at <code>/opt/eprints3/perl_lib/EPrints/Page.pm line 78</code>
-# (Broken pipe / Connection reset by peer) at  **/opt/eprints3/perl_lib/EPrints/Plugin/Export.pm line 283**
+# (Broken pipe / Connection reset by peer) at <code>/opt/eprints3/perl_lib/EPrints/Plugin/Export.pm line 283</code>
-# (Broken pipe / Connection reset by peer) at   **opt/eprints3/cgi/exportview line 126**
+# (Broken pipe / Connection reset by peer) at <code>opt/eprints3/cgi/exportview line 126</code>
-# Broken pipe at **/opt/eprints3/perl_lib/EPrints/Apache/CRUD.pm line 1670**
+# Broken pipe at <code>/opt/eprints3/perl_lib/EPrints/Apache/CRUD.pm line 1670</code>

@@ Line 1: / Line 1: @@
-As of 13th May 2026, Ubuntu 26.04 is still under testing to determine if EPrints can be successfully installed and if so if there are any issues with doing this, which require a different approach from the general approach for installing EPrints on Debian/Ubuntu Linux.
+As of 2nd July 2026, Ubuntu 26.04 is still under testing to determine if EPrints can be successfully installed and if so if there are any issues with doing this, which require a different approach from the general approach for installing EPrints on Debian/Ubuntu Linux.
 ==== Current Issues ====
-; XML library compatability problems : This will first occur at the point where you complete the credentials you want to use for your archive's database whilst you are running <code>bin/epadmin create pub</code>.  It will exhibit itself as either a segmentation fault or an error with the memory allocation (malloc) or free commands.  This is due to EPrints use of the <code>XML:LibXML</code> Perl library that ultimately uses the C library <tt>libxml2</tt>.   [https://github.com/eprints/eprints3.4/issues/509 This GitHub issue] first raised for what appears to be the same issue with FreeBSD 14.3 provides some more detail about this problem.  It is likely this relates to [https://github.com/cpan-authors/XML-LibXML/issues/81 this XML::LibXML GitHub issue], which says it has been resolved upstream, which we believe to mean in the libxml2 C library (possibly version 2.15.3).  Ubuntu 26.04 as of 13th May 2026 is still providing libxml2 version 2.15.2, so there will hopefully be an update soon.
+; XML library compatibility problems : This will first occur at the point where you complete the credentials you want to use for your archive's database whilst you are running <code>bin/epadmin create pub</code>.  It will exhibit itself as either a segmentation fault or an error with the memory allocation (malloc) or free commands.  This is due to EPrints use of the <code>XML:LibXML</code> Perl library that ultimately uses the C library <tt>libxml2</tt>.   [https://github.com/eprints/eprints3.4/issues/509 This GitHub issue] first raised for what appears to be the same issue with FreeBSD 14.3 provides some more detail about this problem.  It is likely this relates to [https://github.com/cpan-authors/XML-LibXML/issues/81 this XML::LibXML GitHub issue], which says it has been resolved upstream, which we believe to mean in the libxml2 C library (although it does not seem to gave made it into version 2.15.3).  Ubuntu 26.04 as of 2nd July 2026 is still providing libxml2 version 2.15.2, so there will hopefully be an update soon.