Oracc Notes and News: Portals on ESP2

For Project Managers with ESP portal sites

All portal sites on Oracc now need to be in the new version of ESP, called ESP2. If you need help in converting your site, please contact your project liaison.

ESP2 differs in several ways from the old version of ESP. We have made these changes primarily to make it easier to use Oracc on small screens such as phones.

Help pages have improved

All Oracc help pages are now written in ESP2 and have been revised and restructured to make them easier to use. But the documentation is for you! So if anything doesn't make sense, let me know, and I will try to improve it.

Some highlights to draw your attention to:

Style guide: Clearer, more comprehensive advice on good practice
Project URLs: How to link to Oracc pages that are outside your own project
Embedded content: How to embed static content (search bar, corpus stats, video, twitter feeds, etc.)

Minor changes to the schema

If you edit your ESP2 site on Emacs (strongly recommended!) you'll need to download and install the new schema as described here to make sure your xml files are valid.

Changes to where files live

ESP2 is now the default website software on Oracc, so the xml files have been moved up to the top level of 00web. Configuration files such as structure.xml are now in 00web/00config. To make uploads and rebuilds easier, images and static downloads such as PDFs and KML files are now store separately, in 00res/images/ and 00res/downloads/ respectively.

In other words, the directory structure is now:

00res/
    downloads/
    images/
00web/
    00config/
  parameters.xml
         referents.xml
         structure.xml
    about/
    home.xml
    etc.

For full information, see the new Oracc help page on ESP folders.

Tabs and image maps have gone

The tabs on the right-hand side of old ESP pages have disappeared. If you want to link to external sites from the left-hand menu, you can use <struct:link> to do so.

Many old ESP sites used image maps, especially on the front page. Image maps do not shrink to fit small screens so we have removed this functionality but the images used in the image maps have been kept. All links must now be text-based.

You should delete the <param:tabs> element and its contents from your 00web/00config/parameters.xml file.

For more hints on this topic see the new Oracc help on Links and Site Parameters.

Headers have gone

We have removed the header above the main title — with links to pages such as Access Keys, Site Map, Text Size, Privacy, Web Standards, Credits & Copyright, etc.

We now recommend that you make these available via the main menu instead.

Edit your 00web/00config/structure.xml to add:

<struct:page file="about.xml" id="about" accesskey="6" type="page">
    <struct:page file="404.xml" id="404" hide-menu-link="yes" type="page"/>
    <struct:page file="accesskeys.xml" id="accesskeys" accesskey="0" type="page"/>
    <struct:page file="cookies.xml" id="cookies" accesskey="7"  type="page"/>
    <struct:page file="accessibility.xml" id="accessibility" type="page"/>
    <struct:page file="sitemap.xml" id="sitemap" accesskey="9"  type="page"/>
   </struct:page>

and remove the old <struct:page> elements for these pages from the file. (They may have different names, e.g., standards.xml, copyright.xml.)

For more information see the new Oracc help on Site Structure and 00web/about/.

Footers need to change

All Oracc sites (and indeed all websites) need to comply with European Union law on notifying users about the site's use of cookies. We therefore strongly recommend that you change the content of your header. To do this, edit your 00web/00config/parameters.xml file so that the <param:footer> element looks like this:

<param:footer>The [NAME] Project at <esp:link
url="http://oracc.org/" hide-print="yes">Oracc.org</esp:link> / 
Content released under a <esp:link
url="http://creativecommons.org/licenses/by-sa/3.0/" 
rel="external" hide-print="yes">CC BY-SA 3.0</esp:link> licence, 2013-14<br/>
<small>Oracc sites use cookies only to collect Google Analytics data. 
Read more <esp:link page="privacy">here</esp:link>; 
see the stats <esp:link url="http://www.seethestats.com/site/oracc.museum.upenn.edu"
rel="external" hide-print="yes">here</esp:link>; opt out <esp:link
url="http://tools.google.com/dlpage/gaoptout" rel="external"
hide-print="yes">here</esp:link>.</small></param:footer>

Changing [NAME] to the name of your project.

For more help on parameters.xml see the new Oracc help on Site Parameters.

Some `About` files need to change

Again, this is about making Oracc's policy on standards, legal compliance, etc., a bit clearer. Download these template files and edit them to suit your project:

00web/about.xml
00web/about/accessibility.xml
00web/about/cookies.xml

Then place them in your project's 00web and 00web/about folder respectively.

`appearance.xml` has disappeared

You now choose the fonts and colours for both portal and corpus in 00lib/p3colours.txt. For details see the Oracc help page about web colours.

Rebuilding

You can now rebuild the portal and the corpus separately:

Use the oracc build portal command to rebuild the portal;
Use the oracc build corpus command to rebuild your corpus if you have one;
Use the oracc build project command to rebuild both.

If you have added new images or downloads to your site, you should run oracc resources before you run oracc build portal in order to copy the new files to the right place on the webserver.

See the help page on the Oracc command for more information.

The new rebuilding process is documented on the Oracc help page