Tutorial on Digital Epigraphy

The following document contains materials that should help participants prepare for the workshop on digital epigraphy organised by the project PROMETHEUS – Promoting Universal Values through Digital Epigraphy and Cultural Heritage that will be organised across 5 workshop days, 15-19 April 2024 on Zoom and YouTube platforms.

The workshop is intended for the project members and external participants, GLAM professionals, researchers and students involved in epigraphic heritage management and curation in the partnering countries. Training sessions and lectures will be delivered by project team members and guest lecturers.

A knowledge of Ancient Greek and Latin is required for participation in the EpiDoc part of the workshop.

Requirements

Participants are not required to have any previous knowledge of TEI-XML or any other technologies that will be taught during the course of the workshop. However, it is required that they prepare necessary equipment and software in order to effectively participate in an epigraphical training workshop that involves hands-on training.

1.1 Equipment

Necessary equipment:

A computer with stable internet connection.

Optional equipment:

If you have the possibility, it may be useful to have two screens, one for following the programme and another for hands-on practice.

1.2 Software and Accounts

It is required that participants pre-install software and open accounts that will be used for hands-on practice during the workshop.

1.2.1 Software

Oxygen XML Editor

Oxygen XML Editor is a software tool that helps you work with XML files. XML is a type of markup language used for structuring data. The participants will need this software in order to learn how to encode inscriptions in EpiDoc which uses XML as a programming language.

❗❗❗ Participants should install the Oxygen XML Editor before the workshop. ❗❗❗

Installation:

Go to oxygenxml.com

●Download and install Oxygen XML Editor that is suitable for your OS (Windows, MacOS, etc.)

Run

●To run the application start oxygen26.1.exe or oxygen.bat from the product installation directory.

Licence:

●Request a free 30-day demo licence HERE
●Choose Academic licence type.
●Copy to clipboard the licence key you have received by email and paste it in the licence registration dialog box from the application.

If you have a difficulty with the instruction watch videos on how to install Oxygen on Windows 10 and MacOS

EFES (EpiDoc Front End Services)

EFES is a free, easy to use, highly customisable platform for the online publication of ancient texts in EpiDoc XML. It was developed in 2017-2018 by a team of experts (Gabriel Bodard, Jamie Norrish, Polina Yordanova, Simona Stoyanova). EFES allows the creation of multiple indices, search and browse interface, geographical visualisation, and integration with linked open data. During the workshop, participants will be trained on how to use EFES.

❗❗❗ Participants should install the EFES before the workshop and try to run the programme following the instructions ❗❗❗

https://github.com/EpiDoc/EFES/wiki/Installation

https://github.com/EpiDoc/EFES/wiki/User-Guide#quickstart

Have Java 8 (at least) installed.
Get the EFES software: you can either download the ZIP from https://github.com/EpiDoc/EFES/archive/master.zip or clone from Github if you have an account already.
When the ZIP file is downloaded, unzip it in a directory (e.g. on your Desktop), changing the folder name from 'EFES-master' into 'EFES'.
Open up your Command prompt/Terminal:
1. a.Windows: in the search box in the Start menu type: cmd
2. b.GNU/Linux or Mac OS X: in the search box in the Menu bar on top type: terminal
Start the EFES build process, navigating to your EFES folder (a) and then running a script that will start Jetty, a lightweight web server that is pre-configured to run all EFES components (b):
1. a.Windows:
  1. i.navigate to your EFES folder typing the following command and then pressing Enter: cd Desktop\EFES
  2. ii.type the following command and then press Enter: build.bat
2. b.GNU/Linux or Mac OS X:
  1. i.navigate to your EFES folder typing the following command and then pressing Enter: cd Desktop/EFES
  2. ii.type the following command and then press Enter: sh build.sh
  3. iii.
Open a browser and go to http://127.0.0.1:9999/. It should display a welcome page together with some very basic navigation.
Store project XML content (EpiDoc files) in the folder /webapps/ROOT/content/xml/epidoc/.
Index newly added files through the Admin panel on the site.
View HTML versions of your XML files at http://127.0.0.1:9999/en/inscription s/.

This installation guide along with some possible troubleshooting issues find on:

https://github.com/EpiDoc/EFES/wiki/Installation

AIAX PORTABLE

