Overview of ESP folder/directory structure

ESP comes pre-installed in your Oracc project with certain files and folders/directories which are explained in more detail here. This page is mostly for ESP site managers but it may be helpful for editors to read too.

Directory structure | 00res | 00web | 00web/00config | 00web/about

Directory structure

00res/
    downloads/
    images/
00web/
    00config/
	parameters.xml
	referents.xml
	structure.xml  
    about/
        404.xml
        accesskeys.xml
        cookies.xml
	licensing.xml
        sitemap.xml
        standards.xml
    about.xml
    glossarypage.xml
    home.xml
    indexpage.xml
    techtermspage.xml
    template-blank.xml

In the course of making your website you will be editing some of these files, as well as adding more as you need them.

00res/

Put all static content for your portal site in here. Images, PDFs, etc. are typically rather large, and need to be uploaded only once, so we keep them out of the way in a separate folder.

00res/downloads/

Any files for the site that are intended to be downloadable, such as copies of PDFs, large images, Google Earth and Google Maps KML/KMZ content, etc.

When creating links to downloadable content, use the <esp:link> tag with the url attribute and the file name in the project's downloads folder. E.g., for the project doc, the downloads URL would be:

<esp:link url="/doc/downloads/example.kmz" title="example file">Example 
text</esp:link>

For more information, see the page on embedded content in ESP.

00res/images/

All images that are to be displayed on the site should be placed in this folder. When using the <esp:image> tag to insert images into a page, the processor will look for the images in the 00res/images folder by default. You can create subfolders with the same names as your site folder structure to organise your images, but remember to specify the correct location of the image in the file attribute.

For more information, see the page on images in ESP.

00web/

This folder contains the text pages for the website. You will also find a copy of it in your templates bundle.

about.xml

This template file contains a directory listing of all the files in 00web/about. You can add to it if you want to add further files to that folder, but we strongly recommend that you do not delete anything from it, as all these files are necessary to comply with basic web accessibility standards and EU Cookies law.

glossarypage.xml

A template file for the People, Gods & Places glossary. See the Glossary help for more information on how to edit this file. Do not change its name.

If you do not want a glossary, you can either delete this file or omit it from the site listing in structure.xml.

home.xml

A template file for your ESP site's home page, to get you started. Do not change its name and do not delete it.

indexpage.xml

A template file for an index of names or other terms. See the Index help for more information on how to edit this file. Do not change its name.

If you do not want an index, you can either delete this file or omit it from the site listing in structure.xml.

techtermspage.xml

A template file for the Technical Terms glossary. See the List of Technical Terms help for more information on how to edit this file. Do not change its name.

If you do not want a list of technical terms, you can either delete this file or omit it from the site listing in structure.xml.

template-blank.xml

A general-purpose template page. Save edited copies with new file names. You can create subfolders in 00web/ to house new files if you want. Any file not listed in structure.xml will not appear on the website, so you can keep template-blank.xml wherever is convenient.

There are detailed instructions on how to edit or create ESP pages on the ESP Setup page and the Content Creation page.

00web/00config/

This folder contains the files that set the basic appearance of the website. You will need to edit these at least once.

00web/00config/parameters.xml

Some parameters for the site are defined in the file parameters.xml. Most of these parameters will need to be set up initially and then do not need to be altered. There are instructions on the ESP setup page on how to do this.

00web/00config/referents.xml

ESP has extensive functionality for referencing articles, journals, books, websites etc. within the site's pages. References are stored in this file. There are instructions on the ESP Content page on how to edit it.

00web/00config/structure.xml

The structure of the website is defined in this file, which is described in more detail on the ESP Setup page.

00web/about/

The pages in this folder are important for compliance with international web standards on accessibility and EU cookies law. You should not edit them unless you notice a problem with them. Ask your liaison for advice if necessary.

404.xml

404 is the HTML code for "file not found". If web visitor tries to access a page that doesn't exist on your site, e.g., by mistyping, ESP will display this page and point them to the site-map. So it is important not to delete it.

accesskeys.xml

This file creates a page giving keyboard shortcuts to the main web pages in your site. It contains only the accesskeys-listing element and should not be edited. To set which pages can be accessed like this, use the accesskey attribute in structure.xml.

cookies.xml

All websites viewed in the European Union have to inform visitors if the site uses cookies, and to allow visitors to opt out of cookie use. For more formal details about this requirement, see the UK Information Commissioner's Office's website [http://www.ico.org.uk/for_organisations/privacy_and_electronic_communications/the_guide/cookies].

As all Oracc sites use Google Analytics cookies to track visitor trends, we are legally obliged to include this page. Do not edit this page unless you need to add information about extra cookies you have added to your site.

licensing.xml

By default all Oracc sites are released under a Creative Commons Attribution Share-Alike license to encourage sharing and reuse, while fully identifying the creator(s). If you need to negotiate a different license contact your liaison. Note that a portal site may have a different license to the corpus that accompanies it.

sitemap.xml

This file generates a site-map, which is important for web accessbility compliance. It does not need editing at all.

Once you have understood the structure of ESP, you are ready to set it up on your Oracc project.

Eleanor Robson

Eleanor Robson, 'Overview of ESP folder/directory structure', Oracc: The Open Richly Annotated Cuneiform Corpus, Oracc, 2019 [http://oracc.museum.upenn.edu/doc/help/portals/espfolders/]