Building a Portal Website
ESP is a package for creating XHTML websites that contain mainly text and images. It is Oracc's bespoke portal-writing software. These pages explain how to install the ESP templates in your Oracc project and edit them with Emacs in order to create a portal website. To use ESP you will need to know the basics of HTML.
Are you managing the whole ESP portal site yourself, or are you just writing ESP pages that someone else will edit and upload? Some of this documentation is just for ESP managers, and some is for all editors of ESP pages.
For both editors and managers
- Installing the ESP Templates and Schema
- This page describes how to obtain, install and configure ESP. You only need to do this once!
- Understanding ESP Page Structure
- ESP pages are written in XML. Here we describe what they look like.
- Creating Textual Content in ESP XML Files
- This page describes how to use the system-specific ESP elements and attributes to create web pages. It assumes that you know how to use Emacs and are familiar with the basics of HTML.
- ESP Style Guide
- This page describes how to write clear and accessible portal pages. It assumes that you know how to use Emacs and ESP and are familiar with the basics of HTML.
- ESP System Elements
- This page gives an alphabetical listing of all the system-specific elements available in ESP, as documented in more detail on the Creating content and Embedding images pages.
- Referring to Project URLs
- You will doubtless want to link to other Oracc pages. This document describes how to refer to Oracc web pages online or in print, using short, stable URIs. See also the user page on citing Oracc URLs.
Further details for both editors and managers
- Creating Links in ESP Pages
- This page describes how to make links and bookmarks of various sorts in ESP pages.
- Creating Glossaries, Lists of Technical Terms and Indices in ESP Pages
- Glossaries are mostly used for lists of People, Gods and Places which recur throughout an ESP site and/or an Oracc text corpus. There is also a similar set-up for lists of Technical Terms and for a site-wide Index. This page describes how to make them.
- Creating References and Bibliography in ESP Pages
- This page explains how to make a list of reference works (books, articles, etc.) and when and how to use it.
- Images and Image Maps in ESP
- This page describes how to mark up images and image maps in ESP.
- Embedded content in ESP
- This page describes how to mark up videos, Google Earth files, and other types of non-textual data in ESP.
For ESP managers only
- Overview of ESP Directory Structure
- In the course of making your ESP portal website you will need to edit several different directories and automatically generate others. This page describes what's what. ESP editors may find it helpful to know about too.
- Setting up your ESP Portal Website
- This page describes how to configure the parameters, structure, appearance, and privacy preferences of your ESP website.
- Checking, Correcting and Rebuilding your ESP Website
- This page explains how to (re)build your ESP website, how to correct errors that emerge during the rebuild, and how to avoid them in the first place.
23 Jul 2014
Eleanor Robson, 'Building a Portal Website', Oracc: The Open Richly Annotated Cuneiform Corpus, Oracc, 2014 [http://oracc.museum.upenn.edu/doc/help/portals/]