Aiax is the Telamon Project’s front-end platform. By its functions it is analogous to EFES. However, its technical implementation is different as it is carried out with the help of an SQL database storing the elements, attributes, and values of the XML code of individual files and processing them with the help of PHP.

During the workshop the participants will have an opportunity to be trained in using AIAX.

❗❗❗Please, open and run the application at least once before the workshop ❗❗❗

To download the local version of the AIAX software, please follow these instructions:

1. Open your web browser and go to the following URL:

https://telamon.uni-sofia.bg/en/page/project

2. On the webpage, locate the download link for the AIAX software. It's prominently displayed under the "Test it" section. Click on the download link to initiate the download process.

3. Once the download is complete, navigate to the folder where the downloaded file is saved.

4. Locate the downloaded file, a compressed file (e.g., a ZIP file). Right-click on the file and

select “Extract” to unzip the contents of the file.

5. After extracting the contents, open the folder named "AiaxTelamonPortable".

6. Inside the folder, you should find an executable file named "Telamon". This is the main executable file for the AIAX software.

7. Double-click on the”Telamon” executable file to launch the AIAX software.

8. Click "Allow" on Apache server dialog window then click "Allow" on the mysql dialog window.

9. You now have a running local version of the AIAX software, you can begin using the software for your desired tasks.

If you encounter any issues during the installation or launch process, please ensure that your computer's ports are not occupied and close any unnecessary programs that are running in the background. You can refer to this guide here on how to close effectively a running program: https://www.thewindowsclub.com/how-to-close-running-apps-on-windows-11-10

This can help resolve potential conflicts and ensure smooth operation of the software.

By following these steps, you should be able to download and install the local version of the AIAX software on your computer. If you encounter any further issues, please refer to the USBWebserver Quick Start Guide in the “AiaxTelamonPortable” folder or contact the organisers for assistance.

1.2.2 Creating Accounts

The participants should create accounts on the following platforms:

GitHub

The participants should create a repository on GitHub before the Afternoon Session on Tuesday, 16 April.

GitHub is a platform used for hosting and collaborating on software development projects, which allows collaborative work. GitHub enables developers to share, review, and manage changes to code efficiently, making it popular for open-source projects.

Zenodo

A GitHub account can also be used for Zenodo, thanks to the integration between two platforms. You can also create a separate Zenodo account.

Zenodo is an open-access repository developed by CERN (European Organization for Nuclear Research) to facilitate the sharing and archiving of research data. It provides researchers, projects, and institutions with a platform to store, preserve, and share diverse types of research outputs.

Zotero

Zotero is a free, open-source reference management software that helps researchers collect, organise, cite, and share research materials such as articles, books, web pages, and more. It is widely used for academic writing and research. In this workshop the participants will learn how this platform can be used for digital projects.

2. Training Materials

Online documents that you will frequently consult during and after the Workshop:

EpiDoc Guidelines

Leiden and EpiDoc Quick Reference (shorter)
Structure of an EpiDoc page

3. Inscriptions for practice

As this is a training workshop that involves hands-on training where you will learn how to encode in EpiDoc XML you will need inscriptions that you will use for practice. It is preferable that you use your own material for practice.

However, if you do not have your own material, you can choose inscriptions from online databases:

You can also use & remix material from one of the EpiDoc databases, e.g.

Telamon, IGCyr, IOSPE, CGRN, Inscriptions of Roman Cyrenaica 2020.

If you do not have your own material and do not feel like browsing the databases you can use one of the examples attached below:

Latin: Funerary inscription for Cassius Felix from Ratiaria

Honorary inscription for Gaius Valerius Valentianus

Dedication to the Gods of Egiridava

Dedication to Casebonus

Greek: Statue base for Emperor Trajan

Dedication to Pluto by Longinus

Funerary inscription for the veteran Aurelius Posidonius

Milestone for Emperor Gordian III

Statue base for Caesar Maximus

Greek 1
Greek 2
Greek 3
Greek 4

4. Further Reading

In Prometheus Zotero Library - First Workshop Reading list there is a collection containing useful titles for further reading, that are linked to the source. Most of the publications in the list are published under open licences and are freely accessible.

Prometheus project Zotero Library:

First Workshop - Reading List

Important Links

Here are some useful and important links leading to the important training materials and reference sites that the participants of the workshop will want to visit during and after their training in digital epigraphy.

EFES Documentation

https://github.com/EpiDoc/EFES

Markup List