Difference between revisions of "Quickstart:Customise EPrints"

From EPrints Documentation
Jump to: navigation, search
(→‎Concepts)
(→‎Phrases)
Line 10: Line 10:
 
<p>Your Archive is the directory created in <code>/opt/eprints3/archives/</code>. This holds your configuration and files that override default functionality as well as the physical location of content stored in the repository.</p>
 
<p>Your Archive is the directory created in <code>/opt/eprints3/archives/</code>. This holds your configuration and files that override default functionality as well as the physical location of content stored in the repository.</p>
 
==== Phrases ====
 
==== Phrases ====
 +
<p>Text in EPrints is designed to be customisable by admin users to allow them to match their organisations language and tone. To achieve this, references are included in templates which then load the content entered by an admin.</p>
 +
<p>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.</p>
 +
<p>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:</p>
 +
<code><epp:phrase id="archive_name">Example Archive</epp:phrase></code>
 +
 
==== Citations ====
 
==== Citations ====
  

Revision as of 13:34, 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 allow them to match their organisations language and tone. To achieve this, 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

Site Look and Feel

Templates

Custom Files

Views

Workflows

Functionality

Core Files

Ingredients

EPMs/Bazaar Plugins