EFES Structure and File Layout

On EFES the work happens on two levels:

• EFES folder on user's computer: where the files to be edited are, and where new files can be added; to edit the files, you need to use an (XML) editor on your computer
• browser interface (http://127.0.0.1:9999/): mainly to see the outcome and to use Admin functions (e.g. harvesting and indexing)

The EFES folder comprises of many folders and files, the sheer number of which could be intimidating. A vast amount of these files are necessary for internal processes and should not need to be modified by the user. The file structure should not be modified, and the folder and file names - which are case-sensitive - should not be changed. Do not create subfolders, especially in 'epidoc' folder.

Below is the structure and file layout in EFES; note that the folders/files in bold are those that the non-technical user should focus their attention on when they customize EFES for their project.

• build.bat — Ant startup script for Windows.
• build.sh — Ant startup script for Mac OS X/Linux.
• buildfiles — Ant core build files. This should not need to be modified.
• local.build.properties — Local Ant properties file.
• local.build.xml — Local Ant build file to override core functionality.
• example — Example webapps.
• sw — Software used in building and running Kiln.
• webapps
  • ROOT — Project webapp.
    • assets
      • foundation — Foundation CSS/JS framework.
      • images — Non-content images.
      • menu — Navigation menu.
      • queries — XML containing base queries
        • solr — Solr query fragments
      • schema
        • menu — Kiln schema, do not change.
        • tei — Schema for TEI files.
      • scripts — JavaScript files and libraries.
      • styles — CSS files and libraries.
      • templates — Templates for content display.
      • translations — message files containing translations for multilingual sites.
    • admin — Templates for the admin system.
    • content
      • images — Project/content images.
      • xml
        • authority — authority lists.
        • epidoc — EpiDoc XML files.
        • indices — templates for generating epidoc and tei indices.
        • tei — TEI XML files.
    • kiln — Kiln core files, should not need to be modified.
    • mount-table.xml — Cocoon’s sitemap mount table (do not modify).
    • not-found.xml — Default file to display when a resource is not found.
    • resources — Cocoon resources (do not modify).
    • sitemap.xmap — Cocoon default sitemap (do not modify).
    • sitemaps — Project’s sitemaps.
      • admin.xmap — Admin and editorial pipelines.
      • config.xmap — Configuration (global variables, etc).
      • internal.xmap — Internal (not exposed by URL) pipelines.
      • main.xmap — Main pipelines.
      • rdf.xmap — RDF pipelines.
      • solr.xmap — Search pipelines.
    • defaults.xsl — Defines default globals and reads parameters from the sitemaps.
    • escape-xml.xsl — Formats XML for literal display within HTML.
    • stylesheets — Project’s XSLT stylesheets.
      • admin — Admin and editorial transformations.
      • epidoc — EpiDoc related transformations.
      • error — Error handling.
      • introspection — Introspection of sitemaps and XSLT.
      • menu — Menu manipulation.
      • metadata — Extraction of metadata from files.
      • rdf — RDF harvesting and querying.
      • schematron — Schematron output.
      • solr — Searching and indexing.
      • system — Cocoon stylesheets (do not modify).
      • tei — TEI display.
    • WEB—INF — Webapp configuration.
  • openrdf-sesame and openrdf-workbench — RDF / Linked Open Data framework.
  • solr — Searching framework.
    • conf
      • schema.xml — Definition of fields etc.

Troubleshooting

• If the webapps/ROOT/content/xml/tei folder is missing, it should be created manually.
• If using Kiln, the webapps/ROOT/content/xml/epidoc folder should be created manually, otherwise the indexing will fail.