EpiDoc on väljä yhteistyöhön perustuva hanke. Siihen osallistuu tutkimusprojekteja ja tutkijoita, jotka työstävät alkuperäislähteitä Text Encoding Initiative (TEI) XML -merkintäkielellä ja jotka pohtivat suosituksia, työkaluja ja hyviä menettelytapoja tekstien koodaamiseen, digitaaliseen käsittelyyn ja tällä tavoin tuotettujen aineistojen julkaisemiseen. EpiDocin kotisivut löytyvät osoitteesta: http://epidoc.sf.net.
Tämä sivusto (EpiDoc Ohjeisto) on EpiDoc-yhteisön monen vuoden työn tulos ja sen työstäminen jatkuu edelleen. Näillä sivuilla kerrotaan, kuinka koodata piirtokirjoituksissa ja papyruksissa ilmeneviä seikkoja. Ohjeet perustuvat tieteellisen tekstieditoimisen keskeisille periaatteille (esimerkiksi ns. Leidenin sopimuksen mukaiseen merkintätapaan tekstin ilmiöiden kuvaamisessa sekä aineistomalleihin, kuten esim. kreikkalaisen ja latinalaisen piirtokirjoitustutkimuksen digitaalinen arkisto (EAGLE), materiaalisten ja historiallisten piirteiden kuvaamisessa). Ohjeisto on tarkoitettu käytettäväksi yhdessä EpiDoc-skeeman ja tyyliarkkimalliston kanssa. EpiDoc-periaatteiden mukaisesti koodattujen dokumenttien tulee olla skeemassa kuvattujen sääntöjen mukaisia. EpiDoc-tyyliarkeissa puolestaan pyritään tarjoamaan perustulkinta kaikille kuvattaville piirteille.
EpiDoc-ohjeistossa ei kerrota kuinka käynnistää EpiDoc-projekti, luoda verkkosivu, rakentaa hakutoiminnot tai muutakaan sellaista teknisiin tai yhteistyöhankkeisiin liittyvää, jota tarvitaan digitaalisten aineistojen julkaisemiseen verkkoympäristössä. Ohjeisto ei ole myöskään johdatus piirtokirjoitus- tai papyrustutkimukseen. EpiDoc-ohjeisto on yksinomaan opas siihen kuinka XML-merkintäkielellä ilmaistaan alkuperäislähteisiin perustuvien tekstieditioiden piirteet, mitä tavallisimmin käytetään piirtokirjoitusten sekä muiden vastaavanlaisten kohteiden tutkimuksessa.
Ei ole olemassa yhtä ainoaa tapaa koostaa piirtokirjoitus- tai papyruseditio. EpiDoc-ohjeistossa (ja EpiDoc-tyyliarkeissa) kuitenkin otetaan suunta sen kaltaisiin aineistomalleihin, joita on käytetty esimerkiksi hankkeissa Advanced Papyrological Information System (APIS), EAGLE ja Programme d’enregistrement, de traitement et de recherche automatique en épigraphie (PETRAE). Koska piirtokirjoitustutkimuksessa ylipäätään ja varsinkin digitaalisessa piirtokirjoitustutkimuksessa on jo perusteellisesti toteutettuja esimerkkejä hyvistä menettelytavoista editioiden jäsentämisessä, me yksinkertaisesti vain suosittelemme, että myös TEI XML -merkintäkielellä kirjoitettaessa editiot sisältäisivät sen tietomäärän ja yksityiskohdat, jotka tutkijat ovat jo havainneet keskeisiksi ja hyödyllisiksi käytännössä.
EpiDoc-ohjeiston on tarkoitus täydentää Leidenin merkintätapaa, joka on ollut epigraafikoiden ja papyrologien käytössä jo yli 80 vuotta ja jota osataan lukea monilla filologisilla ja alkuperäisdokumentteihin pohjaavilla tutkimusaloilla. Ohjeistossa oletetaan, että Leidenin merkintätavassa käytetyt käsitteet muodostavat riittävän perustan esimodernien tekstien editioissa ilmenevien piirteiden kuvaamiseen, ja se antaa suosituksia ja esimerkkejä, jotka pohjautuvat näihin käsitteisiin, asettamatta kuitenkaan vaatimusta käyttää jotakin tarkasti määriteltyä typografiaa tai siinä suositeltua lyhennetapaa. Toisin sanoen, EpiDoc pyrkii esitystapaan, jossa XML-merkintäkielellä kuvataan tekstin ominaisuus kuten esim. editoijan täydentämä, alkuperäisdokumentista vaurion vuoksi kadonnut kirjain, mutta EpiDoc ei määrää, että kyseinen kirjain tulisi esittää kulmasulkeissa ([ ja ]) XML:ssä tai jossain tulevassa julkaisussa. EpiDoc-tyyliarkin tehtävä on tulkita EpiDocin mukaisesti koodattu teksti ja kääntää se Leidenin merkintätavan mukaiseksi. TEI-merkintäkielellä on mahdollista kuvata hienovaraisempia ja yksityiskohtaisempia piirteitä kuin Leidenin merkintätavassa. Näillä sivuilla kerrotaan myös joistakin näistä mahdollisuuksista. Ohjeistossa ei kuitenkaan suositella standardin epigrafisen tai papyrologisen käytännön korvaamista sellaisilla uusilla periaatteilla.
EpiDoc-yhteisön tuottama ja suosittelema Ohjeisto on jalostettu TEI-ohjeistosta ja muodostaa näin sen osajoukon. TEI-ohjeistosta löytyy suosituksia XML-koodausta varten monenlaisille kirjallisille ja historiallisille teksteille ja kielellisille kokoelmille. EpiDoc on vanhojen tekstien ja esineiden dokumentointiin erikoistunut TEI:n osa, joka ehdottaa ainoastaan niiden elementtien, attribuuttien ja arvojen käyttöä, joita tässä erikoisryhmässä tarvitaan. EpiDoc-ohjeisto on tarkoitettu täydentämään (eikä missään tapauksessa korvaamaan) TEI-ohjeistoa. Erityisesti TEI:n viite- ja tekniset osiot ovat edelleen korvaamaton lähde myös EpiDocin käyttäjille, jotka monesti kokevat hyödyllisiksi niiden sisältämät luettelot elementeistä, attribuuttien arvojen tai tietotyyppien selityksistä, monenlaisissa ympäristöissä annetuista käyttöesimerkeistä sekä laajoista merkintäkielen piirteiden kuvauksista. EpiDoc-ohjeiston suositukset koostuvat varsin suppeasta määrästä TEI:n elementtejä, sisältömalleja, attribuutteja ja arvoja. Jokainen EpiDoc-tiedosto on myös validi TEI-tiedosto, mutta jokainen TEI-tiedosto ei ole validia EpiDocia. Niissä seikoissa, missä EpiDoc-ohjeisto on rajoittavampi kuin TEI, EpiDocia tulee pitää ensisijaisena ohjeena. Kuitenkin niissä seikoissa, missä TEI on huomattavasti yksityiskohtaisempi tai tarjoaa hyödyllisempiä esimerkkejä, siitä luonnollisestikin tulee hakea neuvoa ja se tulee huomioida kaikenlaisen EpiDocin käytön kanonisena lähteenä.
EpiDoc-ohjeisto koostuu yksittäisistä sivuista, joille pääsee useampaa reittiä.
Ohjeiston yksittäiset sivut on järjestetty epigrafisten tai papyrologisten käsitteiden perusteella eikä TEI-elementtien nimien mukaisesti. Näin esimerkiksi kaikki sellaiset sivut, joissa käsitellään lyhenteitä, on ryhmitelty yhteen (otsakkeen Editorial Interventions alle) välittämättä siitä, mitä TEI-elementtejä niiden merkitsemisessä käytetään. Ohjeiston jokainen sivu on rakenteeltaan samankaltainen: ensin selitetään lyhyesti sivun otsikon merkitys (esim. sivulla, jonka otsikko on Tulkitsemattomat merkit, selitys on ’Selvästi näkyvät mutta käsittämättömät merkit’). Sen alla esitetään asianmukainen TEI-elementti (tai elementit) sekä annetaan linkki TEI-ohjeiston sivulle, jossa ko. elementti on esitelty yksityiskohtaisesti. Tämän jälkeen kerrotaan EpiDocin mukaiset suositukset kyseisten TEI-elementtien käyttöön sekä niihin yhdistettävissä olevien attribuuttien ja arvojen yksityiskohtia.
Selitysten alapuolelta löytyy yleensä myös muutama esimerkki sen aidosta käyttöympäristöstä. Erityisesti transkriptioiden piirteiden ollessa kyseessä ohjeistossa esitetään kustakin aiheesta yleisten epigrafisten ja papyrologisten transkriptio-ohjeiden mukaisia perinteisiä tulkintoja, esim. Krummrey-Panciera, Duke Databank.
XML-esimerkeistä näkee erilaisille transkriptioiden piirteille soveliaan merkintäkielen, esim. tavat merkitä symbolin sisältävän lyhennyksen avaus. Malliesimerkeissä luetellaan useampia merkintäkielen vaihtoehtoja, joista voi valita sen mukaan, kuinka yksityiskohtaisesti asia halutaan ilmaista. Esimerkkien jälkeen esitetään sarja tulkintoja (tai eri tulkinta jokaisen esimerkin jälkeen), joista näkee, millaisia tulostusvaihtoehtoja EpiDoc P5 -tyyliarkeista kyseiselle merkintäkielen ilmaukselle löytyy. Oletustulostus on Krummrey-Pancieran periaatteiden mukainen. Muita tyylejä ovat mm. SEG, London ja DDbDP. Jokaisessa esimerkissä on lähdeviite. Useimmat piirtokirjoituksiin liittyvät esimerkkitapaukset on poimittu Afrodisiaksen (Inscriptions of Aphrodisias) tai Tripolitanian (Inscriptions of Roman Tripolitania) tekstien joukosta ja papyrologiset puolestaan Duke Databank of Documentary Papyri:n kokoelmista.
Tämä Ohjeisto on pohjimmiltaan lähdeteos. Perusteellisempaan harjoitteluun ja tukeen on tarjolla muita keinoja. EpiDoc-yhteisön jäsenet järjestävät ajoittain harjoituskursseja ja saavat niihin toisinaan myös rahoitusta isommilta tutkimushankkeilta (esim. Afrodisiaksen piirtokirjoitusten tutkimusprojekti rahoitti useita EpiDoc-työpajoja vuosina 2004–2008). Tällaisista harjoituskursseista löytyy lisätietoa Koulutus-sivulta EpiDocin wikissä. Ne, joille EpiDoc ja tekstin koodaus on täysin uutta, saattavat hyötyä myös TEI:n yleisluontoisista harjoituskursseista (TEI:n tapahtumalistalta löytyy ainakin osa ko. kursseista).
EpiDoc-merkintäkieltä voi kirjoittaa ja editoida millä tahansa XML-kielelle tarkoitetulla perustyökalulla (luettelo löytyy Editointityökalut-sivulta TEI:n wikissä). Tavallisesti EpiDoc- ja TEI-harjoituskursseilla, tai missä tahansa XML-kurssilla, käydään läpi tällaisten työkalujen peruskäyttöä. Julkaisemiseen, hakujärjestelmien luomiseen ja muuhun EpiDoc ja TEI-tiedostojen työstöön käytetään XML-kielen muuntajana XSLT ja XQuery-kieliä, yleisinä hakualustoina saattaa olla mm. Solr tai TEI:lle erityisesti luotu avoimeen koodiin perustuva työkalu kuten Kiln ja Papyrological Navigator.
Mikäli eteen tulee ongelma, johon ei tunnu löytyvän vastausta näiltä ohjesivuilta, kysymys kannattaa esittää Markup-listalla.