Difference between revisions of "EPrints Directory Structure Tree"
m (Tidied up links to defaultcfg) |
|||
(17 intermediate revisions by 3 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. | + | 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 14: | Line 14: | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
<td colspan="10">[<i>dynamic (cgi) EPrints web pages</i>]</td></tr> | <td colspan="10">[<i>dynamic (cgi) EPrints web pages</i>]</td></tr> | ||
− | <tr><td> | + | <tr><td>[[EPrints_Directory_Structure/eprints3/cfg|cfg]]</td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td colspan="10">[<i> | + | <td colspan="10">[<i>apache configuration for the whole site</i>]</td></tr> |
<tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td> | <tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
<td colspan="10">[<i>tools and sample test data</i>]</td></tr> | <td colspan="10">[<i>tools and sample test data</i>]</td></tr> | ||
+ | <tr><td>[[EPrints_Directory_Structure/eprints3/tests|tests]]</td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td colspan="10">[<i>unit tests</i>]</td></tr> | ||
+ | <tr><td>[[EPrints_Directory_Structure/eprints3/tools|tools]]</td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td colspan="10">[<i>command line tools</i>]</td></tr> | ||
+ | <tr><td>[[EPrints_Directory_Structure/eprints3/var|var]]</td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td colspan="10">[<i>apache include files plus indexer log</i>]</td></tr> | ||
+ | <tr><td>[[EPrints_Directory_Structure/eprints3/site_lib|site_lib]]</td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td colspan="10">[<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>]</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>[[ | + | <td>[[Lib/cfg.d/|cfg.d]]</td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td colspan="7">[<i> | + | <td colspan="7">[<i>core config files</i>]</td> |
+ | </tr> | ||
+ | <tr><td></td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td>[[Lib/citations/|citations]]</td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td colspan="4">[<i>how to render data objects</i>]</td> | ||
+ | </tr> | ||
<tr><td></td> | <tr><td></td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td>[[ | + | <td>[[Lib/defaultcfg_zero/|defaultcfg_zero]]</td> |
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td colspan="7">[<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>]</td> | ||
+ | </tr> | ||
+ | <tr><td></td><td>[[Image:jobbra.png]]</td> | ||
+ | <td>[[Lib/lang/|lang]]</td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td> | + | <td>XX (langid)</td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td | + | <td>[[Lib/lang/en/phrases/|phrases]]</td> |
− | |||
− | |||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td | + | <td>[<i>system-wide phrases</i>]</td> |
− | |||
− | |||
</tr> | </tr> | ||
− | <tr><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>[[ | + | <td>[[Lib/lang/en/static/|static]]</td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td | + | <td>[<i>web pages and icons</i>]</td> |
</tr> | </tr> | ||
− | <tr><td></td><td>[[Image:jobbra.png | + | <tr><td></td><td>[[Image:jobbra.png]]</td> |
− | <td>[[ | + | <td>[[Lib/namedsets/|namedsets]]</td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td | + | <td colspan="7">[<i>options for namedset fields</i>]</td> |
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
− | <tr><td></td><td></td><td></td> | + | <tr><td></td><td>[[Image:jobbra.png]]</td> |
+ | <td>plugins</td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td | + | <td colspan="7">[<i>extra EPrints plugins</i>]</td> |
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr><td></td><td>[[Image:jobbra.png]]</td> | <tr><td></td><td>[[Image:jobbra.png]]</td> | ||
− | <td>[[ | + | <td>[[Lib/static/|static]]</td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td>[[ | + | <td colspan="7">[<i>files to be copied to the html directory</i>]</td> |
+ | <tr><td></td><td>[[Image:jobbra.png]]</td> | ||
+ | <td>[[Lib/syscfg.d/|syscfg.d]]</td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td colspan=" | + | <td colspan="7">[<i>system config files</i>]</td> |
</tr> | </tr> | ||
<tr><td></td><td>[[Image:jobbra.png]]</td> | <tr><td></td><td>[[Image:jobbra.png]]</td> | ||
− | <td>[[ | + | <td>[[Lib/templates/|templates]]</td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td colspan="7">[<i> | + | <td colspan="7">[<i>web page templates</i>]</td> |
</tr> | </tr> | ||
− | <tr><td></td><td>[[Image:jobbra.png]]</td> | + | <tr><td></td><td>[[Image:jobbra.png|"->"]]</td> |
− | <td>[[ | + | <td>[[Lib/themes/|themes]]</td> |
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td>[[Lib/themes/example/|example]]</td> | ||
+ | <td>[[Image:jobbra.png]]</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>[[ | + | <td>[[Lib/themes/example/lang/en/phrases/|phrases]]</td> |
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td>[<i>theme phrases</i>]</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/static/|static]]</td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td>[<i> | + | <td>[<i>theme language-specific pages</i>]</td> |
</tr> | </tr> | ||
− | <tr><td></td><td></td><td></td><td></td><td></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>[[Lib/themes/example/lang/en/templates/|templates]]</td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td>[[ | + | <td>[<i>theme language-specific templates</i>]</td> |
+ | </tr> | ||
+ | <tr><td></td><td></td><td></td><td></td><td></td><td>[[Image:jobbra.png]]</td> | ||
+ | <td>[[Lib/themes/example/static/|static]]</td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td>[<i> | + | <td>[<i>theme CSS and images</i>]</td> |
</tr> | </tr> | ||
− | <tr><td> | + | <tr><td></td><td></td><td></td><td></td><td></td><td>[[Image:jobbra.png]]</td> |
+ | <td>[[Lib/themes/example/templates/|templates]]</td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td> | + | <td>[<i>theme templates</i>]</td> |
+ | </tr> | ||
+ | <tr><td></td><td>[[Image:jobbra.png]]</td> | ||
+ | <td>[[Lib/workflows/|workflows]]</td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td colspan="7">[<i>see below</i>]</td> | + | <td colspan="4">[<i>workflows for data objects</i>]</td> |
+ | </tr> | ||
+ | <tr><td>[[EPrints_Directory_Structure/eprints3/flavours|flavours]]</td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td>[[Flavours/pub_lib/|pub_lib]]</td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td colspan="7">[<i>see [[EPrints Flavours|3.4+ publication flavour]]</i>]</td> | ||
+ | </tr> | ||
+ | <tr><td>[[EPrints_Directory_Structure/eprints3/ingredients|ingredients]]</td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td colspan="7">[<i>see [[EPrints Ingredients|3.4+ ingredients]]</i>]</td> | ||
+ | </tr> | ||
+ | <tr><td>[[EPrints_Directory_Structure/eprints3/archives|archives]]</td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID|ARCHIVEID]]</td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td colspan="7">[<i>see below</i>]</td> | ||
+ | </tr> | ||
</table> | </table> | ||
</div> | </div> | ||
− | The content of the "archives/[ArchiveID]/" directory | + | The content of the "archives/[ArchiveID]/" directory. Any change you make here has effect on the particular repository only. |
+ | |||
<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;"> | ||
Line 113: | Line 163: | ||
</tr> | </tr> | ||
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]</td> | <tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]</td> | ||
+ | <td>[[Image:jobbra.png]]</td> | ||
+ | <td colspan="7">subjects [<i>used for importing the subject tree</i>]</td> | ||
+ | </tr> | ||
+ | <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>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|static]]</td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td | + | <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static/images|images]]</td> |
− | |||
− | |||
− | |||
− | |||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
<td colspan="3">[<i>files to be copied to the html directory</i>]</td> | <td colspan="3">[<i>files to be copied to the html directory</i>]</td> | ||
Line 126: | 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>javascript</td> | + | <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static/javascript|javascript]]</td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
<td colspan="3">[<i>files to be copied to the html directory</i>]</td> | <td colspan="3">[<i>files to be copied to the html directory</i>]</td> | ||
Line 132: | 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>style</td> | + | <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static/style|style]]</td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
<td colspan="3">[<i>files to be copied to the html directory</i>]</td> | <td colspan="3">[<i>files to be copied to the html directory</i>]</td> | ||
Line 152: | 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 | + | <td>[<i>directories for citations for different data objects</i>]</td> |
− | |||
− | |||
</tr> | </tr> | ||
− | <tr | + | <tr><td></td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/ | + | <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|namedsets]]</td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td colspan=" | + | <td colspan="5">[<i>files containing the possible values for different sets</i>]</td> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr><td></td> | <tr><td></td> | ||
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/ | + | <td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|workflows]]</td> |
<td>[[Image:jobbra.png]]</td> | <td>[[Image:jobbra.png]]</td> | ||
− | <td | + | <td>[<i>directories for workflows for different data objects</i>]</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 | [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] |