Difference between revisions of "Quickstart:Customise EPrints"

From EPrints Documentation
Jump to: navigation, search
(→‎Citations)
(→‎Citations)
Line 16: Line 16:
  
 
==== Citations ====
 
==== Citations ====
−
In [[#EPrints repository software|EPrints repository software]] a citation means something slightly different from what it means in research publication. For the former it refers to a text string describing a publication, which may more commonly described in research publications as a ''reference''. 
+
In [[#EPrints repository software|EPrints repository software]], a citation means something slightly different from what it means in research publication.
  
−
EPrints repository software has citation style files, which describe how to generate the text string, not just for [[#EPrint|eprints]] but also other [[#Data object|data objects]], each of which can have different citation style files for different purposes. These files can be found under [[lib/citations/]], [[flavours/pub_lib/citations/]] and the [[#Archive|archive]]'s ''cfg/citations/'' directory.   
+
EPrints repository software has files which describe how to generate the text string, not just for [[#EPrint|eprints records]] but also other [[#Data object|data objects]], which it calls 'Citation Style Files' (<i>Citations</i>). A data object may have different citation files for different purposes and each object may have different citation files. These files can be found under [[lib/citations/]], [[flavours/pub_lib/citations/]] and the [[#Archive|archive]]'s <code>cfg/citations/</code> directory.   
  
−
See here for more information about the [[Citation Format|citation formats]] and a training video about [[Training_Video:Citation_Styles|citation styles]].
+
<i>See here for more information about the [[Citation Format|citation formats]].</i>
  
 
== Site Look and Feel ==
 
== Site Look and Feel ==

Revision as of 13:46, 8 October 2026


This page assumes you have completed the previous pages in the Quickstart Guide.

What does Customise Mean in EPrints?

There are lots of ways you may want to customise EPrints, this page aims to help you understand what those ways are, and direct you to resources to help you achieve those changes.

Concepts

When changing your EPrints system, there are a few concepts its helpful to be aware of before you begin.

Archive

Your Archive is the directory created in /opt/eprints3/archives/. This holds your configuration and files that override default functionality as well as the physical location of content stored in the repository.

Phrases

Text in EPrints is designed to be customisable by admin users. To achieve this, placeholder references are included in templates which then load the content entered by an admin.

Phrases have various purposes. One is to ensure consistent use of terminology throughout the archive. It also essential for supporting multi-language archives. They are used for defining all metadata field names and their help texts.

A prominent example of a phrase is an archive's name which is appears in the archive directory's cfg/lang/en/phrases/archive_name.xml, as follows:

<epp:phrase id="archive_name">Example Archive</epp:phrase>

Citations

In EPrints repository software, a citation means something slightly different from what it means in research publication.

EPrints repository software has files which describe how to generate the text string, not just for eprints records but also other data objects, which it calls 'Citation Style Files' (Citations). A data object may have different citation files for different purposes and each object may have different citation files. These files can be found under lib/citations/, flavours/pub_lib/citations/ and the archive's cfg/citations/ directory.

See here for more information about the citation formats.

Site Look and Feel

Templates

Custom Files

Views

Workflows

Functionality

Core Files

Ingredients

EPMs/Bazaar Plugins