Difference between revisions of "EPrints Directory Structure Tree"

From EPrints Documentation
Jump to: navigation, search
m
m
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{dirs}}
 
{{dirs}}
  
−
A graphical representation of the [[EPrints Directory Structure|EPrints3 directory structure]] after executing the install.pl command. Initially the "archives" directory is empty, it is populated when executing (as the eprints user) the "bin/epadmin create" command. The new repository is created using the data in the [[EPrints_Directory_Structure/eprints3/lib/defaultcfg]] directory.
+
A graphical representation of the [[EPrints Directory Structure|EPrints3 directory structure]] after executing the install.pl command. Initially the <tt>archives</tt> directory is empty, it is populated when executing (as the <tt>eprints</tt> user) the <code>bin/epadmin create</code> command. The new repository is created using the data in the [[lib/defaultcfg_zero/]] directory if not using an [[EPrints Flavours|flavour]] or [[flavours/pub_lib/defaultcfg/|flavours/FLAVOUR/defaultcfg/]] if you are.
  
 
<div style="margin:2em; background-color:#e9e9e9;">
 
<div style="margin:2em; background-color:#e9e9e9;">
 
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
 
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
−
<tr><td>[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib]]</td>
+
<tr><td>[[Perl_lib/|perl_lib]]</td>
 
   <td>[[Image:jobbra.png|-&gt;]]</td>
 
   <td>[[Image:jobbra.png|-&gt;]]</td>
 
   <td colspan="10">&#91;<i>perl routines</i>&#93;</td></tr>
 
   <td colspan="10">&#91;<i>perl routines</i>&#93;</td></tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/bin|bin]]</td>
+
<tr><td>[[Bin/|bin]]</td>
 
   <td>[[Image:jobbra.png|-&gt;]]</td>
 
   <td>[[Image:jobbra.png|-&gt;]]</td>
 
   <td colspan="10">&#91;<i>command line and crontab tools</i>&#93;</td></tr>
 
   <td colspan="10">&#91;<i>command line and crontab tools</i>&#93;</td></tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/cgi|cgi]]</td>
