Difference between revisions of "EPrints Directory Structure Tree"

From EPrints Documentation
Jump to: navigation, search
(Updated core dir structure)
m (Tidied up links to defaultcfg)
 
(10 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;">
Line 20: Line 20:
 
   <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/tests|tests]]</td>
 +
  <td>[[Image:jobbra.png]]</td>
 +
  <td colspan="10">&#91;<i>unit tests</i>&#93;</td></tr>
 +
<tr><td>[[EPrints_Directory_Structure/eprints3/tools|tools]]</td>
 +
  <td>[[Image:jobbra.png]]</td>
 +
  <td colspan="10">&#91;<i>command line tools</i>&#93;</td></tr>
 
<tr><td>[[EPrints_Directory_Structure/eprints3/var|var]]</td>
 
<tr><td>[[EPrints_Directory_Structure/eprints3/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/site_lib|site_lib]]</td>
 +
  <td>[[Image:jobbra.png]]</td>
 +
  <td colspan="10">&#91;<i>for customized system [[EPrints_Directory_Structure/eprints3/lib|lib]] files or [[sitewide configuration]] concurrent to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|archives/[ArchiveID]/cfg]]</i>&#93;</td></tr>
 
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
 
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
−
   <td>[[EPrints_Directory_Structure/eprints3/lib/cfg.d|cfg.d]]</td>
+
   <td>[[Lib/cfg.d/|cfg.d]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td colspan="7">&#91;<i>core config files</i>&#93;</td>
 
   <td colspan="7">&#91;<i>core config files</i>&#93;</td>
Line 31: Line 40:
 
<tr><td></td>
 
<tr><td></td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
−
   <td>[[EPrints_Directory_Structure/eprints3/lib/citations|citations]]</td>
+
   <td>[[Lib/citations/|citations]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td colspan="4">&#91;<i>how to render data objects</i>&#93;</td>
 
   <td colspan="4">&#91;<i>how to render data objects</i>&#93;</td>
Line 37: Line 46:
 
<tr><td></td>
 
<tr><td></td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
−
   <td>[[EPrints_Directory_Structure/eprints3/lib/defaultcfg_zero|defaultcfg_zero]]</td>
+
   <td>[[Lib/defaultcfg_zero/|defaultcfg_zero]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td>[[Image:jobbra.png]]</td>
 
   <td colspan="7">&#91;<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>&#93;</td>
 
   <td colspan="7">&#91;<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>&#93;</td>
−
</tr>
 
−
<tr><td></td><td></td><td></td>
 
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td>[[EPrints_Directory_Structure/eprints3/lib/citations/subject|subject]]</td>
 
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td colspan="4">&#91;<i>how to render subjects</i>&#93;</td>
 
−
</tr>
 
−
<tr><td></td><td></td><td></td>
 
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td>[[EPrints_Directory_Structure/eprints3/lib/citations/user|user]]</td>
 
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td colspan="4">&#91;<i>how to render users</i>&#93;</td>
 
 
</tr>
 
</tr>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/lang|lang]]</td>
+
     <td>[[Lib/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/lib/lang/en/phrases|phrases]]</td>
+
     <td>[[Lib/lang/en/phrases/|phrases]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>&#91;<i>system-wide phrases</i>&#93;</td>
 
     <td>&#91;<i>system-wide phrases</i>&#93;</td>
Line 64: Line 61:
 
<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/lib/lang/en/static|static]]</td>
+
     <td>[[Lib/lang/en/static/|static]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>&#91;<i>web pages and icons</i>&#93;</td>
 
     <td>&#91;<i>web pages and icons</i>&#93;</td>
 
</tr>
 
</tr>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/namedsets|namedsets]]</td>
+
     <td>[[Lib/namedsets/|namedsets]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="7">&#91;<i>options for namedset fields</i>&#93;</td>
 
     <td colspan="7">&#91;<i>options for namedset fields</i>&#93;</td>
 
</tr>
 
</tr>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/plugins|plugins]]</td>
+
     <td>plugins</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td colspan="7">&#91;<i>various eprint 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>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/static|static]]</td>
