⧼vector-jumptocontent⧽

EPrints Directory Structure Tree: Difference between revisions

From EPrints Documentation
← Older edit
Updated lib directory links
m Tidied up links to defaultcfg
 
(9 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>
Line 62: Line 71:
</tr>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<tr><td></td><td>[[Image:jobbra.png]]</td>
     <td>[[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>
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 109: Line 123:
</tr>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<tr><td></td><td>[[Image:jobbra.png]]</td>
     <td>[[Lib/workflows|workflows]]</td>
     <td>[[Lib/workflows/|workflows]]</td>
     <td>[[Image:jobbra.png]]</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>
Line 115: Line 129:
<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 188: 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 214: 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

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

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

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