Phrase Format

From EPrints Documentation
Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


XML Configuration: EPScript - Control Format (EPC) - Citation - Workflow - Phrase - Template - XPAGE (static pages)


Phrase files are stored in the repository's phrases directory, and follow a straightforward format. All of the phrase elements described by the file are contained within a single root phrases tag:

<epp:phrases xmlns="http://www.w3.org/1999/xhtml" 
           xmlns:epp="http://eprints.org/ep3/phrase" 
           xmlns:epc="http://eprints.org/ep3/control">

  <epp:phrase id="myphrase">A phrase containing a <epc:pin name="mypin" />.</epp:phrase>

</epp:phrases>

The phrase element itself has an id attribute, which is used by the system to reference the phrase. One id matches one phrase - if a phrase is specified with an id that is already in use, the old phrase will be replaced. As such, the repository phrase files may override phrases from the system phrases.

EPrints Control Format elements may be used inside the phrase file - in this example a pin is used within the phrase, which is supplied when the phrase is rendered.