+
     <td>[[Lib/static/|static]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="7">&#91;<i>files to be copied to the html directory</i>&#93;</td>
 
     <td colspan="7">&#91;<i>files to be copied to the html directory</i>&#93;</td>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/syscfg.d|syscfg.d]]</td>
+
     <td>[[Lib/syscfg.d/|syscfg.d]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="7">&#91;<i>system config files</i>&#93;</td>
 
     <td colspan="7">&#91;<i>system config files</i>&#93;</td>
 
</tr>
 
</tr>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/templates|templates]]</td>
+
     <td>[[Lib/templates/|templates]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td colspan="7">&#91;<i>web page templates</i>&#93;</td>
 
     <td colspan="7">&#91;<i>web page templates</i>&#93;</td>
 
</tr>
 
</tr>
 
<tr><td></td><td>[[Image:jobbra.png|"-&gt;"]]</td>
 
<tr><td></td><td>[[Image:jobbra.png|"-&gt;"]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/themes|themes]]</td>
+
     <td>[[Lib/themes/|themes]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/themes/example|example]]</td>
+
     <td>[[Lib/themes/example/|example]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/themes/example/lang|lang]]</td>
+
     <td>[[Lib/themes/example/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/lib/themes/example/lang/en/phrases|phrases]]</td>
+
     <td>[[Lib/themes/example/lang/en/phrases/|phrases]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>&#91;<i>theme phrases</i>&#93;</td>
 
     <td>&#91;<i>theme phrases</i>&#93;</td>
 
</tr>
 
</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>
 
<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>[[EPrints_Directory_Structure/eprints3/lib/themes/example/lang/en/static|static]]</td>
+
     <td>[[Lib/themes/example/lang/en/static/|static]]</td>
 
     <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>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/themes/example/static|static]]</td>
+
     <td>[[Lib/themes/example/static/|static]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>&#91;<i>theme CSS and images</i>&#93;</td>
 
     <td>&#91;<i>theme CSS and images</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>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/themes/example/templates|templates]]</td>
+
     <td>[[Lib/themes/example/templates/|templates]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>&#91;<i>theme templates</i>&#93;</td>
 
     <td>&#91;<i>theme templates</i>&#93;</td>
 
</tr>
 
</tr>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
 
<tr><td></td><td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/lib/workflows|workflows]]</td>
+
     <td>[[Lib/workflows/|workflows]]</td>
 +
    <td>[[Image:jobbra.png]]</td>
 
     <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>[[EPrints_Directory_Structure/eprints3/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>
Line 135: Line 138:
 
</tr>
 
</tr>
 
<tr><td>[[EPrints_Directory_Structure/eprints3/archives|archives]]</td>
 
<tr><td>[[EPrints_Directory_Structure/eprints3/archives|archives]]</td>
−
    <td>[[Image:jobbra.png]]</td>
+
  <td>[[Image:jobbra.png]]</td>
−
    <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID|ArchiveID]]</td>
+
  <td>[[EPrints_Directory_Structure/eprints3/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>
 +
</tr>
 
</table>
 
</table>
 
</div>
 
</div>
Line 198: Line 202:
 
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|citations]]</td>
 
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|citations]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|document]]</td>
+
     <td>&#91;<i>directories for citations for different data objects</i>&#93;</td>
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td colspan="3">&#91;<i>document formats</i>&#93;</td>
 
−
</tr>
 
−
<tr><td></td><td></td><td></td>
 
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|eprint]]</td>
 
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td colspan="3">&#91;<i>eprints formats</i>&#93;</td>
 
−
</tr>
 
−
<tr><td></td><td></td><td></td>
 
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|user]]</td>
 
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td colspan="3">&#91;<i>user formats</i>&#93;</td>
 
 
</tr>
 
</tr>
 
<tr><td></td>
 
<tr><td></td>
Line 224: Line 214:
 
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|workflows]]</td>
 
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|workflows]]</td>
 
     <td>[[Image:jobbra.png]]</td>
 
     <td>[[Image:jobbra.png]]</td>
−
     <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|eprint]]</td>
+
     <td>&#91;<i>directories for workflows for different data objects</i>&#93;</td>
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td colspan="3">&#91;<i>how an eprints is read in</i>&#93;</td>
 
−
</tr>
 
−
<tr><td></td><td></td><td></td>
 
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|user]]</td>
 
−
    <td>[[Image:jobbra.png]]</td>
 
−
    <td colspan="3">&#91;<i>define the user's data</i>&#93;</td>
 
 
</tr>
 
</tr>
 
<tr><td></td>
 
<tr><td></td>

Latest revision as of 10:22, 9 July 2024

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=16297’