mirror of
https://github.com/DSpace/DSpace.git
synced 2025-10-23 18:03:11 +00:00
(ScottPhillips) Minor updates to the directory descriptions.
git-svn-id: http://scm.dspace.org/svn/repo/branches/dspace-1_5_x@2616 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Scott Phillips
@@ -30,51 +30,51 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><code><i>[dspace-source]</i></code>
|
<li><code><i>[dspace-source]</i></code>
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>build.xml</code> - build file for Ant</li>
|
<li><code>build.xml</code> - The Build file for Ant -- used to preform a fresh_install, upgrade, or deploy new changes.</li>
|
||||||
<li><code>CHANGES</code> - Detailed list of code changes between versions</li>
|
<li><code>CHANGES</code> - Detailed list of code changes between versions.</li>
|
||||||
<li><code>KNOWN_BUGS</code> - Known bugs in the current version</li>
|
<li><code>KNOWN_BUGS</code> - Known bugs in the current version.</li>
|
||||||
<li><code>LICENSE</code> - DSpace source code license</li>
|
<li><code>LICENSE</code> - DSpace source code license.</li>
|
||||||
<li><code>README</code> - Obligatory basic information file</li>
|
<li><code>README</code> - Obligatory basic information file.</li>
|
||||||
<li><code>bin/</code> - Some shell and Perl scripts for running DSpace command-line tasks</li>
|
<li><code>bin/</code> - Some shell and Perl scripts for running DSpace command-line tasks.</li>
|
||||||
<li><code>config/</code> - configuration files
|
<li><code>config/</code> - Configuration files:
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>controlled-vocabularies/</code> - Fixed, limited vocabularies used in metadata entry</li>
|
<li><code>controlled-vocabularies/</code> - Fixed, limited vocabularies used in metadata entry</li>
|
||||||
<li><code>crosswalks/</code> - Metadata crosswalks - property files or XSL stylesheets</li>
|
<li><code>crosswalks/</code> - Metadata crosswalks - property files or XSL stylesheets</li>
|
||||||
<li><code>dspace.cfg</code> - main DSpace configuration file</li>
|
<li><code>dspace.cfg</code> - The Main DSpace configuration file (You will need to edit this).</li>
|
||||||
<li><code>dc2mods.cfg</code> - Mappings from Dublin Core metadata to <A HREF="http://www.loc.gov/standards/mods/">MODS</A> for the METS export</li>
|
<li><code>dc2mods.cfg</code> - Mappings from Dublin Core metadata to <A HREF="http://www.loc.gov/standards/mods/">MODS</A> for the METS export.</li>
|
||||||
<li><code>default.license</code> - default license that users must grant when submitting items</li>
|
<li><code>default.license</code> - The default license that users must grant when submitting items.</li>
|
||||||
<li><code>dstat.cfg</code>, <code>dstat.map</code> - statistical report configuration</li>
|
<li><code>dstat.cfg</code>, <code>dstat.map</code> - Configuration for statistical reports.</li>
|
||||||
<li><code>input-forms.xml</code> - Submission UI metadata field configuration</li>
|
<li><code>input-forms.xml</code> - Submission UI metadata field configuration.</li>
|
||||||
<li><code>news-side.html</code> - Text of the front-page news in the sidebar</li>
|
<li><code>news-side.html</code> - Text of the front-page news in the sidebar, only used in JSPUI.</li>
|
||||||
<li><code>news-top.html</code> - Text of the front-page news in the top box</li>
|
<li><code>news-top.html</code> - Text of the front-page news in the top box, only used in teh JSPUI.</li>
|
||||||
<li><code>emails/</code> - Text and layout templates for emails sent out by the system</li>
|
<li><code>emails/</code> - Text and layout templates for emails sent out by the system.</li>
|
||||||
<li><code>language-packs/</code> - contains "dictionary files" -- Java properties files that contain user interface text in different languages</li>
|
<li><code>language-packs/</code> - Contains "dictionary files" -- Java properties files that contain user interface text in different languages</li>
|
||||||
<li><code>registries/</code> - <strong>initial</strong> contents of the bitstream format registry and Dublin Core element/qualifier registry. These are only used on initial system setup, after which they are maintained in the database.</li>
|
<li><code>registries/</code> - <strong>Initial</strong> contents of the bitstream format registry and Dublin Core element/qualifier registry. These are only used on initial system setup, after which they are maintained in the database.</li>
|
||||||
<li><code>templates/</code> - configuration files for libraries and external applications (e.g. Apache, Tomcat) are kept and edited here. They can refer to properties in the main DSpace configuration - have a look at a couple. When they're updated, a command line tool fills out these files with appropriate values from dspace.cfg, and copies them to their appropriate location (hence "templates".)</li>
|
<li><code>templates/</code> - Configuration files for libraries and external applications (e.g. Apache, Tomcat) are kept and edited here. They can refer to properties in the main DSpace configuration - have a look at a couple. When they're updated, a command line tool fills out these files with appropriate values from dspace.cfg, and copies them to their appropriate location (hence "templates".)</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><code>docs/</code> - DSpace system documentation. The technical documentation for functionality, installation, configuration, etc.</li>
|
<li><code>docs/</code> - DSpace system documentation. The technical documentation for functionality, installation, configuration, etc.</li>
|
||||||
<li><code>etc/</code> - miscelleanous stuff need to install DSpace that isn't really to do with system configuration - e.g. the PostgreSQL database schema, and a couple of configuration files that are used during the build process but not by the live system. Also contains the deployment descriptors (<code>web.xml</code> files) for the Web UI and OAI-PMH support <code>.war</code> files.
|
<li><code>etc/</code> - Miscelleanous configuration need to install DSpace that isn't really to do with system configuration - e.g. the PostgreSQL database schema, and a couple of configuration files that are used during the build process but not by the live system. Also contains the deployment descriptors (<code>web.xml</code> files) for the Web UI and OAI-PMH support <code>.war</code> files.
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>oracle/</code> - versions of the database schema and updater SQL scripts for Oracle</li>
|
<li><code>oracle/</code> - Versions of the database schema and updater SQL scripts for Oracle.</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><code>modules/</code> - The Web UI modules "overlay" directory. DSpace uses Maven to automatically look here for any customizations you wish to make to DSpace Web interfaces.
|
<li><code>modules/</code> - The Web UI modules "overlay" directory. DSpace uses Maven to automatically look here for any customizations you wish to make to DSpace Web interfaces.
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>dspace-jspui</code> - Contains all customizations for the JSP User Interface.
|
<li><code>dspace-jspui</code> - Contains all customizations for the JSP User Interface.
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>src/main/resources/</code> - The overlay for JSP-UI Resources. This is the location to place any custom Messages.properties files.</li>
|
<li><code>src/main/resources/</code> - The overlay for JSPUI Resources. This is the location to place any custom Messages.properties files.</li>
|
||||||
<li><code>src/main/webapp/</code> - The overlay for JSP-UI Web Application. This is the location to place any custom JSPs to be used by DSpace.</li>
|
<li><code>src/main/webapp/</code> - The overlay for JSPUI Web Application. This is the location to place any custom JSPs to be used by DSpace.</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><code>dspace-lni</code> - Contains all customizations for the Lightweight Network Interface.</li>
|
<li><code>dspace-lni</code> - Contains all customizations for the Lightweight Network Interface.</li>
|
||||||
<li><code>dspace-oai</code> - Contains all customizations for the OAI-PMH Interface.</li>
|
<li><code>dspace-oai</code> - Contains all customizations for the OAI-PMH Interface.</li>
|
||||||
<li><code>dspace-xmlui</code> - Contains all customizations for the XML User Interface (aka Manakin).
|
<li><code>dspace-xmlui</code> - Contains all customizations for the XML User Interface (aka Manakin).
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>src/main/webapp/</code> - The overlay for XML-UI Web Application. This is the location to place custom Themes or Configurations.
|
<li><code>src/main/webapp/</code> - The overlay for XMLUI Web Application. This is the location to place custom Themes or Configurations.
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>i18n/</code> - The location to place a custom version of the XML-UI's messages.xml</li>
|
<li><code>i18n/</code> - The location to place a custom version of the XMLUI's messages.xml</li>
|
||||||
<li><code>themes/</code> - The location to place custom Themes for the XML-UI</li>
|
<li><code>themes/</code> - The location to place custom Themes for the XMLUI</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@@ -114,7 +114,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<H2><A NAME="webapp">Contents of JSP-UI Web Application</A></H2>
|
<H2><A NAME="webapp">Contents of JSPUI Web Application</A></H2>
|
||||||
|
|
||||||
<P>DSpace's Ant build file creates a <code>dspace-jspui-webapp/</code> directory with the following structure:</P>
|
<P>DSpace's Ant build file creates a <code>dspace-jspui-webapp/</code> directory with the following structure:</P>
|
||||||
|
|
||||||
@@ -124,10 +124,10 @@
|
|||||||
<LI>The JSPs</LI>
|
<LI>The JSPs</LI>
|
||||||
<LI><code>WEB-INF/</code>
|
<LI><code>WEB-INF/</code>
|
||||||
<UL>
|
<UL>
|
||||||
<LI><code>web.xml</code> - DSpace JSP-UI Web Application configuration and Servlet mappings</li>
|
<LI><code>web.xml</code> - DSpace JSPUI Web Application configuration and Servlet mappings</li>
|
||||||
<LI><code>dspace-tags.tld</code> - DSpace custom tag descriptor</LI>
|
<LI><code>dspace-tags.tld</code> - DSpace custom tag descriptor</LI>
|
||||||
<LI><code>fmt.tld</code> - JSTL message format tag descriptor, for internationalization</LI>
|
<LI><code>fmt.tld</code> - JSTL message format tag descriptor, for internationalization</LI>
|
||||||
<LI><code>lib/</code> - All the third-party JARs and pre-compiled DSpace API JARs needed to run JSP-UI</lI>
|
<LI><code>lib/</code> - All the third-party JARs and pre-compiled DSpace API JARs needed to run JSPUI</lI>
|
||||||
<li><code>classes/</code> - Any additional necessary class files</LI>
|
<li><code>classes/</code> - Any additional necessary class files</LI>
|
||||||
</UL>
|
</UL>
|
||||||
</LI>
|
</LI>
|
||||||
@@ -136,7 +136,7 @@
|
|||||||
</UL>
|
</UL>
|
||||||
|
|
||||||
|
|
||||||
<H2><A NAME="webapp">Contents of XML-UI Web Application (aka Manakin)</A></H2>
|
<H2><A NAME="webapp">Contents of XMLUI Web Application (aka Manakin)</A></H2>
|
||||||
|
|
||||||
<P>DSpace's Ant build file creates a <code>dspace-xmlui-webapp/</code> directory with the following structure:</P>
|
<P>DSpace's Ant build file creates a <code>dspace-xmlui-webapp/</code> directory with the following structure:</P>
|
||||||
|
|
||||||
@@ -147,21 +147,21 @@
|
|||||||
<LI><code>i18n/</code> - Internationalization / Multilingual support. Contains the <code>messages.xml</code> English language pack by default.</LI>
|
<LI><code>i18n/</code> - Internationalization / Multilingual support. Contains the <code>messages.xml</code> English language pack by default.</LI>
|
||||||
<LI><code>themes/</code> - Contains all out-of-the-box Manakin themes
|
<LI><code>themes/</code> - Contains all out-of-the-box Manakin themes
|
||||||
<UL>
|
<UL>
|
||||||
<LI><code>Classic/</code> - The classic theme, which makes the XML-UI look like classic DSpace</LI>
|
<LI><code>Classic/</code> - The classic theme, which makes the XMLUI look like classic DSpace</LI>
|
||||||
<LI><code>dri2xhtml/</code> - The base theme, which converts XML-UI DRI (Digital Repository Interface) format into XHTML for display</LI>
|
<LI><code>dri2xhtml/</code> - The base theme, which converts XMLUI DRI (Digital Repository Interface) format into XHTML for display</LI>
|
||||||
<LI><code>Reference/</code> - The default reference theme for XML-UI</LI>
|
<LI><code>Reference/</code> - The default reference theme for XMLUI</LI>
|
||||||
<LI><code>template/</code> - A theme template...useful as a starting point for your own custom theme(s)</LI>
|
<LI><code>template/</code> - A theme template...useful as a starting point for your own custom theme(s)</LI>
|
||||||
<LI><code>dri2xhtml.xsl</code> - The DRI-to-XHTML XSL Stylesheet. Uses the above 'dri2xhtml' theme to generate XHTML</LI>
|
<LI><code>dri2xhtml.xsl</code> - The DRI-to-XHTML XSL Stylesheet. Uses the above 'dri2xhtml' theme to generate XHTML</LI>
|
||||||
<LI><code>themes.xmap</code> - The Theme configuration file. It determines which theme(s) are used by XML-UI</LI>
|
<LI><code>themes.xmap</code> - The Theme configuration file. It determines which theme(s) are used by XMLUI</LI>
|
||||||
</UL>
|
</UL>
|
||||||
</LI>
|
</LI>
|
||||||
<LI><code>WEB-INF/</code>
|
<LI><code>WEB-INF/</code>
|
||||||
<UL>
|
<UL>
|
||||||
<LI><code>lib/</code> - All the third-party JARs and pre-compiled DSpace JARs needed to run XML-UI</lI>
|
<LI><code>lib/</code> - All the third-party JARs and pre-compiled DSpace JARs needed to run XMLUI</lI>
|
||||||
<li><code>classes/</code> - Any additional necessary class files</LI>
|
<li><code>classes/</code> - Any additional necessary class files</LI>
|
||||||
<LI><code>cocoon.xconf</code> - XML-UI's Apache Cocoon configuration</li>
|
<LI><code>cocoon.xconf</code> - XMLUI's Apache Cocoon configuration</li>
|
||||||
<LI><code>logkit.xconf</code> - XML-UI's Apache Cocoon Logging configuration</li>
|
<LI><code>logkit.xconf</code> - XMLUI's Apache Cocoon Logging configuration</li>
|
||||||
<LI><code>web.xml</code> - XML-UI Web Application configuration and Servlet mappings</li>
|
<LI><code>web.xml</code> - XMLUI Web Application configuration and Servlet mappings</li>
|
||||||
</UL>
|
</UL>
|
||||||
</LI>
|
</LI>
|
||||||
</UL>
|
</UL>
|
||||||
|
|||||||
Reference in New Issue
Block a user