+
<tr><td>[[Cgi/|cgi]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td colspan="10">&#91;<i>dynamic (cgi) EPrints web pages</i>&#93;</td></tr>
 
   <td colspan="10">&#91;<i>dynamic (cgi) EPrints web pages</i>&#93;</td></tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/cfg|cfg]]</td>
+
<tr><td>[[Cfg/|cfg]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td colspan="10">&#91;<i>apache configuration for the whole site</i>&#93;</td></tr>
 
   <td colspan="10">&#91;<i>apache configuration for the whole site</i>&#93;</td></tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td>
+
<tr><td>[[Testdata/|testdata]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td colspan="10">&#91;<i>tools and sample test data</i>&#93;</td></tr>
 
   <td colspan="10">&#91;<i>tools and sample test data</i>&#93;</td></tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/var|var]]</td>
+
<tr><td>[[Tests/|tests]]</td>
 +
  <td>[[Image:jobbra.png]]</td>
 +
  <td colspan="10">&#91;<i>unit tests</i>&#93;</td></tr>
 +
<tr><td>[[Tools/|tools]]</td>
 +
  <td>[[Image:jobbra.png]]</td>
 +
  <td colspan="10">&#91;<i>command line tools</i>&#93;</td></tr>
 +
<tr><td>[[Var/|var]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td colspan="10">&#91;<i>apache include files plus indexer log</i>&#93;</td></tr>
 
   <td colspan="10">&#91;<i>apache include files plus indexer log</i>&#93;</td></tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
+
<tr><td>[[Site_lib/|site_lib]]</td>
 +
  <td>[[Image:jobbra.png]]</td>
 +
  <td colspan="10">&#91;<i>for customized system [[Lib/|lib]] files or [[sitewide configuration]] concurrent to [[Archives/ARCHIVEID/cfg/|archives/ARCHIVEID/cfg]]</i>&#93;</td></tr>
 +
<tr><td>[[Lib/|lib]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Lib/cfg.d/|cfg.d]]</td>
 
   <td>[[Lib/cfg.d/|cfg.d]]</td>
Line 64: Line 73:
 
     <td>plugins</td>
 
     <td>plugins</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td colspan="7">&#91;<i>Additional EPrints plugins</i>&#93;</td>
+
     <td colspan="7">&#91;<i>extra EPrints plugins</i>&#93;</td>
 
</tr>
 
</tr>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
Line 97: Line 106:
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>&#91;<i>theme language-specific pages</i>&#93;</td>
 
     <td>&#91;<i>theme language-specific pages</i>&#93;</td>
 +
</tr>
 +
<tr><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td>[[Image:jobbra.png]]</td>
 +
    <td>[[Lib/themes/example/lang/en/templates/|templates]]</td>
 +
    <td>[[Image:jobbra.png]]</td>
 +
    <td>&#91;<i>theme language-specific templates</i>&#93;</td>
 
</tr>
 
</tr>
 
<tr><td></td><td></td><td></td><td></td><td></td><td>[[Image:jobbra.png]]</td>
 
<tr><td></td><td></td><td></td><td></td><td></td><td>[[Image:jobbra.png]]</td>
Line 113: Line 127:
 
     <td colspan="4">&#91;<i>workflows for data objects</i>&#93;</td>
 
     <td colspan="4">&#91;<i>workflows for data objects</i>&#93;</td>
 
</tr>
 
</tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/flavours|flavours]]</td>
+
<tr><td>[[Flavours/|flavours]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
−
   <td>[[EPrints_Directory_Structure/eprints3/flavours/pub_lib|pub_lib]]</td>
+
   <td>[[Flavours/pub_lib/|pub_lib]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td colspan="7">&#91;<i>see [[EPrints Flavours|3.4+ publication flavour]]</i>&#93;</td>
 
   <td colspan="7">&#91;<i>see [[EPrints Flavours|3.4+ publication flavour]]</i>&#93;</td>
 
</tr>
 
</tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/ingredients|ingredients]]</td>
+
<tr><td>[[Ingredients/|ingredients]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td colspan="7">&#91;<i>see [[EPrints Ingredients|3.4+ ingredients]]</i>&#93;</td>
 
   <td colspan="7">&#91;<i>see [[EPrints Ingredients|3.4+ ingredients]]</i>&#93;</td>
 
</tr>
 
</tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/archives|archives]]</td>
+
<tr><td>[[Archives/|archives]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
−
   <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID|ARCHIVEID]]</td>
+
   <td>[[Archives/ARCHIVEID/|ARCHIVEID]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td colspan="7">&#91;<i>see below</i>&#93;</td>
 
   <td colspan="7">&#91;<i>see below</i>&#93;</td>
Line 136: Line 150:
 
<div style="margin:2em; background-color:#e9e9e9;">
 
<div style="margin:2em; background-color:#e9e9e9;">
 
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
 
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
−
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents]]&nbsp;</td>
+
<tr><td>[[Archives/ARCHIVEID/documents/|documents]]&nbsp;</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="7">&#91;<i>uploaded files, extracted words, abstract pages, etc.</i>&#93;</td>
 
     <td colspan="7">&#91;<i>uploaded files, extracted words, abstract pages, etc.</i>&#93;</td>
 
</tr>
 
</tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html]]</td>
+
<tr><td>[[Archives/ARCHIVEID/html/|html]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="7">&#91;<i>static files for the repository on all languages</i>&#93;</td>
 
     <td colspan="7">&#91;<i>static files for the repository on all languages</i>&#93;</td>
 
</tr>
 
</tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var]]</td>
+
<tr><td>[[Archives/ARCHIVEID/var/|var]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="7">&#91;<i>various repository dependent files</i>&#93;</td>
 
     <td colspan="7">&#91;<i>various repository dependent files</i>&#93;</td>
 
</tr>
 
</tr>
−
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]</td>
+
<tr><td>[[Archives/ARCHIVEID/cfg/|cfg]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="7">subjects &#91;<i>used for importing the subject tree</i>&#93;</td>
 
     <td colspan="7">subjects &#91;<i>used for importing the subject tree</i>&#93;</td>
Line 154: Line 168:
 
<tr><td></td>
 
<tr><td></td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|static]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/static/|static]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static/images|images]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/static/images/|images]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="3">&#91;<i>files to be copied to the html directory</i>&#93;</td>
 
     <td colspan="3">&#91;<i>files to be copied to the html directory</i>&#93;</td>
Line 162: Line 176:
 
<tr><td></td><td></td><td></td>
 
<tr><td></td><td></td><td></td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static/javascript|javascript]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/static/javascript/|javascript]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="3">&#91;<i>files to be copied to the html directory</i>&#93;</td>
 
     <td colspan="3">&#91;<i>files to be copied to the html directory</i>&#93;</td>
Line 168: Line 182:
 
<tr><td></td><td></td><td></td>
 
<tr><td></td><td></td><td></td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static/style|style]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/static/style/|style]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="3">&#91;<i>files to be copied to the html directory</i>&#93;</td>
 
     <td colspan="3">&#91;<i>files to be copied to the html directory</i>&#93;</td>
Line 174: Line 188:
 
<tr><td></td>
 
<tr><td></td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg.d]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/cfg.d/|cfg.d]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="5">&#91;<i>general configuration files as perl script fragments</i>&#93;</td>
 
     <td colspan="5">&#91;<i>general configuration files as perl script fragments</i>&#93;</td>
Line 180: Line 194:
 
<tr><td></td>
 
<tr><td></td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/autocomplete|autocomplete]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/autocomplete/|autocomplete]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="5">&#91;<i>data files for the autocompletion feature</i>&#93;</td>
 
     <td colspan="5">&#91;<i>data files for the autocompletion feature</i>&#93;</td>
Line 186: Line 200:
 
<tr><td></td>
 
<tr><td></td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|citations]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/citations/|citations]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>&#91;<i>directories for citations for different data objects</i>&#93;</td>
 
     <td>&#91;<i>directories for citations for different data objects</i>&#93;</td>
Line 192: Line 206:
 
<tr><td></td>
 
<tr><td></td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|namedsets]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/namedsets/|namedsets]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="5">&#91;<i>files containing the possible values for different sets</i>&#93;</td>
 
     <td colspan="5">&#91;<i>files containing the possible values for different sets</i>&#93;</td>
Line 198: Line 212:
 
<tr><td></td>
 
<tr><td></td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|workflows]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/workflows/|workflows]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>&#91;<i>directories for workflows for different data objects</i>&#93;</td>
 
     <td>&#91;<i>directories for workflows for different data objects</i>&#93;</td>
Line 204: Line 218:
 
<tr><td></td>
 
<tr><td></td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lang]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/lang/|lang]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>XX (langid)</td>
 
     <td>XX (langid)</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|phrases]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/lang/en/phrases/|phrases]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>&#91;<i>phrases used locally</i>&#93;</td>
 
     <td>&#91;<i>phrases used locally</i>&#93;</td>
Line 214: Line 228:
 
<tr><td></td><td></td><td></td><td></td><td></td>
 
<tr><td></td><td></td><td></td><td></td><td></td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static|static]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/lang/en/static/|static]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>&#91;<i>templates for static html pages</i>&#93;</td>
 
     <td>&#91;<i>templates for static html pages</i>&#93;</td>
Line 220: Line 234:
 
<tr><td></td><td></td><td></td><td></td><td></td>
 
<tr><td></td><td></td><td></td><td></td><td></td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|templates]]</td>
+
     <td>[[Archives/ARCHIVEID/cfg/lang/en/templates/|templates]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>&#91;<i>default html page template</i>&#93;</td>
 
     <td>&#91;<i>default html page template</i>&#93;</td>

Latest revision as of 17:33, 9 October 2026

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

A graphical representation of the EPrints3 directory structure after executing the install.pl command. Initially the archives directory is empty, it is populated when executing (as the eprints user) the bin/epadmin create command. The new repository is created using the data in the lib/defaultcfg_zero/ directory if not using an flavour or flavours/FLAVOUR/defaultcfg/ if you are.

perl_lib -> [perl routines]
bin -> [command line and crontab tools]
cgi Jobbra.png [dynamic (cgi) EPrints web pages]
cfg Jobbra.png [apache configuration for the whole site]
testdata Jobbra.png [tools and sample test data]
tests Jobbra.png [unit tests]
tools Jobbra.png [command line tools]
var Jobbra.png [apache include files plus indexer log]
site_lib Jobbra.png [for customized system lib files or sitewide configuration concurrent to archives/ARCHIVEID/cfg]
lib Jobbra.png cfg.d Jobbra.png [core config files]
Jobbra.png citations Jobbra.png [how to render data objects]
Jobbra.png defaultcfg_zero Jobbra.png [the content of archives/ID/cfg/ is copied from here]
Jobbra.png lang Jobbra.png XX (langid) Jobbra.png phrases Jobbra.png [system-wide phrases]
Jobbra.png static Jobbra.png [web pages and icons]
Jobbra.png namedsets Jobbra.png [options for namedset fields]
Jobbra.png plugins Jobbra.png [extra EPrints plugins]
Jobbra.png static Jobbra.png [files to be copied to the html directory]
Jobbra.png syscfg.d Jobbra.png [system config files]
Jobbra.png templates Jobbra.png [web page templates]
"->" themes Jobbra.png example Jobbra.png lang Jobbra.png XX (langid) Jobbra.png phrases Jobbra.png [theme phrases]
Jobbra.png static Jobbra.png [theme language-specific pages]
Jobbra.png templates Jobbra.png [theme language-specific templates]
Jobbra.png static Jobbra.png [theme CSS and images]
Jobbra.png templates Jobbra.png [theme templates]
Jobbra.png workflows Jobbra.png [workflows for data objects]
flavours Jobbra.png pub_lib Jobbra.png [see 3.4+ publication flavour]
ingredients Jobbra.png [see 3.4+ ingredients]
archives Jobbra.png ARCHIVEID Jobbra.png [see below]

The content of the "archives/[ArchiveID]/" directory. Any change you make here has effect on the particular repository only.

documents  Jobbra.png [uploaded files, extracted words, abstract pages, etc.]
html Jobbra.png [static files for the repository on all languages]
var Jobbra.png [various repository dependent files]
cfg Jobbra.png subjects [used for importing the subject tree]
Jobbra.png static Jobbra.png images Jobbra.png [files to be copied to the html directory]
Jobbra.png javascript Jobbra.png [files to be copied to the html directory]
Jobbra.png style Jobbra.png [files to be copied to the html directory]
Jobbra.png cfg.d Jobbra.png [general configuration files as perl script fragments]
Jobbra.png autocomplete Jobbra.png [data files for the autocompletion feature]
Jobbra.png citations Jobbra.png [directories for citations for different data objects]
Jobbra.png namedsets Jobbra.png [files containing the possible values for different sets]
Jobbra.png workflows Jobbra.png [directories for workflows for different data objects]
Jobbra.png lang Jobbra.png XX (langid) Jobbra.png phrases Jobbra.png [phrases used locally]
Jobbra.png static Jobbra.png [templates for static html pages]
Jobbra.png templates Jobbra.png [default html page template]
Retrieved from ‘https://wiki.eprints.org/w/index.php?title=EPrints_Directory_Structure_Tree&oldid=17486’