TEIWiki - User contributions [en]

Physical Collation

2014-10-23T16:39:41Z

Dot.porter: Created page with "A space for comparing current usage of XML to describe the physical collation of manuscripts, with the aim of generating a proposal for new tags for the TEI. [http://www.tei-c.o..."

A space for comparing current usage of XML to describe the physical collation of manuscripts, with the aim of generating a proposal for new tags for the TEI.

[http://www.tei-c.org/Activities/Workgroups/PB/ Page of the TEI Physical Bibliography Workgroup (2007)] (includes a draft proposal for a new set of tags for collation)

SIG:MSS

2014-10-23T16:36:17Z

Dot.porter: /* Agenda of this SIG */

<big>'''TEI Special Interest Group on Manuscripts (TEI MS SIG)'''</big>

== Introduction ==
The goal of the TEI Special Interest Group on Manuscripts is to bring together users of the TEI who wish to improve the encoding strategies for marking up transcriptions and editions of manuscript materials. The SIG was originally setup by Elena Pierazzo, Susan Schreibman, and Edward Vanhoutte. It is currently convened by Gerrit Brüning and Dot Porter.

The SIG runs a mailing list. To join visit http://listserv.brown.edu/tei-ms-sig.html.

==Achievements==
The SIG’s most important achievements were in the field of the representation of primary sources, resulting in the proposals of the working group on [[Genetic Editions]] which were submitted as “[http://www.tei-c.org/Activities/Council/Working/tcw19.html An Encoding Model for Genetic Editions]” and largely incorporated in the TEI Guidelines.

Important work was done towards a revision of the chapter on critical apparatus, see working group on [[Critical_Apparatus_Workgroup|Critical Apparatus]] / [[Textual Variance]].

== Agenda of this SIG ==
Revision of the chapter on critical apparatus; issues of variation; clarify the role of using the critical apparatus tagset in manuscript transcription (which is dependent on whether one is encoding an edition or encoding a manuscript transcription). See
*[[Critical_Apparatus_Workgroup|Critical Apparatus]]
*[[Physical_Collation|Physical Collation]]
and the following threads on sourceforge, TEI-L, and SIG-L:
*http://sourceforge.net/p/tei/bugs/357/
*http://listserv.brown.edu/archives/cgi-bin/wa?A2=TEI-L;bfa42e32.1310
*http://listserv.brown.edu/archives/cgi-bin/wa?A2=TEI-MS-SIG;ad41772a.1401
*“[http://listserv.brown.edu/archives/cgi-bin/wa?A1=ind1401&L=TEI-MS-SIG#3 App. Crit. state of play and questions]” and related threads on SIG-L from January 2014.
*“[https://listserv.brown.edu/archives/cgi-bin/wa?A2=TEI-L;7d23da20.1407 <rdg>s that go on and on]“ (July 2014)
*http://sourceforge.net/p/tei/feature-requests/521/

Revision of the chapter on manuscript description; see working group on [[msDesc enhancement|MSS Description]].

Continuing and extending the work on the chapter on the representation of primary sources, see [[Sandbox for Genetic Editing]].

Further issues:
* how to encode fragments
* how to record codicology (the substance of the medium, ink stints, etc); Robinson noted that the TEI already has mechanisms to record this, but it needs to be better documented

== Past Meetings ==
The SIG met at the Third Annual TEI Members' Meeting in Nancy, France on 08 November 2003. The report can be found [http://www.tei-c.org/Activities/SIG/Manuscript/mssigr01.xml here].

The second meeting of the SIG was held at the Fourth Annual TEI Members' Meeting at Johns Hopkins University, Baltimore, USA, 23 October 2004. The report can be found [http://www.tei-c.org/Activities/SIG/Manuscript/mssigr02.xml here].

The third meeting of the SIG was held at Seventh Annual TEI Member's Meeting at University of Maryland, College Park, 3nd of November 2007. The agenda of the meeting can be found [[MS SIG Agenda 2007|here]]; the report can be found [[MS SIG Report 07|here]]. During the meeting several task forces were created to deal with specific problems: the task forces main page can be found [[MS task forces|here]].

More recent meetings:
* [[SIGMS_Agenda_20081108|Agenda SIG meeting, London 8 November 2008]]
* [[SIGMS_Minutes_20091114|Minutes SIG meeting, Ann Arbor 14 November 2009]]
* [[SIGMS_Minutes_20101112|Minutes SIG meeting, Zadar 12 November 2010]]
* [[SIGMS_Minutes_20111014|Minutes SIG meeting, Würzburg 14 October 2011]]
* [[MS_SIG_meeting,_Rome,_3_October_2013|Minutes SIG meeting, Rome, 3 October 2013]]

== Links ==
=== Lists ===
*List of “institutions using TEI to encode and digitize manuscripts,” compiled by Tucker Hannah (https://listserv.brown.edu/archives/cgi-bin/wa?A2=TEI-MS-SIG;e8b927bf.1304)<br>Google spreadsheet https://docs.google.com/document/d/1Wv5Xn4aUW8uNUv1c-B5KNyzRx_TmWOKYEZylv5znPzc/edit
*“A Catalog of Digital Scholarly Editions” by Patrick Sahle http://www.digitale-edition.de./
*“A Catalogue of Digital Editions” by Greta Franzini https://sites.google.com/site/digitaleds/home<br>Google spreadsheet “Digital Editions Catalogue” https://docs.google.com/spreadsheet/ccc?key=0Ag9fg4mfdAuPdHF2Y0twOVpaYS1MbjVWY25UNFZYWFE#gid=0
*“Editionen-Datenbank” (Editions Database) of the Deutsches Literaturarchiv Marbach (DLA) http://www.dla-marbach.de/?id=60340

=== Manuscript Description ===

Projects, resources, guidelines concerning MS description.

* [http://enrich.manuscriptorium.com ENRICH project] - standardising and aggregating medieval manuscript descriptions. See also [http://tei.oucs.ox.ac.uk/ENRICH/ OUCS ENRICH Website] containing ENRICH Schemas, ODD, Documentation and Training Materials.
* [http://sunsite3.berkeley.edu/Scriptorium/ Digital Scriptorium] (see especially the [http://sunsite3.berkeley.edu/Scriptorium/technical/description_dtd.html DESCRIPTION DTD] page).
* [http://www.hab.de/forschung/projekte/master-e.htm MASTER - Interface format for the description of medieval manuscripts]
* [http://www.tei-c.org/Activities/MS/msw05.xml Reviews of the manuscript description chapter: A summary]

=== Manuscript Editions ===
* [http://bdinski.obdurodon.org/ Bdinski sbornik: Manuscript and text]
* Carolingian Canon Law http://ccl.rch.uky.edu/
* Codex Sinaiticus http://www.codexsinaiticus.org/en/
* [http://www.kantl.be/ctb/project/dalf/ DALF: Digital Archive of Letters in Flanders]
* Queste del saint Graal http://txm.ish-lyon.cnrs.fr/bfm/?command=documentation&path=/GRAAL
* Hendrik Ibsens skrifter http://www.ibsen.uio.no/forside.xhtml
* [http://web.uvic.ca/hrd/lydgate/pilot.htm Partial Transcription of John Lydgate's "Fall of Princes"]
* [http://www.digitalmishnah.umd.edu/ Digital Mishnah Project]
* [http://mitford.pitt.edu/index.html Digital Mitford: The Mary Russell Mitford Archive]
* New Testament Transcripts http://nttranscripts.uni-muenster.de/
* New Testament Virtual Manuscript Room http://ntvmr.uni-muenster.de/
* [http://www.newtonproject.ic.ac.uk/prism.php?id=1 The Newton Project]
* [http://webapp1.dlib.indiana.edu/newton/index.jsp The Chymistry of Isaac Newton]
* [http://elec.enc.sorbonne.fr/chroniqueslatines/ Chroniques latines de Saint-Denis] : critical edition using TEI P4 (but we hope to migrate in P5 this year) : [http://elec.enc.sorbonne.fr/chroniqueslatines/xml/chroniquesstdenis.xml XML Files]
* [http://www.marktwainproject.org/homepage.html Mark Twain Project Online]
* Scholarly Digital Editions http://www.sd-editions.com/
* Les manuscrits de Stendhal en ligne http://stendhal.msh-alpes.fr/manuscrits/index.php
* [http://vbd.humnet.unipi.it/ Digital Vercelli Book]
* [http://www.desgodets.net Les Cours d'Antoine Desgodets]
* [http://tei.ibi.hu-berlin.de/berliner-intellektuelle/?en Letters and Texts. Intellectual Berlin around 1800]

=== Manuscript Transcription ===
Projects, resources, guidelines concerning MS transcription.
* [http://www.cdlib.org/inside/diglib/stwg/ms/ CDL Encoding Guidelines for Manuscripts and Rare Books]
* [http://www.scriptorium.columbia.edu/ Digital Scriptorium] (see especially the [https://www1.columbia.edu/sec/cu/libraries/bts/digital_scriptorium/technical/ds-xml/transcription_dtd/index.html TRANSCRIPTION DTD] and [https://www1.columbia.edu/sec/cu/libraries/bts/digital_scriptorium/technical/ds-xml/description_dtd/index.html DESCRIPTION DTD] pages).
* [[EpiDoc]], guidelines for transcribing ancient texts
* [http://skaldic.arts.usyd.edu.au/docs/guidelines/guide.html Guidelines for the electronic edition of the skaldic corpus]
* [http://gandalf.aksis.uib.no/menota/guidelines/ The Menota handbook]
*[http://ahds.ac.uk/creating/case-studies/newton/index.htm The Newton Project: Implementing and Exploiting XML]
* [http://www.whitmanarchive.org/guidelines/ The Walt Whitman Archive Encoding Guidelines for Poetry Manuscripts]
* [http://jefferson.village.virginia.edu/seenet/piers/protocoltran.html Transcriptional Protocols: Piers Plowman Electronic Archive and SEENET]
* [http://lemo.irht.cnrs.fr/43/43-12.htm Réflexions sur l'utilisation de la TEI pour encoder les sources diplomatiques] and [http://elec.enc.sorbonne.fr/cartulaireblanc/guidebalisage/ Guide du balisage du Cartulaire blanc] : two resources in French
* [http://ccfm.ens-lsh.fr/IMG/pdf/BFM-Mss_Encodage-XML.pdf Base de Français Médiéval - MSS Encoding Guidelines (in French)]
* [http://marjorie.burghart.online.fr/?q=en/content/tei-critical-apparatus-cheatsheet TEI: Critical Apparatus Cheatsheet]
* Guidelines for Using TEI for the Carolingian Canon Law Project http://ccl.rch.uky.edu/using-TEI

===Projects using the new genetic or documentary markup===
*Textgenetic edition of Hermann Burger's Lokalbericht; currently being modeled at [http://www.nb.admin.ch/org/organisation/00783/?lang=en SLA]/[http://www.cceh.uni-koeln.de CCeH], cf. [http://dh13.sagw.ch/de/dh13/poster/poster/zumsteg.html poster]
*“Diachronic Markup and Presentation Practices for Text Editions in Digital Research Environments“ http://www.ehumanities.uni-passau.de/projekte/diachronic-markup/
* '''[http://www.uni-goettingen.de/en/303691.html Genetic-critical and annotated hybrid-edition of Theodor Fontane’s notebooks based on a virtual research environment]''': The TEI code (not published yet) is based on a <sourceDoc>/<zone>/<line> structure.
* '''[http://shelleygodwinarchive.org/ The Shelley-Godwin Archive]''' employs an encoding based on <sourceDoc>/<zone>/<line> and making use of <milestone> (e.g. <milestone unit="tei:p"/>) and <anchor> elements. The archive distinguishes two stages of transcriptions (basic and fully vetted) and the TEI encodings are directly accessible through the browser.
*Edition of Goethe’s Faust https://faustedition.uni-wuerzburg.de/dev/project/about
*Transcription of the [http://en.wikipedia.org/wiki/Holy_Trinity_Church,_Long_Melford#Clopton_Chantry_Chapel John Lydgate verses at Holy Trinity, Long Melford], see Matthew Davis’ post on TEI-L: http://listserv.brown.edu/archives/cgi-bin/wa?A2=TEI-L;34ca5119.1311
*Representation of the papers of Fernando Pessoa, see http://listserv.brown.edu/archives/cgi-bin/wa?A2=tei-l;50923a39.1402
* Proust Prototype http://research.cch.kcl.ac.uk/proust_prototype/ (see http://markmail.org/message/vtuwcuckf4ukxqfk)

[[Category:SIG|MSS]]
[[Category:SIG:Manuscripts]]

SIG:Text&Graphic

2010-03-10T13:34:43Z

Dot.porter:

= Text & Graphics Special Interest Group =

== Description ==

'''Text and Graphics Special Interest Group'''

The TEI Guidelines are used to encode many diverse, graphically rich
documents, including illuminated manuscripts, laboratory notebooks,
art books, children's illustrated books, comics and graphic novels,
and so on. These types of graphically rich documents present special
concerns, considerations, and challenges, both conceptually at the
encoding level and technically at the transformation, presentation,
and publishing layers of digital document development.

The purpose of this SIG will be to discuss, develop, and document
various strategies and best practices for implementing the digital
facsimile structures available in TEI P5, especially as relates to
graphically rich texts, and for developing methods to extend the TEI
when existing structures are not suitable.

Visit our page on the TEI Website: http://www.tei-c.org/Activities/SIG/Graphics/

==Extending TEI Grapgics Encoding==

On March 10, 2010, Martin Holmes re-raised the question of how to encode polygons in TEI. Suggestions:

1. Use SVG.
Pro: existing standard.
Against: verbose

2. Use GML or KML
Pro: existing standard
Against: Not the intended usage of these standards

3. Use zone/desc/dim@type='point' to define each point of the polygon
Pro: no modification to TEI
Against: possible abuse; not obvious how the points fit together.

4. <tei:polygon> as a child of <zone>
Against (quoting Sebastian)

a) the validatability is identical, if its just a string
b) if you keep in the same area (attributes) its very easy for us to say "supply EITHER @path OR @urx, @ury etc". managing constraints of attributes vs content is a pain
c) you have to change content model of <zone> *and all other att.coordinated things*, which is a pain

5. @path added to att.coordinated, containing a set of space-separated coordinates as alternatives to ulx, uly etc
Pro: simple and flexible
Against: ?

Other issues raised on the listserv include circles and indicating 3D.

== Facsimile Markup ==

[[FacsimileMarkup|This page]] was created in 2006-2007 during the development of TEI P5 Facsimile. It gives examples of several previously existing methods and tools for linking text with image.

[http://www.tei-c.org/release/doc/tei-p5-doc/en/html/PH.html#PHFAX TEI Guidelines 11.1, Digital Facsimiles]: Description of Facsimile markup in TEI P5

== Convenors ==

Dot Porter, [mailto:dporter@uky.edu dporter@uky.edu]<br/>
John Walsh, [mailto:jawalsh@indiana.edu jawalsh@indiana.edu]

== Meetings ==

The Text & Graphics SIG first convened at the third annual TEI Member's Meeting in Nancy, 2003. The SIG will convene again at the eighth annual TEI Member's Meeting in London, England, November 6-8, 2008.

== Listserv ==
Web site: http://listserv.brown.edu/?A0=TEI-GRAPHICS-SIG<br/>
To post to list: [mailto:tei-graphics-sig@listserv.brown.edu tei-graphics-sig@listserv.brown.edu]<br/>
To send mail to list owners: [mailto:tei-graphics-sig-request@listserv.brown.edu tei-graphics-sig-request@listserv.brown.edu]<br/>

[[Category:SIG]]

SIG:Text&Graphic

2008-04-11T20:23:00Z

Dot.porter: /* Text & Graphic Special Interest Group */

SIG:Text&Graphic

2008-04-10T20:59:19Z

Dot.porter:

= Text & Graphic Special Interest Group =

== Description ==

'''Text and Graphics Special Interest Group'''

The TEI Guidelines are used to encode many diverse, graphically rich
documents, including illuminated manuscripts, laboratory notebooks,
art books, children's illustrated books, comics and graphic novels,
and so on. These types of graphically rich documents present special
concerns, considerations, and challenges, both conceptually at the
encoding level and technically at the transformation, presentation,
and publishing layers of digital document development.

The purpose of this SIG will be to discuss, develop, and document
various strategies and best practices for implementing the digital
facsimile structures available in TEI P5, especially as relates to
graphically rich texts, and for developing methods to extend the TEI
when existing structures are not suitable.

Visit our page on the TEI Website: http://www.tei-c.org/Activities/SIG/Graphics/

== Facsimile Markup ==

[[FacsimileMarkup|This page]] was created in 2006-2007 during the development of TEI P5 Facsimile. It gives examples of several previously existing methods and tools for linking text with image.

[http://www.tei-c.org/release/doc/tei-p5-doc/en/html/PH.html#PHFAX TEI Guidelines 11.1, Digital Facsimiles]: Description of Facsimile markup in TEI P5

== Convenors ==

Dot Porter, [mailto:dporter@uky.edu dporter@uky.edu]<br/>
John Walsh, [mailto:jawalsh@indiana.edu jawalsh@indiana.edu]

== Meetings ==

The Text & Graphics SIG first convened at the third annual TEI Member's Meeting in Nancy, 2003. The SIG will convene again at the eighth annual TEI Member's Meeting in London, England, November 6-8, 2008.

== Listserv ==
Web site: http://listserv.brown.edu/?A0=TEI-GRAPHICS-SIG<br/>
To post to list: [mailto:tei-graphics-sig@listserv.brown.edu tei-graphics-sig@listserv.brown.edu]<br/>
To send mail to list owners: [mailto:tei-graphics-sig-request@listserv.brown.edu tei-graphics-sig-request@listserv.brown.edu]<br/>

[[Category:SIG]]

SIG:Text&Graphic

2008-04-10T20:53:24Z

Dot.porter:

= Text & Graphic Special Interest Group =

== Description ==

'''Text and Graphics Special Interest Group'''

The TEI Guidelines are used to encode many diverse, graphically rich
documents, including illuminated manuscripts, laboratory notebooks,
art books, children's illustrated books, comics and graphic novels,
and so on. These types of graphically rich documents present special
concerns, considerations, and challenges, both conceptually at the
encoding level and technically at the transformation, presentation,
and publishing layers of digital document development.

The purpose of this SIG will be to discuss, develop, and document
various strategies and best practices for implementing the digital
facsimile structures available in TEI P5, especially as relates to
graphically rich texts, and for developing methods to extend the TEI
when existing structures are not suitable.

== Facsimile Markup ==

[[FacsimileMarkup|This page]] was created in 2006-2007 during the development of TEI P5 Facsimile. It gives examples of several previously existing methods and tools for linking text with image.

[http://www.tei-c.org/release/doc/tei-p5-doc/en/html/PH.html#PHFAX TEI Guidelines 11.1, Digital Facsimiles]: Description of Facsimile markup in TEI P5

== Convenors ==

Dot Porter, [mailto:dporter@uky.edu dporter@uky.edu]<br/>
John Walsh, [mailto:jawalsh@indiana.edu jawalsh@indiana.edu]

== Meetings ==

The Text & Graphics SIG first convened at the third annual TEI Member's Meeting in Nancy, 2003. The SIG will convene again at the eighth annual TEI Member's Meeting in London, England, November 6-8, 2008.

== Listserv ==
Web site: http://listserv.brown.edu/?A0=TEI-GRAPHICS-SIG<br/>
To post to list: [mailto:tei-graphics-sig@listserv.brown.edu tei-graphics-sig@listserv.brown.edu]<br/>
To send mail to list owners: [mailto:tei-graphics-sig-request@listserv.brown.edu tei-graphics-sig-request@listserv.brown.edu]<br/>

[[Category:SIG]]

SIG:Text&Graphic

2008-04-09T14:39:31Z

Dot.porter: New page: = Text & Graphic Special Interest Group = == Description == '''Text and Graphics Special Interest Group''' The TEI Guidelines are used to encode many diverse, graphically rich documents...

= Text & Graphic Special Interest Group =

== Description ==

'''Text and Graphics Special Interest Group'''

The TEI Guidelines are used to encode many diverse, graphically rich
documents, including illuminated manuscripts, laboratory notebooks,
art books, children's illustrated books, comics and graphic novels,
and so on. These types of graphically rich documents present special
concerns, considerations, and challenges, both conceptually at the
encoding level and technically at the transformation, presentation,
and publishing layers of digital document development.

The purpose of this SIG will be to discuss, develop, and document
various strategies and best practices for implementing the digital
facsimile structures available in TEI P5, especially as relates to
graphically rich texts, and for developing methods to extend the TEI
when existing structures are not suitable.

== Facsimile Markup ==

[[FacsimileMarkup|This page]] was created in 2006-2007 during the development of TEI P5 Facsimile. It gives examples of several previously existing methods and tools for linking text with image.

[http://www.tei-c.org/release/doc/tei-p5-doc/en/html/PH.html#PHFAX TEI Guidelines 11.1, Digital Facsimiles]: Description of Facsimile markup in TEI P5

== Convenors ==

Dot Porter, [mailto:dporter@uky.edu dporter@uky.edu]<br/>
John Walsh, [mailto:jawalsh@indiana.edu jawalsh@indiana.edu]

== Meetings ==

The Text & Graphics SIG first convened at the third annual TEI Member's Meeting in Nancy, 2003. The SIG will convene again at the eighth annual TEI Member's Meeting in London, England, November 6-8, 2008.

[[Category:SIG]]

LegacyFacsimileMarkup

2007-07-22T20:21:55Z

Dot.porter: /* Case 2: Digital Facsimile */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image):

Figure is also self-nesting, which allows for description of image fragments, though as TEI is now described those image fragments would have to be separate image files. Would it be useful to instead have a way to note coordinates using an attribute or attributes in <graphic>? (@mets:coords or @svg coordinate attributes; see [[TEI_to_SVG#Mapping_attributes]]):
<pre>
<figure>
<head>My entire image</head>
<graphic.../>
<figure>
<head>fragment 1</head>
<graphic.../>
</figure>
<figure>
<head>fragment 2</head>
<graphic.../>
</figure>
</figure>
</pre>
If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

<figure> may contain more than one graphic, so it is possible to relate multiple image files to a single physical object:
<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.11)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.12)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/17.jpg"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and facsimile==

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.

(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

<br/><br/>

=[[Image:spacer.gif|left]]<br/><hr/>Method used by Edition Production & Presentation Technology (EPPT) to link images and text with complex markup=

EPPT (www.eppt.org/eppt) is a software platform designed to help editors prepare and display image-based XML-encoded electronic scholarly editions. EPPT uses electronic text, DTDs, and digital facsimiles (JPG, BMP, GIF, TIFF, etc.) to produce highly complex encoding of image-based textual resources. EPPT supports any DTD-based encoding schema (such as the TEI P4 DTDs – with support for P5 XML Schema and RelaxNG currently under development) and enables precise, semi-automatic linking of full images as well as image sections with structural and descriptive metadata. EPPT includes new technologies and extensions (such as support for multiple hierarchies) to provide a powerful user interface for leveraging XML technologies in the production of image-based XML-encoded electronic editions. See [[EPPT|a full description of the EPPT]].

For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=ALTO=

[http://www.ccs-gmbh.com/alto/ ALTO (Analysed Layout and Text Object)] is an extension schema for METS, allowing the markup of layout information of digitised texts. It has had a bit of use in newspaper digitisation in the States, in the National Digital Newspaper Project.

In summary, it defines digitised texts as consisting of "page" elements containing "blocks" which have rectangular coordinates assigned to them using attributes HPOS, VPOS, WIDTH, and HEIGHT, and also a ROTATION. Each block element's page is associated with image files with stand-off markup in the normal METS way.

By contrast we need a different way to relate TEI content elements to pages, since the dominant hierarchy in TEI is logical rather than physical (i.e. div rather than page).

[http://www.loc.gov/ndnp/alto_1-1-041.xsd XML Schema for ALTO]

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (though updated on this page to TEI P5)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined - editors can use their own markup schemas (requires @coords)
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

[[Category:Facsimiles|Legacy]]

GuidelinesFormattingSuggestions

2007-07-19T17:14:41Z

Dot.porter: /* Changes in Styles */

This is just a page to collect suggestions for changes to the formatting of the TEI Guidelines.

'''Note:''' These should be suggestions for formatting the TEI Guidelines themselves, not the TEI Website.

== Suggestions for HTML Version of TEI Guidelines ==

===Navigation===
# Given how many chapters there are, would it be a good idea to have a drop-down menu for the Table of Contents? Or could we fit however many chapter numbers it is in tabs across the top? (Website Issue?)
# Get rid of the sidebar or make it configurable (But: "where would you put the table of contents?")(Answer:"I would think you could use breadcrumbs for the uplink back to a full toc and have only the toc for the chapter itself at the beginning of the text.")
# The navbar if it stays should go on the other side: it should also be relatively width'ed, since you can break it if you crank the text size up. (Website Issue?)
# html/head/link elements should be provided to navigate the guidelines (i.e. next and previous, toc, glossary, whatever).
# The "Up: Contents" at the bottom of the pages, brings you the index page of the guidelines, so maybe it should be called "Up: Front page" of something in that direction. Or should it just go to the top of the page? Need a new name in that case as well. The middle option in the read text at the bottom "TEI Consortium | TEI P5 | Feedback" also brings you to the index page, which is an other argument to make the "Up: Contents" into "Up: Top" or something.<br/>''This is a problem''

===Code Examples Styling===
# Better styling of all Relax NG examples.<br/>''Is this being taken care of with the RNG/RNC switch?''
# Tidy up the display of rng fragments and make the display (and print!) of these passages optional (i.e. When printing, they seem to run occasionally over the edge of the page. Thinking of it, the same also happens to the examples here and there.) (Answer: "both the schema fragments and examples are pretty-printing. and the algorithm obviously needs more tweaking.") (Appears to be browser dependent, needs more thought).
# The rnc rng toggle works great, but I wonder if we shouldn't indicate which version you are looking at when you are looking at the actual code: an <nowiki><h3></nowiki> or something at the beginning of the fragment saying "RNG:" or "RNC:" as appropriate would be enough. Currently the button shows the other schema name (because of course it is what you are supposed to click on to get to it). Perhaps that button could be clarified to: "Switch to RNC" etc.

===Appendix B===
# Sometimes (like right now) Appendix B: Elements, shows the full content of the element description rather than just a list of element names linked to the discussion. I prefer the list of names with links approach. (Agreed, Website Issue?)<br/>
# The element description in the Element appendix is not part of the table showing the other information about the element. I think this might cause people to miss it. I'd recommend adding it as a first row: <nowiki><td>Description:</td><td></td></nowiki><br/>''I'm not sure what is the issue here''

===Changes in Styles===
# At the bottom of each page, we have a lower case "edited by..." it should be upper case.
# Better styling of XML examples which are given as CDATA since they aren't TEI elements
# It would be good if attributes could be not only indented as they are now, visualised better or rendered differently from the main text when inserted in the explanation e.g. <nowiki><specDesc key="head" atts="type"/></nowiki><br/>''If I understand this correctly then I agree. What about italicizing them? There doesn't seem to be rhyme or reason for when attributes appear in the explanation and when they do not.''
# First line highlighted when moused over<br/>''I don't understand. Is this a comment or a request? "First line" of what?''
# The layout of the the entry for each element, macro or classes are different from the rest of the guidelines. Should it be more of the same? For instance is the menu to the left not available. On the other hand I think there should be a distinction between these two parts.
# Have a "print view" (In addition to the PDF, a most-formatting-stripped view without layout structure)
# Show possible children of elements in the reference chapter

===Changes in Source===
# Tidying up of the way module descriptions are integrated into the body of the Guidelines.<br/>''I'm not sure what this means. Is this a reference to the ''Reference Section'' that appears at the end of some module-centric chapters? Perhaps the confusion is that some chapters describe modules (msDescription) while others do not. How can we clarify the relationships between modules and chapters?''
# <del>DONE</del> With styles off, the presentation of paragraphs is bad, because they are these odd <nowiki><div class="p"></nowiki> constructions. Why aren't they html:p? The tei <--> html p conversion problem was more or less solved, I thought? // <del>Seems indeed to be fixed now</del> Spoke too soon: look at the code for the third paragraph in 15.2.3 (including examples).
# The image at http://www.tei-c.org/release/doc/tei-p5-doc/html/SG.html#SG152 is not really well visible even if it comes out nicely once printed<br/>''The image file is 540 px wide but the @width value on <img> limits it to 480px. So the image is being squished. Either the value for image@width needs to be increased or the image file needs to be shrunk.''
# Space is output before <nowiki><gi>ptr</gi> e.g. <ptr target="#SG17"/></nowiki><br/>''That is an extra space in the code (between > and E), not a problem with the styles.''
# Headings should have bookmarkable self-referential hyperlinks attached, like you sometimes see on blogs. This is convenient for bookmarking a point in the guidelines. e.g. instead of: <nowiki> <div class="div3" id="PHCO"><h4>14.1.1 Use of Core Tags for Transcriptional Work</h4>...</div> You would have: <div class="div3" id="PHCO"><h4><a href="#PHCO" class="permalink">14.1.1 Use of Core Tags for Transcriptional Work</a></h4><...</div> I've also seen (though I don't know the best HTML/CSS source for it) a technique where a very faint ¶ appears after the heading, which gets darker when you hover over it, and works as a link to the current section. Maybe something like this?:<div class="div3" id="PHCO"><h4>14.1.1 Use of Core Tags for Transcriptional Work <a href="#PHCO" class="permalink">¶</a></h4><...</div> </nowiki>
# The Appendix E Index: There are an extra line between each entry with an underline which looks odd. And the links does not work here. And I do not quite get by which criteria these index words are selected. And is a one column list the best way to present this? Should there be a paragraph at the top to say what this is?<br/>''I agree completely. The Index needs a good hard look. Those little lines are weird.''
# Sometimes chapter names not output as in note on http://tei.oucs.ox.ac.uk/Query/tag.xq?name=att.declaring<br/>''I don't know if this is a problem with the styles or with the source''

===DONE===
# DONE <del> <nowiki><foreign xml:lang="LA"></nowiki> is not output as italics e.g.<nowiki><foreign xml:lang="LA">scriptio continua</foreign></nowiki> </del>
# DONE <del><nowiki><mentioned> (e.g."<mentioned>poem</mentioned>, <mentioned>title</mentioned">) is not
rendered, but probably this doesn't need to be changed</nowiki></del>
# DONE <del>Why are all the notes shown at the front page http://www.tei-c.org/release/doc/tei-p5-doc/html/index.html ? And should it be possible to click on a note to go to the text where the note belongs? </del>
# DONE <del>Documentation for elements should show the allowed parents for each element (i.e. contexts in which the element can appear). This used to be in the P4 docs but isn't in the P5.</del>
# DONE <del>'''egXML''' markup should be styled such that angle brackets, element and attribute names, attribute values, namespace prefixes, etc, are all distinctly coloured. Lots of browsers have something like for providing a default rendition of XML documents which don't have their own <?xml-stylesheet?> processing instruction. Some of these have + and - things so you can open and collapse elements, which I think we should do without, and I also know Firefox's one omits namespace prefixes on elements, which is just crazy. I have some XSLT code to do XML syntax highlighting hanging around somewhere as part of a Schematron report, I think; I will track it down if you like.</del>
# DONE <del>Footnotes should be hyperlinked in both directions - i.e. from the reference marker to the note, and from the note back to the reference marker.</del>
# DONE <del>Change the rendition of tei:ref; it's currently broken:<nowiki> <a target="#FS" class="link_ptr" href="FS.html" title="16">12 Feature Structures</a>.</nowiki></del>
## DONE <del>Target attribute should not be used (it currently has invalid data type anyway - it's not supposed to be a URI).</del>
## DONE <del>Title attribute should be meaningful - "16" is hopeless as a title. Hyperlinks from footnote references could usefully include a truncated version of the note body as the title attribute. I've done this at www.nzetc.org (e.g. at http://www.nzetc.org/tm/scholarly/tei-WarEarl-t1-body-d5.html#reference-to-fn1-54 - hover your mouse over the asterisk reference mark ). I've found this is quite useful - sometimes it's not necessary to actually click the footnote reference at all but just hover over it. e.g. <a href="#Note61" title="The BibTeX scheme is intentionally compatible with that of Scribe, although it omits some fields used by Scribe. Hence only one list of fields is given here.">61</a>. (Poss. Problem: title tooltips cropped in some browsers if too long.)</del>
# DONE <del>Show possible parents of elements in the reference chapter</del>

===Website Issues===
# What is the purpose of "Skip links" (at to of the menu to the left)? (Website Issue?)

== Suggestions for PDF Version of TEI Guidelines ==

# No suggestions specifically received so far, except some which carry over from HTML formatting (i.e. that element references should show possible children, etc.)

GuidelinesFormattingSuggestions

2007-07-19T15:46:37Z

Dot.porter: /* Suggestions for HTML Version of TEI Guidelines */

This is just a page to collect suggestions for changes to the formatting of the TEI Guidelines.

'''Note:''' These should be suggestions for formatting the TEI Guidelines themselves, not the TEI Website.

== Suggestions for HTML Version of TEI Guidelines ==

'''Navigation'''
# Given how many chapters there are, would it be a good idea to have a drop-down menu for the Table of Contents? Or could we fit however many chapter numbers it is in tabs across the top? (Website Issue?)
# Get rid of the sidebar or make it configurable (But: "where would you put the table of contents?")(Answer:"I would think you could use breadcrumbs for the uplink back to a full toc and have only the toc for the chapter itself at the beginning of the text.")
# The navbar if it stays should go on the other side: it should also be relatively width'ed, since you can break it if you crank the text size up. (Website Issue?)
# html/head/link elements should be provided to navigate the guidelines (i.e. next and previous, toc, glossary, whatever).
# The "Up: Contents" at the bottom of the pages, brings you the index page of the guidelines, so maybe it should be called "Up: Front page" of something in that direction. Or should it just go to the top of the page? Need a new name in that case as well. The middle option in the read text at the bottom "TEI Consortium | TEI P5 | Feedback" also brings you to the index page, which is an other argument to make the "Up: Contents" into "Up: Top" or something.<br/>''This is a problem''

'''Code Examples Styling'''
# Better styling of all Relax NG examples.<br/>''Is this being taken care of with the RNG/RNC switch?''
# Tidy up the display of rng fragments and make the display (and print!) of these passages optional (i.e. When printing, they seem to run occasionally over the edge of the page. Thinking of it, the same also happens to the examples here and there.) (Answer: "both the schema fragments and examples are pretty-printing. and the algorithm obviously needs more tweaking.") (Appears to be browser dependent, needs more thought).
# The rnc rng toggle works great, but I wonder if we shouldn't indicate which version you are looking at when you are looking at the actual code: an <nowiki><h3></nowiki> or something at the beginning of the fragment saying "RNG:" or "RNC:" as appropriate would be enough. Currently the button shows the other schema name (because of course it is what you are supposed to click on to get to it). Perhaps that button could be clarified to: "Switch to RNC" etc.

'''Appendix B'''
# Sometimes (like right now) Appendix B: Elements, shows the full content of the element description rather than just a list of element names linked to the discussion. I prefer the list of names with links approach. (Agreed, Website Issue?)<br/>
# The element description in the Element appendix is not part of the table showing the other information about the element. I think this might cause people to miss it. I'd recommend adding it as a first row: <nowiki><td>Description:</td><td></td></nowiki><br/>''I'm not sure what is the issue here''

'''Changes in Styles'''
# At the bottom of each page, we have a lower case "edited by..." it should be upper case.
# Better styling of XML examples which are given as CDATA since they aren't TEI elements
# It would be good if attributes could be not only indented as they are now, visualised better or rendered differently from the main text when inserted in the explanation e.g. <nowiki><specDesc key="head" atts="type"/></nowiki><br/>If I understand this correctly then I agree. What about italicizing them? There doesn't seem to be rhyme or reason for when attributes appear in the explanation and when they do not.''
# First line highlighted when moused over<br/>''I don't understand. Is this a comment or a request? "First line" of what?''
# The layout of the the entry for each element, macro or classes are different from the rest of the guidelines. Should it be more of the same? For instance is the menu to the left not available. On the other hand I think there should be a distinction between these two parts.
# Have a "print view" (In addition to the PDF, a most-formatting-stripped view without layout structure)
# Show possible children of elements in the reference chapter

'''Changes in Source'''
# Tidying up of the way module descriptions are integrated into the body of the Guidelines.<br/>''I'm not sure what this means. Is this a reference to the ''Reference Section'' that appears at the end of some module-centric chapters? Perhaps the confusion is that some chapters describe modules (msDescription) while others do not. How can we clarify the relationships between modules and chapters?''
# <del>DONE</del> With styles off, the presentation of paragraphs is bad, because they are these odd <nowiki><div class="p"></nowiki> constructions. Why aren't they html:p? The tei <--> html p conversion problem was more or less solved, I thought? // <del>Seems indeed to be fixed now</del> Spoke too soon: look at the code for the third paragraph in 15.2.3 (including examples).
# The image at http://www.tei-c.org/release/doc/tei-p5-doc/html/SG.html#SG152 is not really well visible even if it comes out nicely once printed<br/>''The image file is 540 px wide but the @width value on <img> limits it to 480px. So the image is being squished. Either the value for image@width needs to be increased or the image file needs to be shrunk.''
# Space is output before <nowiki><gi>ptr</gi> e.g. <ptr target="#SG17"/></nowiki><br/>''That is an extra space in the code (between > and E), not a problem with the styles.''
# Headings should have bookmarkable self-referential hyperlinks attached, like you sometimes see on blogs. This is convenient for bookmarking a point in the guidelines. e.g. instead of: <nowiki> <div class="div3" id="PHCO"><h4>14.1.1 Use of Core Tags for Transcriptional Work</h4>...</div> You would have: <div class="div3" id="PHCO"><h4><a href="#PHCO" class="permalink">14.1.1 Use of Core Tags for Transcriptional Work</a></h4><...</div> I've also seen (though I don't know the best HTML/CSS source for it) a technique where a very faint ¶ appears after the heading, which gets darker when you hover over it, and works as a link to the current section. Maybe something like this?:<div class="div3" id="PHCO"><h4>14.1.1 Use of Core Tags for Transcriptional Work <a href="#PHCO" class="permalink">¶</a></h4><...</div> </nowiki>
# The Appendix E Index: There are an extra line between each entry with an underline which looks odd. And the links does not work here. And I do not quite get by which criteria these index words are selected. And is a one column list the best way to present this? Should there be a paragraph at the top to say what this is?<br/>''I agree completely. The Index needs a good hard look. Those little lines are weird.''
# Sometimes chapter names not output as in note on http://tei.oucs.ox.ac.uk/Query/tag.xq?name=att.declaring<br/>''I don't know if this is a problem with the styles or with the source''

'''DONE'''
# DONE <del> <nowiki><foreign xml:lang="LA"></nowiki> is not output as italics e.g.<nowiki><foreign xml:lang="LA">scriptio continua</foreign></nowiki> </del>
# DONE <del><nowiki><mentioned> (e.g."<mentioned>poem</mentioned>, <mentioned>title</mentioned">) is not
rendered, but probably this doesn't need to be changed</nowiki></del>
# DONE <del>Why are all the notes shown at the front page http://www.tei-c.org/release/doc/tei-p5-doc/html/index.html ? And should it be possible to click on a note to go to the text where the note belongs? </del>
# DONE <del>Documentation for elements should show the allowed parents for each element (i.e. contexts in which the element can appear). This used to be in the P4 docs but isn't in the P5.</del>
# DONE <del>'''egXML''' markup should be styled such that angle brackets, element and attribute names, attribute values, namespace prefixes, etc, are all distinctly coloured. Lots of browsers have something like for providing a default rendition of XML documents which don't have their own <?xml-stylesheet?> processing instruction. Some of these have + and - things so you can open and collapse elements, which I think we should do without, and I also know Firefox's one omits namespace prefixes on elements, which is just crazy. I have some XSLT code to do XML syntax highlighting hanging around somewhere as part of a Schematron report, I think; I will track it down if you like.</del>
# DONE <del>Footnotes should be hyperlinked in both directions - i.e. from the reference marker to the note, and from the note back to the reference marker.</del>
# DONE <del>Change the rendition of tei:ref; it's currently broken:<nowiki> <a target="#FS" class="link_ptr" href="FS.html" title="16">12 Feature Structures</a>.</nowiki></del>
## DONE <del>Target attribute should not be used (it currently has invalid data type anyway - it's not supposed to be a URI).</del>
## DONE <del>Title attribute should be meaningful - "16" is hopeless as a title. Hyperlinks from footnote references could usefully include a truncated version of the note body as the title attribute. I've done this at www.nzetc.org (e.g. at http://www.nzetc.org/tm/scholarly/tei-WarEarl-t1-body-d5.html#reference-to-fn1-54 - hover your mouse over the asterisk reference mark ). I've found this is quite useful - sometimes it's not necessary to actually click the footnote reference at all but just hover over it. e.g. <a href="#Note61" title="The BibTeX scheme is intentionally compatible with that of Scribe, although it omits some fields used by Scribe. Hence only one list of fields is given here.">61</a>. (Poss. Problem: title tooltips cropped in some browsers if too long.)</del>
# DONE <del>Show possible parents of elements in the reference chapter</del>

'''Website Issues'''
# What is the purpose of "Skip links" (at to of the menu to the left)? (Website Issue?)

== Suggestions for PDF Version of TEI Guidelines ==

# No suggestions specifically received so far, except some which carry over from HTML formatting (i.e. that element references should show possible children, etc.)

GuidelinesFormattingSuggestions

2007-07-19T15:30:27Z

Dot.porter: /* Suggestions for HTML Version of TEI Guidelines */

This is just a page to collect suggestions for changes to the formatting of the TEI Guidelines.

'''Note:''' These should be suggestions for formatting the TEI Guidelines themselves, not the TEI Website.

== Suggestions for HTML Version of TEI Guidelines ==

'''Table of Contents/Sidebar'''
# Given how many chapters there are, would it be a good idea to have a drop-down menu for the Table of Contents? Or could we fit however many chapter numbers it is in tabs across the top? (Website Issue?)
# Get rid of the sidebar or make it configurable (But: "where would you put the table of contents?")(Answer:"I would think you could use breadcrumbs for the uplink back to a full toc and have only the toc for the chapter itself at the beginning of the text.")
# The navbar if it stays should go on the other side: it should also be relatively width'ed, since you can break it if you crank the text size up. (Website Issue?)

'''Changes in Styles'''
# Sometimes (like right now) Appendix B: Elements, shows the full content of the element description rather than just a list of element names linked to the discussion. I prefer the list of names with links approach. (Agreed, Website Issue?)<br/>''I've never seen anything in Appendix B other than a list of element names linked to their descriptions. Is this really an issue? My concern is whether the list as it is makes sense. Should it be chunked alphabetically? Rather than just having one big chunk?''
# At the bottom of each page, we have a lower case "edited by..." it should be upper case.
# Better styling of all Relax NG examples.<br/>''Is this being taken care of with the RNG/RNC switch?''
# Better styling of XML examples which are given as CDATA since they aren't TEI elements

'''Changes in Source'''
# Tidying up of the way module descriptions are integrated into the body of the Guidelines.<br/>''I'm not sure what this means. Is this a reference to the ''Reference Section'' that appears at the end of some module-centric chapters? Perhaps the confusion is that some chapters describe modules (msDescription) while others do not. How can we clarify the relationships between modules and chapters?''
# <del>DONE</del> With styles off, the presentation of paragraphs is bad, because they are these odd <nowiki><div class="p"></nowiki> constructions. Why aren't they html:p? The tei <--> html p conversion problem was more or less solved, I thought? // <del>Seems indeed to be fixed now</del> Spoke too soon: look at the code for the third paragraph in 15.2.3 (including examples).
# First line highlighted when moused over<br/>''I don't understand. Is this a comment or a request? "First line" of what?''
# The image at http://www.tei-c.org/release/doc/tei-p5-doc/html/SG.html#SG152 is not really well visible even if it comes out nicely once printed<br/>''The image file is 540 px wide but the @width value on <img> limits it to 480px. So the image is being squished. Either the value for image@width needs to be increased or the image file needs to be shrunk.''
# Space is output before <nowiki><gi>ptr</gi> e.g. <ptr target="#SG17"/></nowiki><br/>''That is an extra space in the code (between > and E), not a problem with the styles.''

# It would be good if attributes could be not only indented as they are now, visualised better or rendered differently from the main text when inserted in the explanation e.g. <nowiki><specDesc key="head" atts="type"/></nowiki>
# Sometimes chapter names not output as in note on http://tei.oucs.ox.ac.uk/Query/tag.xq?name=att.declaring
# The Appendix E Index: There are an extra line between each entry with an underline which looks odd. And the links does not work here. And I do not quite get by which criteria these index words are selected. And is a one column list the best way to present this? Should there be a paragraph at the top to say that this is?
# What is the purpose of "Skip links" (at to of the menu to the left)? (Website Issue?)
# The layout of the the entry for each element, macro or classes are different from the rest of the guidelines. Should it be more of the same? For instance is the menu to the left not available. On the other hand I think there should be a distinction between these two parts.
# The "Up: Contents" at the bottom of the pages, brings you the index page of the guidelines, so maybe it should be called "Up: Front page" of something in that direction. Or should it just go to the top of the page? Need a new name in that case as well. The middle option in the read text at the bottom "TEI Consortium | TEI P5 | Feedback" also brings you to the index page, which is an other argument to make the "Up: Contents" into "Up: Top" or something.
# html/head/link elements should be provided to navigate the guidelines (i.e. next and previous, toc, glossary, whatever).
# Headings should have bookmarkable self-referential hyperlinks attached, like you sometimes see on blogs. This is convenient for bookmarking a point in the guidelines. e.g. instead of: <nowiki> <div class="div3" id="PHCO"><h4>14.1.1 Use of Core Tags for Transcriptional Work</h4>...</div> You would have: <div class="div3" id="PHCO"><h4><a href="#PHCO" class="permalink">14.1.1 Use of Core Tags for Transcriptional Work</a></h4><...</div> I've also seen (though I don't know the best HTML/CSS source for it) a technique where a very faint ¶ appears after the heading, which gets darker when you hover over it, and works as a link to the current section. Maybe something like this?:<div class="div3" id="PHCO"><h4>14.1.1 Use of Core Tags for Transcriptional Work <a href="#PHCO" class="permalink">¶</a></h4><...</div> </nowiki>
# Have a "print view" (In addition to the PDF, a most-formatting-stripped view without layout structure)
# Show possible children of elements in the reference chapter
# Tidy up the display of rng fragments and make the display (and print!) of these passages optional (i.e. When printing, they seem to run occasionally over the edge of the page. Thinking of it, the same also happens to the examples here and there.) (Answer: "both the schema fragments and examples are pretty-printing. and the algorithm obviously needs more tweaking.") (Appears to be browser dependent, needs more thought).
# The rnc rng toggle works great, but I wonder if we shouldn't indicate which version you are looking at when you are looking at the actual code: an <nowiki><h3></nowiki> or something at the beginning of the fragment saying "RNG:" or "RNC:" as appropriate would be enough. Currently the button shows the other schema name (because of course it is what you are supposed to click on to get to it). Perhaps that button could be clarified to: "Switch to RNC" etc.
# The element description in the Element appendix is not part of the table showing the other information about the element. I think this might cause people to miss it. I'd recommend adding it as a first row: <nowiki><td>Description:</td><td></td></nowiki>

'''DONE'''
# DONE <del> <nowiki><foreign xml:lang="LA"></nowiki> is not output as italics e.g.<nowiki><foreign xml:lang="LA">scriptio continua</foreign></nowiki> </del>
# DONE <del><nowiki><mentioned> (e.g."<mentioned>poem</mentioned>, <mentioned>title</mentioned">) is not
rendered, but probably this doesn't need to be changed</nowiki></del>
# DONE <del>Why are all the notes shown at the front page http://www.tei-c.org/release/doc/tei-p5-doc/html/index.html ? And should it be possible to click on a note to go to the text where the note belongs? </del>
# DONE <del>Documentation for elements should show the allowed parents for each element (i.e. contexts in which the element can appear). This used to be in the P4 docs but isn't in the P5.</del>
# DONE <del>'''egXML''' markup should be styled such that angle brackets, element and attribute names, attribute values, namespace prefixes, etc, are all distinctly coloured. Lots of browsers have something like for providing a default rendition of XML documents which don't have their own <?xml-stylesheet?> processing instruction. Some of these have + and - things so you can open and collapse elements, which I think we should do without, and I also know Firefox's one omits namespace prefixes on elements, which is just crazy. I have some XSLT code to do XML syntax highlighting hanging around somewhere as part of a Schematron report, I think; I will track it down if you like.</del>
# DONE <del>Footnotes should be hyperlinked in both directions - i.e. from the reference marker to the note, and from the note back to the reference marker.</del>
# DONE <del>Change the rendition of tei:ref; it's currently broken:<nowiki> <a target="#FS" class="link_ptr" href="FS.html" title="16">12 Feature Structures</a>.</nowiki></del>
## DONE <del>Target attribute should not be used (it currently has invalid data type anyway - it's not supposed to be a URI).</del>
## DONE <del>Title attribute should be meaningful - "16" is hopeless as a title. Hyperlinks from footnote references could usefully include a truncated version of the note body as the title attribute. I've done this at www.nzetc.org (e.g. at http://www.nzetc.org/tm/scholarly/tei-WarEarl-t1-body-d5.html#reference-to-fn1-54 - hover your mouse over the asterisk reference mark ). I've found this is quite useful - sometimes it's not necessary to actually click the footnote reference at all but just hover over it. e.g. <a href="#Note61" title="The BibTeX scheme is intentionally compatible with that of Scribe, although it omits some fields used by Scribe. Hence only one list of fields is given here.">61</a>. (Poss. Problem: title tooltips cropped in some browsers if too long.)</del>
# DONE <del>Show possible parents of elements in the reference chapter</del>

== Suggestions for PDF Version of TEI Guidelines ==

# No suggestions specifically received so far, except some which carry over from HTML formatting (i.e. that element references should show possible children, etc.)

GuidelinesFormattingSuggestions

2007-07-19T15:28:05Z

Dot.porter: /* Suggestions for HTML Version of TEI Guidelines */

This is just a page to collect suggestions for changes to the formatting of the TEI Guidelines.

'''Note:''' These should be suggestions for formatting the TEI Guidelines themselves, not the TEI Website.

== Suggestions for HTML Version of TEI Guidelines ==

'''Table of Contents/Sidebar'''
# Given how many chapters there are, would it be a good idea to have a drop-down menu for the Table of Contents? Or could we fit however many chapter numbers it is in tabs across the top? (Website Issue?)
# Get rid of the sidebar or make it configurable (But: "where would you put the table of contents?")(Answer:"I would think you could use breadcrumbs for the uplink back to a full toc and have only the toc for the chapter itself at the beginning of the text.")
# The navbar if it stays should go on the other side: it should also be relatively width'ed, since you can break it if you crank the text size up. (Website Issue?)

'''Changes in Styles'''
# Sometimes (like right now) Appendix B: Elements, shows the full content of the element description rather than just a list of element names linked to the discussion. I prefer the list of names with links approach. (Agreed, Website Issue?)<br/>''I've never seen anything in Appendix B other than a list of element names linked to their descriptions. Is this really an issue? My concern is whether the list as it is makes sense. Should it be chunked alphabetically? Rather than just having one big chunk?''
# At the bottom of each page, we have a lower case "edited by..." it should be upper case.

'''Changes in Source'''
# Tidying up of the way module descriptions are integrated into the body of the Guidelines.<br/>''I'm not sure what this means. Is this a reference to the ''Reference Section'' that appears at the end of some module-centric chapters? Perhaps the confusion is that some chapters describe modules (msDescription) while others do not. How can we clarify the relationships between modules and chapters?''
# <del>DONE</del> With styles off, the presentation of paragraphs is bad, because they are these odd <nowiki><div class="p"></nowiki> constructions. Why aren't they html:p? The tei <--> html p conversion problem was more or less solved, I thought? // <del>Seems indeed to be fixed now</del> Spoke too soon: look at the code for the third paragraph in 15.2.3 (including examples).
# First line highlighted when moused over<br/>''I don't understand. Is this a comment or a request? "First line" of what?''
# The image at http://www.tei-c.org/release/doc/tei-p5-doc/html/SG.html#SG152 is not really well visible even if it comes out nicely once printed<br/>''The image file is 540 px wide but the @width value on <img> limits it to 480px. So the image is being squished. Either the value for image@width needs to be increased or the image file needs to be shrunk.''
# Space is output before <nowiki><gi>ptr</gi> e.g. <ptr target="#SG17"/></nowiki><br/>''That is an extra space in the code (between > and E), not a problem with the styles.''
# Better styling of XML examples which are given as CDATA since they aren't TEI elements
# Better styling of all Relax NG examples.
# It would be good if attributes could be not only indented as they are now, visualised better or rendered differently from the main text when inserted in the explanation e.g. <nowiki><specDesc key="head" atts="type"/></nowiki>
# Sometimes chapter names not output as in note on http://tei.oucs.ox.ac.uk/Query/tag.xq?name=att.declaring
# The Appendix E Index: There are an extra line between each entry with an underline which looks odd. And the links does not work here. And I do not quite get by which criteria these index words are selected. And is a one column list the best way to present this? Should there be a paragraph at the top to say that this is?
# What is the purpose of "Skip links" (at to of the menu to the left)? (Website Issue?)
# The layout of the the entry for each element, macro or classes are different from the rest of the guidelines. Should it be more of the same? For instance is the menu to the left not available. On the other hand I think there should be a distinction between these two parts.
# The "Up: Contents" at the bottom of the pages, brings you the index page of the guidelines, so maybe it should be called "Up: Front page" of something in that direction. Or should it just go to the top of the page? Need a new name in that case as well. The middle option in the read text at the bottom "TEI Consortium | TEI P5 | Feedback" also brings you to the index page, which is an other argument to make the "Up: Contents" into "Up: Top" or something.
# html/head/link elements should be provided to navigate the guidelines (i.e. next and previous, toc, glossary, whatever).
# Headings should have bookmarkable self-referential hyperlinks attached, like you sometimes see on blogs. This is convenient for bookmarking a point in the guidelines. e.g. instead of: <nowiki> <div class="div3" id="PHCO"><h4>14.1.1 Use of Core Tags for Transcriptional Work</h4>...</div> You would have: <div class="div3" id="PHCO"><h4><a href="#PHCO" class="permalink">14.1.1 Use of Core Tags for Transcriptional Work</a></h4><...</div> I've also seen (though I don't know the best HTML/CSS source for it) a technique where a very faint ¶ appears after the heading, which gets darker when you hover over it, and works as a link to the current section. Maybe something like this?:<div class="div3" id="PHCO"><h4>14.1.1 Use of Core Tags for Transcriptional Work <a href="#PHCO" class="permalink">¶</a></h4><...</div> </nowiki>
# Have a "print view" (In addition to the PDF, a most-formatting-stripped view without layout structure)
# Show possible children of elements in the reference chapter
# Tidy up the display of rng fragments and make the display (and print!) of these passages optional (i.e. When printing, they seem to run occasionally over the edge of the page. Thinking of it, the same also happens to the examples here and there.) (Answer: "both the schema fragments and examples are pretty-printing. and the algorithm obviously needs more tweaking.") (Appears to be browser dependent, needs more thought).
# The rnc rng toggle works great, but I wonder if we shouldn't indicate which version you are looking at when you are looking at the actual code: an <nowiki><h3></nowiki> or something at the beginning of the fragment saying "RNG:" or "RNC:" as appropriate would be enough. Currently the button shows the other schema name (because of course it is what you are supposed to click on to get to it). Perhaps that button could be clarified to: "Switch to RNC" etc.
# The element description in the Element appendix is not part of the table showing the other information about the element. I think this might cause people to miss it. I'd recommend adding it as a first row: <nowiki><td>Description:</td><td></td></nowiki>

'''DONE'''
# DONE <del> <nowiki><foreign xml:lang="LA"></nowiki> is not output as italics e.g.<nowiki><foreign xml:lang="LA">scriptio continua</foreign></nowiki> </del>
# DONE <del><nowiki><mentioned> (e.g."<mentioned>poem</mentioned>, <mentioned>title</mentioned">) is not
rendered, but probably this doesn't need to be changed</nowiki></del>
# DONE <del>Why are all the notes shown at the front page http://www.tei-c.org/release/doc/tei-p5-doc/html/index.html ? And should it be possible to click on a note to go to the text where the note belongs? </del>
# DONE <del>Documentation for elements should show the allowed parents for each element (i.e. contexts in which the element can appear). This used to be in the P4 docs but isn't in the P5.</del>
# DONE <del>'''egXML''' markup should be styled such that angle brackets, element and attribute names, attribute values, namespace prefixes, etc, are all distinctly coloured. Lots of browsers have something like for providing a default rendition of XML documents which don't have their own <?xml-stylesheet?> processing instruction. Some of these have + and - things so you can open and collapse elements, which I think we should do without, and I also know Firefox's one omits namespace prefixes on elements, which is just crazy. I have some XSLT code to do XML syntax highlighting hanging around somewhere as part of a Schematron report, I think; I will track it down if you like.</del>
# DONE <del>Footnotes should be hyperlinked in both directions - i.e. from the reference marker to the note, and from the note back to the reference marker.</del>
# DONE <del>Change the rendition of tei:ref; it's currently broken:<nowiki> <a target="#FS" class="link_ptr" href="FS.html" title="16">12 Feature Structures</a>.</nowiki></del>
## DONE <del>Target attribute should not be used (it currently has invalid data type anyway - it's not supposed to be a URI).</del>
## DONE <del>Title attribute should be meaningful - "16" is hopeless as a title. Hyperlinks from footnote references could usefully include a truncated version of the note body as the title attribute. I've done this at www.nzetc.org (e.g. at http://www.nzetc.org/tm/scholarly/tei-WarEarl-t1-body-d5.html#reference-to-fn1-54 - hover your mouse over the asterisk reference mark ). I've found this is quite useful - sometimes it's not necessary to actually click the footnote reference at all but just hover over it. e.g. <a href="#Note61" title="The BibTeX scheme is intentionally compatible with that of Scribe, although it omits some fields used by Scribe. Hence only one list of fields is given here.">61</a>. (Poss. Problem: title tooltips cropped in some browsers if too long.)</del>
# DONE <del>Show possible parents of elements in the reference chapter</del>

== Suggestions for PDF Version of TEI Guidelines ==

# No suggestions specifically received so far, except some which carry over from HTML formatting (i.e. that element references should show possible children, etc.)

GuidelinesFormattingSuggestions

2007-07-19T15:06:51Z

Dot.porter: /* Suggestions for HTML Version of TEI Guidelines */

This is just a page to collect suggestions for changes to the formatting of the TEI Guidelines.

'''Note:''' These should be suggestions for formatting the TEI Guidelines themselves, not the TEI Website.

== Suggestions for HTML Version of TEI Guidelines ==

'''Table of Contents'''
# Given how many chapters there are, would it be a good idea to have a drop-down menu for the Table of Contents? Or could we fit however many chapter numbers it is in tabs across the top? (Website Issue?)
# Get rid of the sidebar or make it configurable (But: "where would you put the table of contents?")(Answer:"I would think you could use breadcrumbs for the uplink back to a full toc and have only the toc for the chapter itself at the beginning of the text.")

# Tidying up of the way module descriptions are integrated into the body of the Guidelines.
# Sometimes (like right now) Appendix B: Elements, shows the full content of the element description rather than just a list of element names linked to the discussion. I prefer the list of names with links approach. (Agreed, Website Issue?)
# At the bottom of each page, we have a lower case "edited by..." it should be upper case.
# <del>DONE</del> With styles off, the presentation of paragraphs is bad, because they are these odd <nowiki><div class="p"></nowiki> constructions. Why aren't they html:p? The tei <--> html p conversion problem was more or less solved, I thought? // <del>Seems indeed to be fixed now</del> Spoke too soon: look at the code for the third paragraph in 15.2.3 (including examples).
# The navbar if it stays should go on the other side: it should also be relatively width'ed, since you can break it if you crank the text size up. (Website Issue?)
# First line highlighted when moused over
# The image at http://www.tei-c.org/release/doc/tei-p5-doc/html/SG.html#SG152 is not really well visible even if it comes out nicely once printed
# Space is output before <nowiki><gi>prt</gi> e.g. <ptr target="#SG17"/></nowiki>
# Better styling of XML examples which are given as CDATA since they aren't TEI elements
# Better styling of all Relax NG examples.
# It would be good if attributes could be not only indented as they are now, visualised better or rendered differently from the main text when inserted in the explanation e.g. <nowiki><specDesc key="head" atts="type"/></nowiki>
# Sometimes chapter names not output as in note on http://tei.oucs.ox.ac.uk/Query/tag.xq?name=att.declaring
# The Appendix E Index: There are an extra line between each entry with an underline which looks odd. And the links does not work here. And I do not quite get by which criteria these index words are selected. And is a one column list the best way to present this? Should there be a paragraph at the top to say that this is?
# What is the purpose of "Skip links" (at to of the menu to the left)? (Website Issue?)
# The layout of the the entry for each element, macro or classes are different from the rest of the guidelines. Should it be more of the same? For instance is the menu to the left not available. On the other hand I think there should be a distinction between these two parts.
# The "Up: Contents" at the bottom of the pages, brings you the index page of the guidelines, so maybe it should be called "Up: Front page" of something in that direction. Or should it just go to the top of the page? Need a new name in that case as well. The middle option in the read text at the bottom "TEI Consortium | TEI P5 | Feedback" also brings you to the index page, which is an other argument to make the "Up: Contents" into "Up: Top" or something.
# html/head/link elements should be provided to navigate the guidelines (i.e. next and previous, toc, glossary, whatever).
# Headings should have bookmarkable self-referential hyperlinks attached, like you sometimes see on blogs. This is convenient for bookmarking a point in the guidelines. e.g. instead of: <nowiki> <div class="div3" id="PHCO"><h4>14.1.1 Use of Core Tags for Transcriptional Work</h4>...</div> You would have: <div class="div3" id="PHCO"><h4><a href="#PHCO" class="permalink">14.1.1 Use of Core Tags for Transcriptional Work</a></h4><...</div> I've also seen (though I don't know the best HTML/CSS source for it) a technique where a very faint ¶ appears after the heading, which gets darker when you hover over it, and works as a link to the current section. Maybe something like this?:<div class="div3" id="PHCO"><h4>14.1.1 Use of Core Tags for Transcriptional Work <a href="#PHCO" class="permalink">¶</a></h4><...</div> </nowiki>
# Have a "print view" (In addition to the PDF, a most-formatting-stripped view without layout structure)
# Show possible children of elements in the reference chapter
# Tidy up the display of rng fragments and make the display (and print!) of these passages optional (i.e. When printing, they seem to run occasionally over the edge of the page. Thinking of it, the same also happens to the examples here and there.) (Answer: "both the schema fragments and examples are pretty-printing. and the algorithm obviously needs more tweaking.") (Appears to be browser dependent, needs more thought).
# The rnc rng toggle works great, but I wonder if we shouldn't indicate which version you are looking at when you are looking at the actual code: an <nowiki><h3></nowiki> or something at the beginning of the fragment saying "RNG:" or "RNC:" as appropriate would be enough. Currently the button shows the other schema name (because of course it is what you are supposed to click on to get to it). Perhaps that button could be clarified to: "Switch to RNC" etc.
# The element description in the Element appendix is not part of the table showing the other information about the element. I think this might cause people to miss it. I'd recommend adding it as a first row: <nowiki><td>Description:</td><td></td></nowiki>

'''DONE'''
# DONE <del> <nowiki><foreign xml:lang="LA"></nowiki> is not output as italics e.g.<nowiki><foreign xml:lang="LA">scriptio continua</foreign></nowiki> </del>
# DONE <del><nowiki><mentioned> (e.g."<mentioned>poem</mentioned>, <mentioned>title</mentioned">) is not
rendered, but probably this doesn't need to be changed</nowiki></del>
# DONE <del>Why are all the notes shown at the front page http://www.tei-c.org/release/doc/tei-p5-doc/html/index.html ? And should it be possible to click on a note to go to the text where the note belongs? </del>
# DONE <del>Documentation for elements should show the allowed parents for each element (i.e. contexts in which the element can appear). This used to be in the P4 docs but isn't in the P5.</del>
# DONE <del>'''egXML''' markup should be styled such that angle brackets, element and attribute names, attribute values, namespace prefixes, etc, are all distinctly coloured. Lots of browsers have something like for providing a default rendition of XML documents which don't have their own <?xml-stylesheet?> processing instruction. Some of these have + and - things so you can open and collapse elements, which I think we should do without, and I also know Firefox's one omits namespace prefixes on elements, which is just crazy. I have some XSLT code to do XML syntax highlighting hanging around somewhere as part of a Schematron report, I think; I will track it down if you like.</del>
# DONE <del>Footnotes should be hyperlinked in both directions - i.e. from the reference marker to the note, and from the note back to the reference marker.</del>
# DONE <del>Change the rendition of tei:ref; it's currently broken:<nowiki> <a target="#FS" class="link_ptr" href="FS.html" title="16">12 Feature Structures</a>.</nowiki></del>
## DONE <del>Target attribute should not be used (it currently has invalid data type anyway - it's not supposed to be a URI).</del>
## DONE <del>Title attribute should be meaningful - "16" is hopeless as a title. Hyperlinks from footnote references could usefully include a truncated version of the note body as the title attribute. I've done this at www.nzetc.org (e.g. at http://www.nzetc.org/tm/scholarly/tei-WarEarl-t1-body-d5.html#reference-to-fn1-54 - hover your mouse over the asterisk reference mark ). I've found this is quite useful - sometimes it's not necessary to actually click the footnote reference at all but just hover over it. e.g. <a href="#Note61" title="The BibTeX scheme is intentionally compatible with that of Scribe, although it omits some fields used by Scribe. Hence only one list of fields is given here.">61</a>. (Poss. Problem: title tooltips cropped in some browsers if too long.)</del>
# DONE <del>Show possible parents of elements in the reference chapter</del>

== Suggestions for PDF Version of TEI Guidelines ==

# No suggestions specifically received so far, except some which carry over from HTML formatting (i.e. that element references should show possible children, etc.)

EPPT

2007-06-01T14:12:25Z

Dot.porter: /* left<br/><hr/>Edition Production & Presentation Technology (EPPT) */

[[Category:Tools]]
[[Category:All-in-one Tools]]

=[[Image:spacer.gif|left]]<br/><hr/>Edition Production & Presentation Technology (EPPT)=

EPPT (http://www.eppt.org/eppt/) is a software platform designed to help editors prepare and display image-based XML-encoded electronic scholarly editions. EPPT uses electronic text, DTDs, and digital facsimiles (JPG, BMP, GIF, TIFF, etc.) to produce highly complex encoding of image-based textual resources. EPPT supports any DTD-based encoding schema (such as the TEI P4 DTDs – with support for P5 XML Schema and RelaxNG currently under development) and enables precise, semi-automatic linking of full images as well as image sections with structural and descriptive metadata. EPPT includes new technologies and extensions (such as support for multiple hierarchies) to provide a powerful user interface for leveraging XML technologies in the production of image-based XML-encoded electronic editions.

==Main features of EPPT==

* Starts new projects quickly through a project wizard
* Customizes different projects using different schemas
* Carries the data management burden (XML syntax, well-formedness, etc.), allowing the editor to focus on the content, and how and where to encode it
* Provides simple user interfaces to link images and text through markup:
** Select text
** Select corresponding section of image
** Select element from DTD-sensitive interface which opens an element-specific template
** Fill in desired attribute values
** Click “Tag it!”
* Uses templates to reduce errors, ensuring comprehensive insertion of markup, and acceleration and, in some cases, automation of the insertion of repetitive attribute values
* Offers easy navigation of text, metadata, and images
* Supports multiple XML hierarchies in the same project with serialization in XML using "milestones" and "fragmentation” (as described in the TEI guidelines)
* Allows grouping of tags into semantically related markup categories for easier project management, collaborative editing, distribution of effort, etc.
* Integrates XSL and generates HTML presentations
* Provides an API (with examples) to link HTML presentations (through XSLT) with project images and text, extracted and displayed from markup
* Furnishes individual views of text content and its markup, and filters for both, to help the editor focus on particular content or markup as the encoding grows
* Operates on XML and produces non-proprietary XML completely portable to other applications
* Can extract rectangular sections of images to be used in HTML presentations based on image X/Y coordinates stored in the markup
* Includes a customizable search interface with an XQuery search engine

==EPPT Tools==

===ImagText===

ImagText, the default user interface of EPPT, is responsible for both image data management (e.g., finding and opening image files associated with a project) and user image-interface interaction. The tool provides the usual image manipulation toolbox: zoom, magnification, horizontal or vertical display of one or two images, etc.

ImagText supports image area selection and, provided the @coords has been included in the content model for the selected element in the DTD, automatically inserts the X/Y coordinates of an image or image area into the markup. ImagText can also extract sections of an image based on the coordinates’ data in the markup. This feature is particularly applicable to the creation of dynamic HTML presentations enhanced with these image fragments without the need to create the image fragments manually in advance.

===Overlay===

Multiple images of the same manuscript folio or book page, each captured under different lighting conditions, may reveal details otherwise not visible in a single image (such as different layers of a painting). The EPPT OverLay tool creates a single image from two overlaid images for comparing and encoding multiple images of a folio or page. The tool includes a slider which changes the transparency of the top image, thereby making the bottom image gradually visible.

Overlaying two images is a simple process. The user selects a pair of points for each image; OverLay then automatically scales the images until the selected pair of points from both images coincides to create the resulting overlaid image. OverLay enhances image-based electronic editions in at least two ways:

i. Overlay allows comparison of multiple images of the same object. For example, when studying images of a palimpsest captured under different lighting conditions, such as bright daylight and ultraviolet fluorescence, Overlay allows the editor to compare and contrast the readable text in one or both images simply by selecting a portion of the overlaid image and moving the slider.

ii. Overlay allows encoding image-text correspondence for one reference image; the other images of the same object are then "scaled" to the reference image so that all related image-text correspondences are accurate.

An overlaid image can be saved and attached to a project, thus automatically remaining available for future encoding.

===xTagger===

xTagger is a document-centric XML editor with built-in options to display or hide XML syntax from the user. In xTagger, markup is inserted by first selecting the text, then adding element and attribute information through a template interface called xMarkup. The editor focuses on how and where to encode, leaving the burden of XML syntax correctness to xTagger.

The following is a list of most important features of xTagger:

* Provides content-only and/or XML-view of the edition
* Allows the editor to define filters for hiding text and/or markup, useful for complex projects including textual variants, editorial emendations and annotations, expansion of abbreviations, etc.
* Supports XML markup search and text search
* Includes configurable tool tip information, formatted in HTML, which facilitates quick viewing of metadata simply by moving the mouse pointer
* Provides links from text to its corresponding image via the @coords X/Y coordinates
* Supports integration of multiple XML hierarchies (i.e., more than one XML schema can be associated with a project) through XML serialization using milestones and fragmentation

===xMarkup===

xMarkup comprises multiple templates – one for each element in the DTD(s) associated with a project – which support quick encoding of text and semi-automatic linking of images and text. Each template includes all the attributes associated with an element and when applicable, a list of all enumerated values associated with a specific attribute. xMarkup also supports customization of markup hierarchies and association of aliases to elements (e.g., line for <l>) to simplify markup for novice text encoders. xMarkup can be used not only for inserting markup, but for editing and/or deleting markup as well.

===HttpServer===

HttpServer is a lightweight HTTP server implemented in EPPT to support HTML presentation of XML data. For instance, HTML pages displayed in EPPT can request image fragments from ImagText, based on image fragment coordinates stored in the XML markup as the value of the @coords. The tool is extremely useful in editorial work as it facilitates dynamic transformation of an XML-encoded edition into an HTML presentation with integrated images and text. An editor can view the images and text in HTML, then seamlessly return to the project view to make corrections and/or revisions to the markup.

===Image-Catalog===

An important feature of image-text linking in EPPT is the decoupling of image identifiers that appear in the markup (e.g., <div n=“f123v”>) from the actual image file names (e.g., “f123v.jpg”). To facilitate this, EPPT uses an image file indexer called the image-catalog. The image-catalog maintains correspondence between the image identifiers used in the markup and actual image files, and determines whether or not a given image file belongs to a project. For example, a project may include multiple images of the same folio or page, such as images captured under different lighting conditions. In such cases, both images will have a single identifier in the markup: the user simply decides which specific image of that page or folio to display.

===Additional Tools===

Other tools provided in EPPT include:

* DucType
* Glossary Tool
* StaTend
* Quires

<br/><hr/>

LegacyFacsimileMarkup

2007-06-01T13:59:15Z

Dot.porter: /* left<br/><hr/>Method used by Edition Production & Presentation Technology (EPPT) to link images and text with complex markup */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image):

Figure is also self-nesting, which allows for description of image fragments, though as TEI is now described those image fragments would have to be separate image files. Would it be useful to instead have a way to note coordinates using an attribute or attributes in <graphic>? (@mets:coords or @svg coordinate attributes; see [[TEI_to_SVG#Mapping_attributes]]):
<pre>
<figure>
<head>My entire image</head>
<graphic.../>
<figure>
<head>fragment 1</head>
<graphic.../>
</figure>
<figure>
<head>fragment 2</head>
<graphic.../>
</figure>
</figure>
</pre>
If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

<figure> may contain more than one graphic, so it is possible to relate multiple image files to a single physical object:
<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.11)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.12)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/17.jpg"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and facsimile==

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.

(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

<br/><br/>

=[[Image:spacer.gif|left]]<br/><hr/>Method used by Edition Production & Presentation Technology (EPPT) to link images and text with complex markup=

EPPT (www.eppt.org/eppt) is a software platform designed to help editors prepare and display image-based XML-encoded electronic scholarly editions. EPPT uses electronic text, DTDs, and digital facsimiles (JPG, BMP, GIF, TIFF, etc.) to produce highly complex encoding of image-based textual resources. EPPT supports any DTD-based encoding schema (such as the TEI P4 DTDs – with support for P5 XML Schema and RelaxNG currently under development) and enables precise, semi-automatic linking of full images as well as image sections with structural and descriptive metadata. EPPT includes new technologies and extensions (such as support for multiple hierarchies) to provide a powerful user interface for leveraging XML technologies in the production of image-based XML-encoded electronic editions. See [[EPPT|a full description of the EPPT]].

For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=ALTO=

[http://www.ccs-gmbh.com/alto/ ALTO (Analysed Layout and Text Object)] is an extension schema for METS, allowing the markup of layout information of digitised texts. It has had a bit of use in newspaper digitisation in the States, in the National Digital Newspaper Project.

In summary, it defines digitised texts as consisting of "page" elements containing "blocks" which have rectangular coordinates assigned to them using attributes HPOS, VPOS, WIDTH, and HEIGHT, and also a ROTATION. Each block element's page is associated with image files with stand-off markup in the normal METS way.

By contrast we need a different way to relate TEI content elements to pages, since the dominant hierarchy in TEI is logical rather than physical (i.e. div rather than page).

[http://www.loc.gov/ndnp/alto_1-1-041.xsd XML Schema for ALTO]

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (though updated on this page to TEI P5)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined - editors can use their own markup schemas (requires @coords)
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

[[Category:Facsimiles|Legacy]]

LegacyFacsimileMarkup

2006-11-16T00:11:09Z

Dot.porter:

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image):

Figure is also self-nesting, which allows for description of image fragments, though as TEI is now described those image fragments would have to be separate image files. Would it be useful to instead have a way to note coordinates using an attribute or attributes in <graphic>? (@mets:coords or @svg coordinate attributes; see [[TEI_to_SVG#Mapping_attributes]]):
<pre>
<figure>
<head>My entire image</head>
<graphic.../>
<figure>
<head>fragment 1</head>
<graphic.../>
</figure>
<figure>
<head>fragment 2</head>
<graphic.../>
</figure>
</figure>
</pre>
If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

<figure> may contain more than one graphic, so it is possible to relate multiple image files to a single physical object:
<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.11)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.12)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/17.jpg"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and facsimile==

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.

(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

<br/><br/>

=[[Image:spacer.gif|left]]<br/><hr/>Method used by Edition Production & Presentation Technology (EPPT) to link images and text with complex markup=

EPPT (http://www.eppt.org/eppt-trial/EPPT-TrialProjects.htm) is a software platform designed to help editors prepare and display image-based XML-encoded electronic scholarly editions. EPPT uses electronic text, DTDs, and digital facsimiles (JPG, BMP, GIF, TIFF, etc.) to produce highly complex encoding of image-based textual resources. EPPT supports any DTD-based encoding schema (such as the TEI P4 DTDs – with support for P5 XML Schema and RelaxNG currently under development) and enables precise, semi-automatic linking of full images as well as image sections with structural and descriptive metadata. EPPT includes new technologies and extensions (such as support for multiple hierarchies) to provide a powerful user interface for leveraging XML technologies in the production of image-based XML-encoded electronic editions. See [[EPPT|a full description of the EPPT]].

For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=ALTO=

[http://www.ccs-gmbh.com/alto/ ALTO (Analysed Layout and Text Object)] is an extension schema for METS, allowing the markup of layout information of digitised texts. It has had a bit of use in newspaper digitisation in the States, in the National Digital Newspaper Project.

In summary, it defines digitised texts as consisting of "page" elements containing "blocks" which have rectangular coordinates assigned to them using attributes HPOS, VPOS, WIDTH, and HEIGHT, and also a ROTATION. Each block element's page is associated with image files with stand-off markup in the normal METS way.

By contrast we need a different way to relate TEI content elements to pages, since the dominant hierarchy in TEI is logical rather than physical (i.e. div rather than page).

[http://www.loc.gov/ndnp/alto_1-1-041.xsd XML Schema for ALTO]

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (though updated on this page to TEI P5)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined - editors can use their own markup schemas (requires @coords)
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

EPPT

2006-11-16T00:03:31Z

Dot.porter:

=[[Image:spacer.gif|left]]<br/><hr/>Edition Production & Presentation Technology (EPPT)=

EPPT (http://www.eppt.org/eppt-trial/EPPT-TrialProjects.htm) is a software platform designed to help editors prepare and display image-based XML-encoded electronic scholarly editions. EPPT uses electronic text, DTDs, and digital facsimiles (JPG, BMP, GIF, TIFF, etc.) to produce highly complex encoding of image-based textual resources. EPPT supports any DTD-based encoding schema (such as the TEI P4 DTDs – with support for P5 XML Schema and RelaxNG currently under development) and enables precise, semi-automatic linking of full images as well as image sections with structural and descriptive metadata. EPPT includes new technologies and extensions (such as support for multiple hierarchies) to provide a powerful user interface for leveraging XML technologies in the production of image-based XML-encoded electronic editions.

==Main features of EPPT==

* Starts new projects quickly through a project wizard
* Customizes different projects using different schemas
* Carries the data management burden (XML syntax, well-formedness, etc.), allowing the editor to focus on the content, and how and where to encode it
* Provides simple user interfaces to link images and text through markup:
** Select text
** Select corresponding section of image
** Select element from DTD-sensitive interface which opens an element-specific template
** Fill in desired attribute values
** Click “Tag it!”
* Uses templates to reduce errors, ensuring comprehensive insertion of markup, and acceleration and, in some cases, automation of the insertion of repetitive attribute values
* Offers easy navigation of text, metadata, and images
* Supports multiple XML hierarchies in the same project with serialization in XML using "milestones" and "fragmentation” (as described in the TEI guidelines)
* Allows grouping of tags into semantically related markup categories for easier project management, collaborative editing, distribution of effort, etc.
* Integrates XSL and generates HTML presentations
* Provides an API (with examples) to link HTML presentations (through XSLT) with project images and text, extracted and displayed from markup
* Furnishes individual views of text content and its markup, and filters for both, to help the editor focus on particular content or markup as the encoding grows
* Operates on XML and produces non-proprietary XML completely portable to other applications
* Can extract rectangular sections of images to be used in HTML presentations based on image X/Y coordinates stored in the markup
* Includes a customizable search interface with an XQuery search engine

==EPPT Tools==

===ImagText===

ImagText, the default user interface of EPPT, is responsible for both image data management (e.g., finding and opening image files associated with a project) and user image-interface interaction. The tool provides the usual image manipulation toolbox: zoom, magnification, horizontal or vertical display of one or two images, etc.

ImagText supports image area selection and, provided the @coords has been included in the content model for the selected element in the DTD, automatically inserts the X/Y coordinates of an image or image area into the markup. ImagText can also extract sections of an image based on the coordinates’ data in the markup. This feature is particularly applicable to the creation of dynamic HTML presentations enhanced with these image fragments without the need to create the image fragments manually in advance.

===Overlay===

Multiple images of the same manuscript folio or book page, each captured under different lighting conditions, may reveal details otherwise not visible in a single image (such as different layers of a painting). The EPPT OverLay tool creates a single image from two overlaid images for comparing and encoding multiple images of a folio or page. The tool includes a slider which changes the transparency of the top image, thereby making the bottom image gradually visible.

Overlaying two images is a simple process. The user selects a pair of points for each image; OverLay then automatically scales the images until the selected pair of points from both images coincides to create the resulting overlaid image. OverLay enhances image-based electronic editions in at least two ways:

i. Overlay allows comparison of multiple images of the same object. For example, when studying images of a palimpsest captured under different lighting conditions, such as bright daylight and ultraviolet fluorescence, Overlay allows the editor to compare and contrast the readable text in one or both images simply by selecting a portion of the overlaid image and moving the slider.

ii. Overlay allows encoding image-text correspondence for one reference image; the other images of the same object are then "scaled" to the reference image so that all related image-text correspondences are accurate.

An overlaid image can be saved and attached to a project, thus automatically remaining available for future encoding.

===xTagger===

xTagger is a document-centric XML editor with built-in options to display or hide XML syntax from the user. In xTagger, markup is inserted by first selecting the text, then adding element and attribute information through a template interface called xMarkup. The editor focuses on how and where to encode, leaving the burden of XML syntax correctness to xTagger.

The following is a list of most important features of xTagger:

* Provides content-only and/or XML-view of the edition
* Allows the editor to define filters for hiding text and/or markup, useful for complex projects including textual variants, editorial emendations and annotations, expansion of abbreviations, etc.
* Supports XML markup search and text search
* Includes configurable tool tip information, formatted in HTML, which facilitates quick viewing of metadata simply by moving the mouse pointer
* Provides links from text to its corresponding image via the @coords X/Y coordinates
* Supports integration of multiple XML hierarchies (i.e., more than one XML schema can be associated with a project) through XML serialization using milestones and fragmentation

===xMarkup===

xMarkup comprises multiple templates – one for each element in the DTD(s) associated with a project – which support quick encoding of text and semi-automatic linking of images and text. Each template includes all the attributes associated with an element and when applicable, a list of all enumerated values associated with a specific attribute. xMarkup also supports customization of markup hierarchies and association of aliases to elements (e.g., line for <l>) to simplify markup for novice text encoders. xMarkup can be used not only for inserting markup, but for editing and/or deleting markup as well.

===HttpServer===

HttpServer is a lightweight HTTP server implemented in EPPT to support HTML presentation of XML data. For instance, HTML pages displayed in EPPT can request image fragments from ImagText, based on image fragment coordinates stored in the XML markup as the value of the @coords. The tool is extremely useful in editorial work as it facilitates dynamic transformation of an XML-encoded edition into an HTML presentation with integrated images and text. An editor can view the images and text in HTML, then seamlessly return to the project view to make corrections and/or revisions to the markup.

===Image-Catalog===

An important feature of image-text linking in EPPT is the decoupling of image identifiers that appear in the markup (e.g., <div n=“f123v”>) from the actual image file names (e.g., “f123v.jpg”). To facilitate this, EPPT uses an image file indexer called the image-catalog. The image-catalog maintains correspondence between the image identifiers used in the markup and actual image files, and determines whether or not a given image file belongs to a project. For example, a project may include multiple images of the same folio or page, such as images captured under different lighting conditions. In such cases, both images will have a single identifier in the markup: the user simply decides which specific image of that page or folio to display.

===Additional Tools===

Other tools provided in EPPT include:

* DucType
* Glossary Tool
* StaTend
* Quires

<br/><hr/>
[[Category:Tools]]

EPPT

2006-11-16T00:03:02Z

Dot.porter:

LegacyFacsimileMarkup

2006-06-19T13:11:37Z

Dot.porter: /* P5 Guidelines, 22.3 (Specific Elements for Graphic Images) */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image):

Figure is also self-nesting, which allows for description of image fragments, though as TEI is now described those image fragments would have to be separate image files. Would it be useful to instead have a way to note coordinates using an attribute or attributes in <graphic>? (@mets:coords or @svg coordinate attributes; see [[TEI_to_SVG#Mapping_attributes]]):
<pre>
<figure>
<head>My entire image</head>
<graphic.../>
<figure>
<head>fragment 1</head>
<graphic.../>
</figure>
<figure>
<head>fragment 2</head>
<graphic.../>
</figure>
</figure>
</pre>
If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

<figure> may contain more than one graphic, so it is possible to relate multiple image files to a single physical object:
<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.11)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.12)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/17.jpg"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and facsimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (though updated on this page to TEI P5)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined - editors can use their own markup schemas (requires @coords)
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-19T13:09:22Z

Dot.porter: /* P5 Guidelines, 22.3 (Specific Elements for Graphic Images) */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image):

Figure is also self-nesting, which allows for description of image fragments, though as TEI is now described those image fragments would have to be separate image files. Would it be useful to instead have a way to note coordinates using an attribute or attributes in <graphic>? (@mets:coords or @svg coordinate attributes; see http://www.tei-c.org.uk/wiki/index.php/TEI_to_SVG#Mapping_attributes):
<pre>
<figure>
<head>My entire image</head>
<graphic.../>
<figure>
<head>fragment 1</head>
<graphic.../>
</figure>
<figure>
<head>fragment 2</head>
<graphic.../>
</figure>
</figure>
</pre>
If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

<figure> may contain more than one graphic, so it is possible to relate multiple image files to a single physical object:
<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.11)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.12)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/17.jpg"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and facsimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (though updated on this page to TEI P5)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined - editors can use their own markup schemas (requires @coords)
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-19T13:08:35Z

Dot.porter: /* P5 Guidelines, 22.3 (Specific Elements for Graphic Images) */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image):

Figure is also self-nesting, which allows for description of image fragments, though as TEI is now described those image fragments would have to be separate image files. Would it be useful to instead have a way to note coordinates using an attribute or attributes in <graphic>? (@mets:coords or @svg coordinate attributes; see ):
<pre>
<figure>
<head>My entire image</head>
<graphic.../>
<figure>
<head>fragment 1</head>
<graphic.../>
</figure>
<figure>
<head>fragment 2</head>
<graphic.../>
</figure>
</figure>
</pre>
If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

<figure> may contain more than one graphic, so it is possible to relate multiple image files to a single physical object:
<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.11)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.12)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/17.jpg"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and facsimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (though updated on this page to TEI P5)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined - editors can use their own markup schemas (requires @coords)
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-19T13:08:14Z

Dot.porter: /* P5 Guidelines, 22.3 (Specific Elements for Graphic Images) */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image):

Figure is also self-nesting, which allows for description of image fragments, though as TEI is now described those image fragments would have to be separate image files. Would it be useful to instead have a way to note coordinates using an attribute or attributes in &lg;graphic>? (@mets:coords or @svg coordinate attributes; see ):
<pre>
<figure>
<head>My entire image</head>
<graphic.../>
<figure>
<head>fragment 1</head>
<graphic.../>
</figure>
<figure>
<head>fragment 2</head>
<graphic.../>
</figure>
</figure>
</pre>
If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

<figure> may contain more than one graphic, so it is possible to relate multiple image files to a single physical object:
<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.11)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.12)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/17.jpg"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and facsimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (though updated on this page to TEI P5)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined - editors can use their own markup schemas (requires @coords)
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-09T13:11:17Z

Dot.porter: /* 3: Techniques for Referencing Images */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image).

If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

<figure> may contain more than one graphic, so it is possible to relate multiple image files to a single physical object:
<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.11)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels" (Ohlgren
16.12)]</figDesc>
<graphic n="daylight" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
<graphic n="uv" url="http://image.ox.ac.uk/images/bodleian/msjunius11/UV/17.jpg"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (though updated on this page to TEI P5)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined - editors can use their own markup schemas (requires @coords)
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-09T13:06:54Z

Dot.porter: /* 3: Techniques for Referencing Images */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image).

If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (though updated on this page to TEI P5)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined - editors can use their own markup schemas (requires @coords)
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-09T13:00:19Z

Dot.porter: /* Conclusions */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image).

If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (though updated on this page to TEI P5)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined - editors can use their own markup schemas (requires @coords)
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-08T19:27:49Z

Dot.porter: /* Conclusions */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image).

If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (very out of date!)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined - editors can use their own markup schemas (requires @coords)
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-08T19:26:51Z

Dot.porter: /* Conclusions */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image).

If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Based on TEI P3 (very out of date!)
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

TEI to SVG

2006-06-08T19:05:00Z

Dot.porter: /* TEI Elements and their SVG Equivalents (approx.) */

=A Quick Look Through the TEI Figures Module=

Module: figures (Tables, Formulae, and Graphics, [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html P5 chapter 22])

Elements Defined: table row cell formula figure figDesc graphic binaryObject

The "figure" module really contains three related - but very different - aspects.

#Tables<br/>Elements: table row cell<br/>I don't immediately see anything corresponding to this in SVG. It wouldn't make sense, anyway - tables are really for organizing textual material. Anything else?
#Formulae<br/>Elements: formula<br/>Formula already allows for the inclusion of elements from outside the TEI, although the [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html#id2784077 examples in the guidelines] do not use namespaces, and namespaces are not mentioned in the text. Should we recommend that <figure> require namespaces for elements pulled in from elsewhere? If so, what about (as in the first two examples) when the notation is non-XML? Is @notation really enough?
#*How will this section generally be used? Will the most common usages be MathML or ChemML (or something similar from the sciences), or perhaps simpler formulas expressed in available Unicode characters?<br/>"By default, a <formula> is assumed to contain character data which is not validated in any way"<br/>Is this really a good idea? This means that, if you have a formula that contains non-standard characters, you would be unable to use gaiji without customization. That seems strange.
#Graphic Images<br/>Elements: figure graphic binaryObject figDesc<br/>The <figure> element is used to contain images, captions, and textual descriptions of the pictures.<br/>The images themselves are specified using the <graphic> element, whose url attribute provides the location of an image.
<pre>
<figure>
<graphic url="Fig1.pdf"/>
</figure>
</pre>
<figure> may also contain <head> (providing a title or heading for the image) <figDesc> (a description of the image) and <p> (commentary or caption, not a description of the image).

"Where the graphic itself contains large amounts of text, perhaps with a complex structure, and perhaps difficult to distinguish from the graphic, the encoder should choose whether to regard the graphic as containing the text (in which case, a nested <text> element may be included within the <figure> element) or to regard the enclosed text as being a separate division of the <text> element in which the graphic appears. In this latter case, an appropriate divn class element may be used for the text represented within the graphic, and the <figure> element embedded within it. The choice will depend to a large degree on the encoder's understanding of the relationship between the graphic and the surrounding text."

So <figure> may also contain <text>.

=TEI Elements and their SVG Equivalents (approx.)=

Quick Links:

TEI Chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics]

Scalable Vector Graphics (SVG) [http://www.w3.org/TR/SVG/ 1.1 Specification]

==tei:graphic and svg:image==

===tei:graphic===
tei:graphic "indicates the location of an inline graphic, illustration, or figure."

attributes: (In addition to global attributes)
<pre>
width The display width of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
height The display height of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
scale A scale factor to be applied to the image to make it the desired display size
Status: Mandatory when applicable
Datatype: data.probability
url The target URL
Status: Mandatory when applicable
Datatype: data.pointer
Values: The name of a URL which provides the image.
mimeType The MIME type
Status: Mandatory when applicable
Datatype: data.word
Values: The MIME type to be used for the object when it is decoded
</pre>
<pre>
<figure>
<graphic url="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===svg:image===

svg:image "indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""

attributes:
<pre>
x = "<coordinate>"
The x-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
y = "<coordinate>"
The y-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
width = "<length>"
The width of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
height = "<length>"
The height of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
xlink:href = "<uri>"
A URI reference.
Animatable: yes.
</pre>

*Are x and y necessary?
*xlink:href instead of url = this is nice.

<pre>
<figure>
<svg:image xlink:href="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===Thoughts===
If we were to recommend a module to import all of SVG, it would be preferable to use only svg:image and to drop tei:graphic entirely (if svg:image does indeed do everything we would need it to do in TEI). But if we don't want to "modulate" SVG (if we just say that we will refer to external SVG files if we need them), do we still want to maintain a separate tei:graphic element?

==The nested grouping of TEI image elements==

===tei:figure/tei:graphic|tei:head|tei:figDesc===

*figure "contains a block containing graphics, illustrations, or figures."
*graphic "indicates the location of an inline graphic, illustration, or figure."
*head "contains any type of heading, for example the title of a section, or the heading of a list, glossary, manuscript description, etc."
*figDesc "(Description of Figure) contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it."

May map to the SVG:

===svg:g/svg:image|svg:title|svg:desc===

*"The 'g' element is a container element for grouping together related graphics elements."
*"The 'image' element indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""
*"Each container element or graphics element in an SVG drawing can supply a 'desc' and/or a 'title' description string where the description is text-only."
*"The 'title' child element to an ... element serves the purposes of identifying the content of the given SVG document fragment."

===Examples===
<pre>
<figure xml:id="id1">
<graphic width="4" height="2" url="fig1.png" mimeType="image/png"/>
<head type="image title">Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>
<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
</svg:g>
</pre>

===Notes===
*svg:g has @id, not @xml:id.
*tei:graphic/@scale and svg:image/@preserveAspectRatio (http://www.w3.org/TR/SVG/coords.html#preserveAspectRatio) are, I believe, similar, but they are Greek to me. I need help here.
*svg:image lacks @mimeType, but is it necessary?
*svg:title does not seem to have a type attribute, but since this element would be used only in reference to image titles, I don't think that this is a problem.
*As noted in a previous section, <figure> may also contain <p> or <text>. There are no equivalent elements in SVG. Would it make sense to include those elements in an SVG group as TEI namespace?

<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
<tei:p>paragraph here</tei:p>
<tei:text>text contained on the image</tei:text>
</svg:g>
</pre>

Or should we encourage use of a standard TEI
block element such as a <div> or <figure> to bracket together an svg element
and any tei elements that need to be tied to it:
<pre>
<figure>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
</svg:g>
<p>paragraph here</p>
<text>text contained on the image</text>
</figure>
</pre>

==Mapping attributes==

Hold coordinates in individual elements using @mets:coords (instead of creating @tei:coords)

As described in the [http://www.loc.gov/standards/mets/docs/mets.v1-5.html#area METS documentation]:
COORDS: an optional string attribute listing a set of visual coordinates within an image (still image or video frame). The COORDS attribute should be used as in HTML 4.

And in [http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords HTML 4.01]:
This attribute specifies the position and shape on the screen. The number and order of values depends on the shape being defined. Possible combinations:
*rect: left-x, top-y, right-x, bottom-y.
*circle: center-x, center-y, radius. Note. When the radius value is a percentage value, user agents should calculate the final radius value based on the associated object's width and height. The radius should be the smaller value of the two.
*poly: x1, y1, x2, y2, ..., xN, yN. The first x and y coordinate pair and the last should be the same to close the polygon. When these coordinate values are not the same, user agents should infer an additional coordinate pair to close the polygon.

Coordinates are relative to the top, left corner of the object. All values are lengths. All values are separated by commas.

METS defines @mets:coords on <area>. For TEI, it would be nice to have this attribute available to "regular" elements, not to a special element. The reasoning is that in many cases, especially when dealing with primary source texts, TEI elements refer not to a text in general but to the text as it appears in a specific physical document. It may not make sense to allow @mets:coords on <p>, but it may make perfect sense to allow it on those elements described in Chapter 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Sources] that relate to a specific physical occurrance:
<pre>
<abbr>
<sic>
<add>
<del>
<hi>
<restore>
<gap>
<damage>
<unclear>
<space>
<fw>
</pre>

SVG defines various attribute values for coordinates. The system is based on a shape (identified by the element), but the attributes vary, so one could use the same attributes in the same element in various combinations to achieve the same result:

rectangle:
<pre>
@svg:x = length
@svg:y = length
(rounded edges:
@svg:rx = length
@svg:ry = length)
</pre>
circle:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the circle.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the circle.
@svg:r = "<length>"
The radius of the circle.
</pre>

ellipse:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the ellipse.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the ellipse.
@svg:rx = "<length>"
The x-axis radius of the ellipse.
@svg:ry = "<length>"
The y-axis radius of the ellipse.
</pre>

polygon:
<pre>
@svg:points = "<list-of-points>"
The points that make up the polygon. All coordinate values are in the user coordinate system.
</pre>

@svg:points seems to me to be very similar to @mets:coords, except that it cannot be used to form a circle (only boundaries with straight edges)

There may be instances where one would want to use @mets:coords (for simple circles and bounding boxes) and other times when it would make more sense to use svg:x/y/width/height etc. (for more complex shapes).

We need to continue looking at SVG, whether we want to be able to import it in a module or link to external files. Or both.

==tei:binaryObject==

I don't see an equivalent in SVG, but it may be because I don't know where to look.

=Using SVG with TEI=

In some instances, it makes sense to enable broad use of SVG throughout the TEI document. For instance,
although most of the examples here relate to the embedding of bitmap data,
the real power of SVG is in describing vector information, and it's the
perfect tool for capturing dividing lines on the page, shapes, blocks of
text set off from the page, decorative flourishes, simple diagrams,
graphs, logos and so on. It's not the case that, for example, illuminated manuscript pages
could be described in SVG in place of the use of hi-res page images, but
it would be useful to specify the layout of a complex MS page
(where there might be annotations on commentaries on commentaries) in
terms of SVG shape structures, with the text element blocks embedded
inside them, enabling a usefully approximate rendering of the page
layout incorporating the transcription.

TEI to SVG

2006-06-08T19:04:41Z

Dot.porter: /* TEI Elements and their SVG Equivalents (approx.) */

=A Quick Look Through the TEI Figures Module=

Module: figures (Tables, Formulae, and Graphics, [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html P5 chapter 22])

Elements Defined: table row cell formula figure figDesc graphic binaryObject

The "figure" module really contains three related - but very different - aspects.

#Tables<br/>Elements: table row cell<br/>I don't immediately see anything corresponding to this in SVG. It wouldn't make sense, anyway - tables are really for organizing textual material. Anything else?
#Formulae<br/>Elements: formula<br/>Formula already allows for the inclusion of elements from outside the TEI, although the [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html#id2784077 examples in the guidelines] do not use namespaces, and namespaces are not mentioned in the text. Should we recommend that <figure> require namespaces for elements pulled in from elsewhere? If so, what about (as in the first two examples) when the notation is non-XML? Is @notation really enough?
#*How will this section generally be used? Will the most common usages be MathML or ChemML (or something similar from the sciences), or perhaps simpler formulas expressed in available Unicode characters?<br/>"By default, a <formula> is assumed to contain character data which is not validated in any way"<br/>Is this really a good idea? This means that, if you have a formula that contains non-standard characters, you would be unable to use gaiji without customization. That seems strange.
#Graphic Images<br/>Elements: figure graphic binaryObject figDesc<br/>The <figure> element is used to contain images, captions, and textual descriptions of the pictures.<br/>The images themselves are specified using the <graphic> element, whose url attribute provides the location of an image.
<pre>
<figure>
<graphic url="Fig1.pdf"/>
</figure>
</pre>
<figure> may also contain <head> (providing a title or heading for the image) <figDesc> (a description of the image) and <p> (commentary or caption, not a description of the image).

"Where the graphic itself contains large amounts of text, perhaps with a complex structure, and perhaps difficult to distinguish from the graphic, the encoder should choose whether to regard the graphic as containing the text (in which case, a nested <text> element may be included within the <figure> element) or to regard the enclosed text as being a separate division of the <text> element in which the graphic appears. In this latter case, an appropriate divn class element may be used for the text represented within the graphic, and the <figure> element embedded within it. The choice will depend to a large degree on the encoder's understanding of the relationship between the graphic and the surrounding text."

So <figure> may also contain <text>.

=TEI Elements and their SVG Equivalents (approx.)=

Quick Links:

TEI Chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics]
Scalable Vector Graphics (SVG) [http://www.w3.org/TR/SVG/ 1.1 Specification]

==tei:graphic and svg:image==

===tei:graphic===
tei:graphic "indicates the location of an inline graphic, illustration, or figure."

attributes: (In addition to global attributes)
<pre>
width The display width of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
height The display height of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
scale A scale factor to be applied to the image to make it the desired display size
Status: Mandatory when applicable
Datatype: data.probability
url The target URL
Status: Mandatory when applicable
Datatype: data.pointer
Values: The name of a URL which provides the image.
mimeType The MIME type
Status: Mandatory when applicable
Datatype: data.word
Values: The MIME type to be used for the object when it is decoded
</pre>
<pre>
<figure>
<graphic url="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===svg:image===

svg:image "indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""

attributes:
<pre>
x = "<coordinate>"
The x-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
y = "<coordinate>"
The y-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
width = "<length>"
The width of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
height = "<length>"
The height of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
xlink:href = "<uri>"
A URI reference.
Animatable: yes.
</pre>

*Are x and y necessary?
*xlink:href instead of url = this is nice.

<pre>
<figure>
<svg:image xlink:href="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===Thoughts===
If we were to recommend a module to import all of SVG, it would be preferable to use only svg:image and to drop tei:graphic entirely (if svg:image does indeed do everything we would need it to do in TEI). But if we don't want to "modulate" SVG (if we just say that we will refer to external SVG files if we need them), do we still want to maintain a separate tei:graphic element?

==The nested grouping of TEI image elements==

===tei:figure/tei:graphic|tei:head|tei:figDesc===

*figure "contains a block containing graphics, illustrations, or figures."
*graphic "indicates the location of an inline graphic, illustration, or figure."
*head "contains any type of heading, for example the title of a section, or the heading of a list, glossary, manuscript description, etc."
*figDesc "(Description of Figure) contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it."

May map to the SVG:

===svg:g/svg:image|svg:title|svg:desc===

*"The 'g' element is a container element for grouping together related graphics elements."
*"The 'image' element indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""
*"Each container element or graphics element in an SVG drawing can supply a 'desc' and/or a 'title' description string where the description is text-only."
*"The 'title' child element to an ... element serves the purposes of identifying the content of the given SVG document fragment."

===Examples===
<pre>
<figure xml:id="id1">
<graphic width="4" height="2" url="fig1.png" mimeType="image/png"/>
<head type="image title">Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>
<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
</svg:g>
</pre>

===Notes===
*svg:g has @id, not @xml:id.
*tei:graphic/@scale and svg:image/@preserveAspectRatio (http://www.w3.org/TR/SVG/coords.html#preserveAspectRatio) are, I believe, similar, but they are Greek to me. I need help here.
*svg:image lacks @mimeType, but is it necessary?
*svg:title does not seem to have a type attribute, but since this element would be used only in reference to image titles, I don't think that this is a problem.
*As noted in a previous section, <figure> may also contain <p> or <text>. There are no equivalent elements in SVG. Would it make sense to include those elements in an SVG group as TEI namespace?

<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
<tei:p>paragraph here</tei:p>
<tei:text>text contained on the image</tei:text>
</svg:g>
</pre>

Or should we encourage use of a standard TEI
block element such as a <div> or <figure> to bracket together an svg element
and any tei elements that need to be tied to it:
<pre>
<figure>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
</svg:g>
<p>paragraph here</p>
<text>text contained on the image</text>
</figure>
</pre>

==Mapping attributes==

Hold coordinates in individual elements using @mets:coords (instead of creating @tei:coords)

As described in the [http://www.loc.gov/standards/mets/docs/mets.v1-5.html#area METS documentation]:
COORDS: an optional string attribute listing a set of visual coordinates within an image (still image or video frame). The COORDS attribute should be used as in HTML 4.

And in [http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords HTML 4.01]:
This attribute specifies the position and shape on the screen. The number and order of values depends on the shape being defined. Possible combinations:
*rect: left-x, top-y, right-x, bottom-y.
*circle: center-x, center-y, radius. Note. When the radius value is a percentage value, user agents should calculate the final radius value based on the associated object's width and height. The radius should be the smaller value of the two.
*poly: x1, y1, x2, y2, ..., xN, yN. The first x and y coordinate pair and the last should be the same to close the polygon. When these coordinate values are not the same, user agents should infer an additional coordinate pair to close the polygon.

Coordinates are relative to the top, left corner of the object. All values are lengths. All values are separated by commas.

METS defines @mets:coords on <area>. For TEI, it would be nice to have this attribute available to "regular" elements, not to a special element. The reasoning is that in many cases, especially when dealing with primary source texts, TEI elements refer not to a text in general but to the text as it appears in a specific physical document. It may not make sense to allow @mets:coords on <p>, but it may make perfect sense to allow it on those elements described in Chapter 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Sources] that relate to a specific physical occurrance:
<pre>
<abbr>
<sic>
<add>
<del>
<hi>
<restore>
<gap>
<damage>
<unclear>
<space>
<fw>
</pre>

SVG defines various attribute values for coordinates. The system is based on a shape (identified by the element), but the attributes vary, so one could use the same attributes in the same element in various combinations to achieve the same result:

rectangle:
<pre>
@svg:x = length
@svg:y = length
(rounded edges:
@svg:rx = length
@svg:ry = length)
</pre>
circle:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the circle.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the circle.
@svg:r = "<length>"
The radius of the circle.
</pre>

ellipse:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the ellipse.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the ellipse.
@svg:rx = "<length>"
The x-axis radius of the ellipse.
@svg:ry = "<length>"
The y-axis radius of the ellipse.
</pre>

polygon:
<pre>
@svg:points = "<list-of-points>"
The points that make up the polygon. All coordinate values are in the user coordinate system.
</pre>

@svg:points seems to me to be very similar to @mets:coords, except that it cannot be used to form a circle (only boundaries with straight edges)

There may be instances where one would want to use @mets:coords (for simple circles and bounding boxes) and other times when it would make more sense to use svg:x/y/width/height etc. (for more complex shapes).

We need to continue looking at SVG, whether we want to be able to import it in a module or link to external files. Or both.

==tei:binaryObject==

I don't see an equivalent in SVG, but it may be because I don't know where to look.

=Using SVG with TEI=

In some instances, it makes sense to enable broad use of SVG throughout the TEI document. For instance,
although most of the examples here relate to the embedding of bitmap data,
the real power of SVG is in describing vector information, and it's the
perfect tool for capturing dividing lines on the page, shapes, blocks of
text set off from the page, decorative flourishes, simple diagrams,
graphs, logos and so on. It's not the case that, for example, illuminated manuscript pages
could be described in SVG in place of the use of hi-res page images, but
it would be useful to specify the layout of a complex MS page
(where there might be annotations on commentaries on commentaries) in
terms of SVG shape structures, with the text element blocks embedded
inside them, enabling a usefully approximate rendering of the page
layout incorporating the transcription.

TEI to SVG

2006-06-08T16:22:59Z

Dot.porter:

=A Quick Look Through the TEI Figures Module=

Module: figures (Tables, Formulae, and Graphics, [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html P5 chapter 22])

Elements Defined: table row cell formula figure figDesc graphic binaryObject

The "figure" module really contains three related - but very different - aspects.

#Tables<br/>Elements: table row cell<br/>I don't immediately see anything corresponding to this in SVG. It wouldn't make sense, anyway - tables are really for organizing textual material. Anything else?
#Formulae<br/>Elements: formula<br/>Formula already allows for the inclusion of elements from outside the TEI, although the [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html#id2784077 examples in the guidelines] do not use namespaces, and namespaces are not mentioned in the text. Should we recommend that <figure> require namespaces for elements pulled in from elsewhere? If so, what about (as in the first two examples) when the notation is non-XML? Is @notation really enough?
#*How will this section generally be used? Will the most common usages be MathML or ChemML (or something similar from the sciences), or perhaps simpler formulas expressed in available Unicode characters?<br/>"By default, a <formula> is assumed to contain character data which is not validated in any way"<br/>Is this really a good idea? This means that, if you have a formula that contains non-standard characters, you would be unable to use gaiji without customization. That seems strange.
#Graphic Images<br/>Elements: figure graphic binaryObject figDesc<br/>The <figure> element is used to contain images, captions, and textual descriptions of the pictures.<br/>The images themselves are specified using the <graphic> element, whose url attribute provides the location of an image.
<pre>
<figure>
<graphic url="Fig1.pdf"/>
</figure>
</pre>
<figure> may also contain <head> (providing a title or heading for the image) <figDesc> (a description of the image) and <p> (commentary or caption, not a description of the image).

"Where the graphic itself contains large amounts of text, perhaps with a complex structure, and perhaps difficult to distinguish from the graphic, the encoder should choose whether to regard the graphic as containing the text (in which case, a nested <text> element may be included within the <figure> element) or to regard the enclosed text as being a separate division of the <text> element in which the graphic appears. In this latter case, an appropriate divn class element may be used for the text represented within the graphic, and the <figure> element embedded within it. The choice will depend to a large degree on the encoder's understanding of the relationship between the graphic and the surrounding text."

So <figure> may also contain <text>.

=TEI Elements and their SVG Equivalents (approx.)=

==tei:graphic and svg:image==

===tei:graphic===
tei:graphic "indicates the location of an inline graphic, illustration, or figure."

attributes: (In addition to global attributes)
<pre>
width The display width of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
height The display height of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
scale A scale factor to be applied to the image to make it the desired display size
Status: Mandatory when applicable
Datatype: data.probability
url The target URL
Status: Mandatory when applicable
Datatype: data.pointer
Values: The name of a URL which provides the image.
mimeType The MIME type
Status: Mandatory when applicable
Datatype: data.word
Values: The MIME type to be used for the object when it is decoded
</pre>
<pre>
<figure>
<graphic url="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===svg:image===

svg:image "indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""

attributes:
<pre>
x = "<coordinate>"
The x-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
y = "<coordinate>"
The y-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
width = "<length>"
The width of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
height = "<length>"
The height of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
xlink:href = "<uri>"
A URI reference.
Animatable: yes.
</pre>

*Are x and y necessary?
*xlink:href instead of url = this is nice.

<pre>
<figure>
<svg:image xlink:href="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===Thoughts===
If we were to recommend a module to import all of SVG, it would be preferable to use only svg:image and to drop tei:graphic entirely (if svg:image does indeed do everything we would need it to do in TEI). But if we don't want to "modulate" SVG (if we just say that we will refer to external SVG files if we need them), do we still want to maintain a separate tei:graphic element?

==The nested grouping of TEI image elements==

===tei:figure/tei:graphic|tei:head|tei:figDesc===

*figure "contains a block containing graphics, illustrations, or figures."
*graphic "indicates the location of an inline graphic, illustration, or figure."
*head "contains any type of heading, for example the title of a section, or the heading of a list, glossary, manuscript description, etc."
*figDesc "(Description of Figure) contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it."

May map to the SVG:

===svg:g/svg:image|svg:title|svg:desc===

*"The 'g' element is a container element for grouping together related graphics elements."
*"The 'image' element indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""
*"Each container element or graphics element in an SVG drawing can supply a 'desc' and/or a 'title' description string where the description is text-only."
*"The 'title' child element to an ... element serves the purposes of identifying the content of the given SVG document fragment."

===Examples===
<pre>
<figure xml:id="id1">
<graphic width="4" height="2" url="fig1.png" mimeType="image/png"/>
<head type="image title">Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>
<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
</svg:g>
</pre>

===Notes===
*svg:g has @id, not @xml:id.
*tei:graphic/@scale and svg:image/@preserveAspectRatio (http://www.w3.org/TR/SVG/coords.html#preserveAspectRatio) are, I believe, similar, but they are Greek to me. I need help here.
*svg:image lacks @mimeType, but is it necessary?
*svg:title does not seem to have a type attribute, but since this element would be used only in reference to image titles, I don't think that this is a problem.
*As noted in a previous section, <figure> may also contain <p> or <text>. There are no equivalent elements in SVG. Would it make sense to include those elements in an SVG group as TEI namespace?

<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
<tei:p>paragraph here</tei:p>
<tei:text>text contained on the image</tei:text>
</svg:g>
</pre>

Or should we encourage use of a standard TEI
block element such as a <div> or <figure> to bracket together an svg element
and any tei elements that need to be tied to it:
<pre>
<figure>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
</svg:g>
<p>paragraph here</p>
<text>text contained on the image</text>
</figure>
</pre>

==Mapping attributes==

Hold coordinates in individual elements using @mets:coords (instead of creating @tei:coords)

As described in the [http://www.loc.gov/standards/mets/docs/mets.v1-5.html#area METS documentation]:
COORDS: an optional string attribute listing a set of visual coordinates within an image (still image or video frame). The COORDS attribute should be used as in HTML 4.

And in [http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords HTML 4.01]:
This attribute specifies the position and shape on the screen. The number and order of values depends on the shape being defined. Possible combinations:
*rect: left-x, top-y, right-x, bottom-y.
*circle: center-x, center-y, radius. Note. When the radius value is a percentage value, user agents should calculate the final radius value based on the associated object's width and height. The radius should be the smaller value of the two.
*poly: x1, y1, x2, y2, ..., xN, yN. The first x and y coordinate pair and the last should be the same to close the polygon. When these coordinate values are not the same, user agents should infer an additional coordinate pair to close the polygon.

Coordinates are relative to the top, left corner of the object. All values are lengths. All values are separated by commas.

METS defines @mets:coords on <area>. For TEI, it would be nice to have this attribute available to "regular" elements, not to a special element. The reasoning is that in many cases, especially when dealing with primary source texts, TEI elements refer not to a text in general but to the text as it appears in a specific physical document. It may not make sense to allow @mets:coords on <p>, but it may make perfect sense to allow it on those elements described in Chapter 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Sources] that relate to a specific physical occurrance:
<pre>
<abbr>
<sic>
<add>
<del>
<hi>
<restore>
<gap>
<damage>
<unclear>
<space>
<fw>
</pre>

SVG defines various attribute values for coordinates. The system is based on a shape (identified by the element), but the attributes vary, so one could use the same attributes in the same element in various combinations to achieve the same result:

rectangle:
<pre>
@svg:x = length
@svg:y = length
(rounded edges:
@svg:rx = length
@svg:ry = length)
</pre>
circle:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the circle.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the circle.
@svg:r = "<length>"
The radius of the circle.
</pre>

ellipse:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the ellipse.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the ellipse.
@svg:rx = "<length>"
The x-axis radius of the ellipse.
@svg:ry = "<length>"
The y-axis radius of the ellipse.
</pre>

polygon:
<pre>
@svg:points = "<list-of-points>"
The points that make up the polygon. All coordinate values are in the user coordinate system.
</pre>

@svg:points seems to me to be very similar to @mets:coords, except that it cannot be used to form a circle (only boundaries with straight edges)

There may be instances where one would want to use @mets:coords (for simple circles and bounding boxes) and other times when it would make more sense to use svg:x/y/width/height etc. (for more complex shapes).

We need to continue looking at SVG, whether we want to be able to import it in a module or link to external files. Or both.

==tei:binaryObject==

I don't see an equivalent in SVG, but it may be because I don't know where to look.

=Using SVG with TEI=

In some instances, it makes sense to enable broad use of SVG throughout the TEI document. For instance,
although most of the examples here relate to the embedding of bitmap data,
the real power of SVG is in describing vector information, and it's the
perfect tool for capturing dividing lines on the page, shapes, blocks of
text set off from the page, decorative flourishes, simple diagrams,
graphs, logos and so on. It's not the case that, for example, illuminated manuscript pages
could be described in SVG in place of the use of hi-res page images, but
it would be useful to specify the layout of a complex MS page
(where there might be annotations on commentaries on commentaries) in
terms of SVG shape structures, with the text element blocks embedded
inside them, enabling a usefully approximate rendering of the page
layout incorporating the transcription.

TEI to SVG

2006-06-08T16:08:33Z

Dot.porter: /* A Quick Look Through the TEI Figures Module */

=A Quick Look Through the TEI Figures Module=

Module: figures (Tables, Formulae, and Graphics, [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html P5 chapter 22])

Elements Defined: table row cell formula figure figDesc graphic binaryObject

The "figure" module really contains three related - but very different - aspects.

#Tables<br/>Elements: table row cell<br/>I don't immediately see anything corresponding to this in SVG. It wouldn't make sense, anyway - tables are really for organizing textual material. Anything else?
#Formulae<br/>Elements: formula<br/>Formula already allows for the inclusion of elements from outside the TEI, although the [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html#id2784077 examples in the guidelines] do not use namespaces, and namespaces are not mentioned in the text. Should we recommend that <figure> require namespaces for elements pulled in from elsewhere? If so, what about (as in the first two examples) when the notation is non-XML? Is @notation really enough?
#*How will this section generally be used? Will the most common usages be MathML or ChemML (or something similar from the sciences), or perhaps simpler formulas expressed in available Unicode characters?<br/>"By default, a <formula> is assumed to contain character data which is not validated in any way"<br/>Is this really a good idea? This means that, if you have a formula that contains non-standard characters, you would be unable to use gaiji without customization. That seems strange.
#Graphic Images<br/>Elements: figure graphic binaryObject figDesc<br/>The <figure> element is used to contain images, captions, and textual descriptions of the pictures.<br/>The images themselves are specified using the <graphic> element, whose url attribute provides the location of an image.
<pre>
<figure>
<graphic url="Fig1.pdf"/>
</figure>
</pre>
<figure> may also contain <head> (providing a title or heading for the image) <figDesc> (a description of the image) and <p> (commentary or caption, not a description of the image).

"Where the graphic itself contains large amounts of text, perhaps with a complex structure, and perhaps difficult to distinguish from the graphic, the encoder should choose whether to regard the graphic as containing the text (in which case, a nested <text> element may be included within the <figure> element) or to regard the enclosed text as being a separate division of the <text> element in which the graphic appears. In this latter case, an appropriate divn class element may be used for the text represented within the graphic, and the <figure> element embedded within it. The choice will depend to a large degree on the encoder's understanding of the relationship between the graphic and the surrounding text."

So <figure> may also contain <text>.

=TEI Elements and their SVG Equivalents (approx.)=

==tei:graphic and svg:image==

===tei:graphic===
tei:graphic "indicates the location of an inline graphic, illustration, or figure."

attributes: (In addition to global attributes)
<pre>
width The display width of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
height The display height of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
scale A scale factor to be applied to the image to make it the desired display size
Status: Mandatory when applicable
Datatype: data.probability
url The target URL
Status: Mandatory when applicable
Datatype: data.pointer
Values: The name of a URL which provides the image.
mimeType The MIME type
Status: Mandatory when applicable
Datatype: data.word
Values: The MIME type to be used for the object when it is decoded
</pre>
<pre>
<figure>
<graphic url="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===svg:image===

svg:image "indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""

attributes:
<pre>
x = "<coordinate>"
The x-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
y = "<coordinate>"
The y-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
width = "<length>"
The width of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
height = "<length>"
The height of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
xlink:href = "<uri>"
A URI reference.
Animatable: yes.
</pre>

*Are x and y necessary?
*xlink:href instead of url = this is nice.

<pre>
<figure>
<svg:image xlink:href="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===Thoughts===
If we were to recommend a module to import all of SVG, it would be preferable to use only svg:image and to drop tei:graphic entirely (if svg:image does indeed do everything we would need it to do in TEI). But if we don't want to "modulate" SVG (if we just say that we will refer to external SVG files if we need them), do we still want to maintain a separate tei:graphic element?

==The nested grouping of TEI image elements==

===tei:figure/tei:graphic|tei:head|tei:figDesc===

*figure "contains a block containing graphics, illustrations, or figures."
*graphic "indicates the location of an inline graphic, illustration, or figure."
*head "contains any type of heading, for example the title of a section, or the heading of a list, glossary, manuscript description, etc."
*figDesc "(Description of Figure) contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it."

May map to the SVG:

===svg:g/svg:image|svg:title|svg:desc===

*"The 'g' element is a container element for grouping together related graphics elements."
*"The 'image' element indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""
*"Each container element or graphics element in an SVG drawing can supply a 'desc' and/or a 'title' description string where the description is text-only."
*"The 'title' child element to an ... element serves the purposes of identifying the content of the given SVG document fragment."

===Examples===
<pre>
<figure xml:id="id1">
<graphic width="4" height="2" url="fig1.png" mimeType="image/png"/>
<head type="image title">Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>
<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
</svg:g>
</pre>

===Notes===
*svg:g has @id, not @xml:id.
*tei:graphic/@scale and svg:image/@preserveAspectRatio (http://www.w3.org/TR/SVG/coords.html#preserveAspectRatio) are, I believe, similar, but they are Greek to me. I need help here.
*svg:image lacks @mimeType, but is it necessary?
*svg:title does not seem to have a type attribute, but since this element would be used only in reference to image titles, I don't think that this is a problem.
*As noted in a previous section, <figure> may also contain <p> or <text>. There are no equivalent elements in SVG. Would it make sense to include those elements in an SVG group as TEI namespace?

<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
<tei:p>paragraph here</tei:p>
<tei:text>text contained on the image</tei:text>
</svg:g>
</pre>

==Mapping attributes==

@tei:coords (modelled on @mets:coords)

As described in the [http://www.loc.gov/standards/mets/docs/mets.v1-5.html#area METS documentation]:
COORDS: an optional string attribute listing a set of visual coordinates within an image (still image or video frame). The COORDS attribute should be used as in HTML 4.

And in [http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords HTML 4.01]:
This attribute specifies the position and shape on the screen. The number and order of values depends on the shape being defined. Possible combinations:
*rect: left-x, top-y, right-x, bottom-y.
*circle: center-x, center-y, radius. Note. When the radius value is a percentage value, user agents should calculate the final radius value based on the associated object's width and height. The radius should be the smaller value of the two.
*poly: x1, y1, x2, y2, ..., xN, yN. The first x and y coordinate pair and the last should be the same to close the polygon. When these coordinate values are not the same, user agents should infer an additional coordinate pair to close the polygon.

Coordinates are relative to the top, left corner of the object. All values are lengths. All values are separated by commas.

METS defines @mets:coords on <area>. For TEI, it would be nice to have a similar attribute available to "regular" elements, not to a special element. The reasoning is that in many cases, especially when dealing with primary source texts, TEI elements refer not to a text in general but to the text as it appears in a specific physical document. It may not make sense to allow @mets:coords on <p>, but it may make perfect sense to allow it on those elements described in Chapter 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Sources] that relate to a specific physical occurrance:
<pre>
<abbr>
<sic>
<add>
<del>
<hi>
<restore>
<gap>
<damage>
<unclear>
<space>
<fw>
</pre>

SVG defines various attribute values for coordinates. The system is based on a shape (identified by the element), but the attributes vary, so one could use the same attributes in the same element in various combinations to achieve the same result:

rectangle:
<pre>
@svg:x = length
@svg:y = length
(rounded edges:
@svg:rx = length
@svg:ry = length)
</pre>
circle:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the circle.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the circle.
@svg:r = "<length>"
The radius of the circle.
</pre>

ellipse:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the ellipse.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the ellipse.
@svg:rx = "<length>"
The x-axis radius of the ellipse.
@svg:ry = "<length>"
The y-axis radius of the ellipse.
</pre>

polygon:
<pre>
@svg:points = "<list-of-points>"
The points that make up the polygon. All coordinate values are in the user coordinate system.
</pre>

@svg:points seems to me to be very similar to @mets:coords, except that it cannot be used to form a circle (only boundaries with straight edges)

I think that I would prefer to use @mets:coords (or something similar) in TEI, rather than trying to take advantage of the various SVG attributes, at least for the more simple cases.

In more complex instances, I think we need to continue looking at SVG, whether we want to be able to import it in a module or link to external files. Or both.

==tei:binaryObject==

I don't see an equivalent in SVG, but it may be because I don't know where to look.

TEI to SVG

2006-06-08T16:07:01Z

Dot.porter: /* A Quick Look Through the TEI Figures Module */

=A Quick Look Through the TEI Figures Module=

Module: figures (Tables, Formulae, and Graphics, [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html P5 chapter 22])

Elements Defined: table row cell formula figure figDesc graphic binaryObject

The "figure" module really contains three related - but very different - aspects.

#Tables<br/>Elements: table row cell<br/>I don't immediately see anything corresponding to this in SVG. It wouldn't make sense, anyway - tables are really for organizing textual material. Anything else?
#Formulae<br/>Elements: formula<br/>Formula already allows for the inclusion of elements from outside the TEI, although the [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html#id2784077 examples in the guidelines] do not use namespaces, and namespaces are not mentioned in the text. Should we recommend that <figure> require namespaces for elements pulled in from elsewhere? If so, what about (as in the first two examples) when the notation is non-XML? Is @notation really enough?<br/>How will this section generally be used? Will the most common usages be MathML or ChemML (or something similar from the sciences), or perhaps
simpler formulas expressed in available Unicode characters?</br>"By default, a <formula> is assumed to contain character data which is not validated in any way"<br/>Is this really a good idea? This means that, if you have a formula that contains non-standard characters, you would be unable to use gaiji without customization. That seems strange.
#Graphic Images<br/>Elements: figure graphic binaryObject figDesc<br/>The <figure> element is used to contain images, captions, and textual descriptions of the pictures.<br/>The images themselves are specified using the <graphic> element, whose url attribute provides the location of an image.
<pre>
<figure>
<graphic url="Fig1.pdf"/>
</figure>
</pre>
<figure> may also contain <head> (providing a title or heading for the image) <figDesc> (a description of the image) and <p> (commentary or caption, not a description of the image).

"Where the graphic itself contains large amounts of text, perhaps with a complex structure, and perhaps difficult to distinguish from the graphic, the encoder should choose whether to regard the graphic as containing the text (in which case, a nested <text> element may be included within the <figure> element) or to regard the enclosed text as being a separate division of the <text> element in which the graphic appears. In this latter case, an appropriate divn class element may be used for the text represented within the graphic, and the <figure> element embedded within it. The choice will depend to a large degree on the encoder's understanding of the relationship between the graphic and the surrounding text."

So <figure> may also contain <text>.

=TEI Elements and their SVG Equivalents (approx.)=

==tei:graphic and svg:image==

===tei:graphic===
tei:graphic "indicates the location of an inline graphic, illustration, or figure."

attributes: (In addition to global attributes)
<pre>
width The display width of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
height The display height of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
scale A scale factor to be applied to the image to make it the desired display size
Status: Mandatory when applicable
Datatype: data.probability
url The target URL
Status: Mandatory when applicable
Datatype: data.pointer
Values: The name of a URL which provides the image.
mimeType The MIME type
Status: Mandatory when applicable
Datatype: data.word
Values: The MIME type to be used for the object when it is decoded
</pre>
<pre>
<figure>
<graphic url="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===svg:image===

svg:image "indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""

attributes:
<pre>
x = "<coordinate>"
The x-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
y = "<coordinate>"
The y-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
width = "<length>"
The width of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
height = "<length>"
The height of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
xlink:href = "<uri>"
A URI reference.
Animatable: yes.
</pre>

*Are x and y necessary?
*xlink:href instead of url = this is nice.

<pre>
<figure>
<svg:image xlink:href="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===Thoughts===
If we were to recommend a module to import all of SVG, it would be preferable to use only svg:image and to drop tei:graphic entirely (if svg:image does indeed do everything we would need it to do in TEI). But if we don't want to "modulate" SVG (if we just say that we will refer to external SVG files if we need them), do we still want to maintain a separate tei:graphic element?

==The nested grouping of TEI image elements==

===tei:figure/tei:graphic|tei:head|tei:figDesc===

*figure "contains a block containing graphics, illustrations, or figures."
*graphic "indicates the location of an inline graphic, illustration, or figure."
*head "contains any type of heading, for example the title of a section, or the heading of a list, glossary, manuscript description, etc."
*figDesc "(Description of Figure) contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it."

May map to the SVG:

===svg:g/svg:image|svg:title|svg:desc===

*"The 'g' element is a container element for grouping together related graphics elements."
*"The 'image' element indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""
*"Each container element or graphics element in an SVG drawing can supply a 'desc' and/or a 'title' description string where the description is text-only."
*"The 'title' child element to an ... element serves the purposes of identifying the content of the given SVG document fragment."

===Examples===
<pre>
<figure xml:id="id1">
<graphic width="4" height="2" url="fig1.png" mimeType="image/png"/>
<head type="image title">Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>
<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
</svg:g>
</pre>

===Notes===
*svg:g has @id, not @xml:id.
*tei:graphic/@scale and svg:image/@preserveAspectRatio (http://www.w3.org/TR/SVG/coords.html#preserveAspectRatio) are, I believe, similar, but they are Greek to me. I need help here.
*svg:image lacks @mimeType, but is it necessary?
*svg:title does not seem to have a type attribute, but since this element would be used only in reference to image titles, I don't think that this is a problem.
*As noted in a previous section, <figure> may also contain <p> or <text>. There are no equivalent elements in SVG. Would it make sense to include those elements in an SVG group as TEI namespace?

<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
<tei:p>paragraph here</tei:p>
<tei:text>text contained on the image</tei:text>
</svg:g>
</pre>

==Mapping attributes==

@tei:coords (modelled on @mets:coords)

As described in the [http://www.loc.gov/standards/mets/docs/mets.v1-5.html#area METS documentation]:
COORDS: an optional string attribute listing a set of visual coordinates within an image (still image or video frame). The COORDS attribute should be used as in HTML 4.

And in [http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords HTML 4.01]:
This attribute specifies the position and shape on the screen. The number and order of values depends on the shape being defined. Possible combinations:
*rect: left-x, top-y, right-x, bottom-y.
*circle: center-x, center-y, radius. Note. When the radius value is a percentage value, user agents should calculate the final radius value based on the associated object's width and height. The radius should be the smaller value of the two.
*poly: x1, y1, x2, y2, ..., xN, yN. The first x and y coordinate pair and the last should be the same to close the polygon. When these coordinate values are not the same, user agents should infer an additional coordinate pair to close the polygon.

Coordinates are relative to the top, left corner of the object. All values are lengths. All values are separated by commas.

METS defines @mets:coords on <area>. For TEI, it would be nice to have a similar attribute available to "regular" elements, not to a special element. The reasoning is that in many cases, especially when dealing with primary source texts, TEI elements refer not to a text in general but to the text as it appears in a specific physical document. It may not make sense to allow @mets:coords on <p>, but it may make perfect sense to allow it on those elements described in Chapter 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Sources] that relate to a specific physical occurrance:
<pre>
<abbr>
<sic>
<add>
<del>
<hi>
<restore>
<gap>
<damage>
<unclear>
<space>
<fw>
</pre>

SVG defines various attribute values for coordinates. The system is based on a shape (identified by the element), but the attributes vary, so one could use the same attributes in the same element in various combinations to achieve the same result:

rectangle:
<pre>
@svg:x = length
@svg:y = length
(rounded edges:
@svg:rx = length
@svg:ry = length)
</pre>
circle:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the circle.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the circle.
@svg:r = "<length>"
The radius of the circle.
</pre>

ellipse:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the ellipse.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the ellipse.
@svg:rx = "<length>"
The x-axis radius of the ellipse.
@svg:ry = "<length>"
The y-axis radius of the ellipse.
</pre>

polygon:
<pre>
@svg:points = "<list-of-points>"
The points that make up the polygon. All coordinate values are in the user coordinate system.
</pre>

@svg:points seems to me to be very similar to @mets:coords, except that it cannot be used to form a circle (only boundaries with straight edges)

I think that I would prefer to use @mets:coords (or something similar) in TEI, rather than trying to take advantage of the various SVG attributes, at least for the more simple cases.

In more complex instances, I think we need to continue looking at SVG, whether we want to be able to import it in a module or link to external files. Or both.

==tei:binaryObject==

I don't see an equivalent in SVG, but it may be because I don't know where to look.

TEI to SVG

2006-06-07T21:13:55Z

Dot.porter:

=A Quick Look Through the TEI Figures Module=

Module: figures (Tables, Formulae, and Graphics, [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html P5 chapter 22])

Elements Defined: table row cell formula figure figDesc graphic binaryObject

The "figure" module really contains three related - but very different - aspects.

#Tables<br/>Elements: table row cell<br/>I don't immediately see anything corresponding to this in SVG. It wouldn't make sense, anyway - tables are really for organizing textual material. Anything else?
#Formulae<br/>Elements: formula<br/>Formula already allows for the inclusion of elements from outside the TEI, although the [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html#id2784077 examples in the guidelines] do not use namespaces, and namespaces are not mentioned in the text. Should we recommend that <figure> require namespaces for elements pulled in from elsewhere? If so, what about (as in the first two examples) when the notation is non-XML? Is @notation really enough?<br/>"By default, a <formula> is assumed to contain character data which is not validated in any way"<br/>Is this really a good idea? It seems then that it can't contain namespaces at all (rather, it doesn't matter what you put in there).
#Graphic Images<br/>Elements: figure graphic binaryObject figDesc<br/>The <figure> element is used to contain images, captions, and textual descriptions of the pictures.<br/>The images themselves are specified using the <graphic> element, whose url attribute provides the location of an image.
<pre>
<figure>
<graphic url="Fig1.pdf"/>
</figure>
</pre>
<figure> may also contain <head> (providing a title or heading for the image) <figDesc> (a description of the image) and <p> (commentary or caption, not a description of the image).

"Where the graphic itself contains large amounts of text, perhaps with a complex structure, and perhaps difficult to distinguish from the graphic, the encoder should choose whether to regard the graphic as containing the text (in which case, a nested <text> element may be included within the <figure> element) or to regard the enclosed text as being a separate division of the <text> element in which the graphic appears. In this latter case, an appropriate divn class element may be used for the text represented within the graphic, and the <figure> element embedded within it. The choice will depend to a large degree on the encoder's understanding of the relationship between the graphic and the surrounding text."

So <figure> may also contain <text>.

=TEI Elements and their SVG Equivalents (approx.)=

==tei:graphic and svg:image==

===tei:graphic===
tei:graphic "indicates the location of an inline graphic, illustration, or figure."

attributes: (In addition to global attributes)
<pre>
width The display width of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
height The display height of the image
Status: Mandatory when applicable
Datatype: data.outputMeasurement
scale A scale factor to be applied to the image to make it the desired display size
Status: Mandatory when applicable
Datatype: data.probability
url The target URL
Status: Mandatory when applicable
Datatype: data.pointer
Values: The name of a URL which provides the image.
mimeType The MIME type
Status: Mandatory when applicable
Datatype: data.word
Values: The MIME type to be used for the object when it is decoded
</pre>
<pre>
<figure>
<graphic url="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===svg:image===

svg:image "indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""

attributes:
<pre>
x = "<coordinate>"
The x-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
y = "<coordinate>"
The y-axis coordinate of one corner of the rectangular region into which the referenced
document is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.
width = "<length>"
The width of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
height = "<length>"
The height of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of
the element.
Animatable: yes.
xlink:href = "<uri>"
A URI reference.
Animatable: yes.
</pre>

*Are x and y necessary?
*xlink:href instead of url = this is nice.

<pre>
<figure>
<svg:image xlink:href="fig1.png"/>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>

===Thoughts===
If we were to recommend a module to import all of SVG, it would be preferable to use only svg:image and to drop tei:graphic entirely (if svg:image does indeed do everything we would need it to do in TEI). But if we don't want to "modulate" SVG (if we just say that we will refer to external SVG files if we need them), do we still want to maintain a separate tei:graphic element?

==The nested grouping of TEI image elements==

===tei:figure/tei:graphic|tei:head|tei:figDesc===

*figure "contains a block containing graphics, illustrations, or figures."
*graphic "indicates the location of an inline graphic, illustration, or figure."
*head "contains any type of heading, for example the title of a section, or the heading of a list, glossary, manuscript description, etc."
*figDesc "(Description of Figure) contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it."

May map to the SVG:

===svg:g/svg:image|svg:title|svg:desc===

*"The 'g' element is a container element for grouping together related graphics elements."
*"The 'image' element indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The 'image' element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml""
*"Each container element or graphics element in an SVG drawing can supply a 'desc' and/or a 'title' description string where the description is text-only."
*"The 'title' child element to an ... element serves the purposes of identifying the content of the given SVG document fragment."

===Examples===
<pre>
<figure xml:id="id1">
<graphic width="4" height="2" url="fig1.png" mimeType="image/png"/>
<head type="image title">Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
</figure>
</pre>
<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
</svg:g>
</pre>

===Notes===
*svg:g has @id, not @xml:id.
*tei:graphic/@scale and svg:image/@preserveAspectRatio (http://www.w3.org/TR/SVG/coords.html#preserveAspectRatio) are, I believe, similar, but they are Greek to me. I need help here.
*svg:image lacks @mimeType, but is it necessary?
*svg:title does not seem to have a type attribute, but since this element would be used only in reference to image titles, I don't think that this is a problem.
*As noted in a previous section, <figure> may also contain <p> or <text>. There are no equivalent elements in SVG. Would it make sense to include those elements in an SVG group as TEI namespace?

<pre>
<svg:g id="id1">
<svg:image width="4" height="2" xlink:href="fig1.png"/>
<svg:title>Figure One: The View from the Bridge</svg:title>
<svg:desc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</svg:desc>
<tei:p>paragraph here</tei:p>
<tei:text>text contained on the image</tei:text>
</svg:g>
</pre>

==Mapping attributes==

@tei:coords (modelled on @mets:coords)

As described in the [http://www.loc.gov/standards/mets/docs/mets.v1-5.html#area METS documentation]:
COORDS: an optional string attribute listing a set of visual coordinates within an image (still image or video frame). The COORDS attribute should be used as in HTML 4.

And in [http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords HTML 4.01]:
This attribute specifies the position and shape on the screen. The number and order of values depends on the shape being defined. Possible combinations:
*rect: left-x, top-y, right-x, bottom-y.
*circle: center-x, center-y, radius. Note. When the radius value is a percentage value, user agents should calculate the final radius value based on the associated object's width and height. The radius should be the smaller value of the two.
*poly: x1, y1, x2, y2, ..., xN, yN. The first x and y coordinate pair and the last should be the same to close the polygon. When these coordinate values are not the same, user agents should infer an additional coordinate pair to close the polygon.

Coordinates are relative to the top, left corner of the object. All values are lengths. All values are separated by commas.

METS defines @mets:coords on <area>. For TEI, it would be nice to have a similar attribute available to "regular" elements, not to a special element. The reasoning is that in many cases, especially when dealing with primary source texts, TEI elements refer not to a text in general but to the text as it appears in a specific physical document. It may not make sense to allow @mets:coords on <p>, but it may make perfect sense to allow it on those elements described in Chapter 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Sources] that relate to a specific physical occurrance:
<pre>
<abbr>
<sic>
<add>
<del>
<hi>
<restore>
<gap>
<damage>
<unclear>
<space>
<fw>
</pre>

SVG defines various attribute values for coordinates. The system is based on a shape (identified by the element), but the attributes vary, so one could use the same attributes in the same element in various combinations to achieve the same result:

rectangle:
<pre>
@svg:x = length
@svg:y = length
(rounded edges:
@svg:rx = length
@svg:ry = length)
</pre>
circle:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the circle.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the circle.
@svg:r = "<length>"
The radius of the circle.
</pre>

ellipse:
<pre>
@svg:cx = "<coordinate>"
The x-axis coordinate of the center of the ellipse.
@svg:cy = "<coordinate>"
The y-axis coordinate of the center of the ellipse.
@svg:rx = "<length>"
The x-axis radius of the ellipse.
@svg:ry = "<length>"
The y-axis radius of the ellipse.
</pre>

polygon:
<pre>
@svg:points = "<list-of-points>"
The points that make up the polygon. All coordinate values are in the user coordinate system.
</pre>

@svg:points seems to me to be very similar to @mets:coords, except that it cannot be used to form a circle (only boundaries with straight edges)

I think that I would prefer to use @mets:coords (or something similar) in TEI, rather than trying to take advantage of the various SVG attributes, at least for the more simple cases.

In more complex instances, I think we need to continue looking at SVG, whether we want to be able to import it in a module or link to external files. Or both.

==tei:binaryObject==

I don't see an equivalent in SVG, but it may be because I don't know where to look.

FacsimileMarkup

2006-06-07T20:18:46Z

Dot.porter: /* Tasks */

== Introduction ==

The Facsimile task force / SIG is about markup of facsimile images with correspondence to parts of the text.

Conal is going to produce some quick samples.

== Tasks ==

# collate [[LegacyFacsimileMarkup|existing markup]], including simple pb/@url style markup at one extreme and METS at the other
# develop straw man facsimile modules:
## a [[StrawManFacsimileMarkup|high-end markup]]:
### list of facsimile images,
### each image linked to a locations in the text by a typed link (e.g. thumbnail, display...)
### see METS structure map
### link between text and fragments ''within'' an image? (e.g. svg region) Requires another indirection
## a low-end markup: <pb n="1" url="page-1.jpg"/>
## other widely-used style of markup?
### use ODD equiv system to map low-end to the high-end markup?
# [[TEI_to_SVG|Investigate relations/mapping between the TEI and SVG]].

[[Category:SIG]]

LegacyFacsimileMarkup

2006-06-07T14:42:31Z

Dot.porter: /* Conclusions */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image).

If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

A TEI element can be associated with a rectangular region of an image by encoding the co-ordinates of the region's corners as an attribute of that element. The EPT allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg xmlns="http://www.w3.org/2000/svg">

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

=Conclusions=
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Supports most image file formats (jpeg, tiff, gif, bmp)
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-06T20:31:38Z

Dot.porter: /* P5 Guidelines, 22.3 (Specific Elements for Graphic Images) */

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image).

If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

To store coordinates from an image that correspond with a given piece of XML content, the EPT simply allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg>

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

==Conclusions==
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Limited image file support
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-02T18:56:15Z

Dot.porter:

This page includes some examples of different approaches for facsimile (image-based) markup.

=P5 Guidelines, 22.3 (Specific Elements for Graphic Images)=

The P5 Guidelines describe four elements for including graphic images in TEI documents:

*figure: contains a block containing graphics, illustrations, or figures.
*graphic: indicates the location of an inline graphic, illustration, or figure.
*binaryObject: provides encoded binary data representing an inline graphic or other object.
*figdesc: contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it.

<figure> is the parent element for the others. <figure> may also contain <head> (a header or title) and <p> (commentary or caption, not a description of the image).

If a graphic contains a large amount of text, and the editor determines that the graphic actually contains that text (the text is not part of the surrounding text), <figure> may contain <text>.

==Linking Text & Image in P5==

The Guidelines describes a number of ways to link text and image using methods described fully in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment].

===Linking thumbnails to full-resolution images===
To link thumbnails to larger images, create a <ref> tag that points to the xml:id of the corresponding figure. Include the thumbnail as a graphic in the <ref>

<pre>
<ref target="#IM1">Click here
<graphic url="fig1th.png"/>
for enlightenment
</ref>
<figure xml:id="IM1">
<graphic url="fig1.jpg"/>
</figure>
</pre>

===Associate images/parts of images with text elements===
Use the linking mechanism described in [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html 14 Linking, Segmentation, and Alignment] to link together a figure (the example in the guidelines uses an external SVG file, parts of which are identified with xml:ids) and TEI elements (which are likewise identified using xml:ids).

First, we use pointers to the graphic image:
<pre>
<ptr xml:id="PD1" target="Fig1.svg#object1"/>
<ptr xml:id="PD2" target="Fig1.svg#object2"/>
</pre>

These point inside the SVG file:
<pre>
<svg width="8cm" height="3cm" viewBox="2 1 8 3">
<g id="object1">
<ellipse style="fill: #ffffff" cx="3.875" cy="3.025" rx="1.175" ry="1.175"/>
</g>
<g id="object2">
<rect style="fill: #a81616" x="7.8" y="1.9" width="2.17581" height="2.24833"/>
</g>
</svg>
</pre>

Areas in the TEI file are also uniquely identified:
<pre>
<div1 type="chapter" xml:id="CHAP1">


</div1>
<div1 type="chapter" xml:id="CHAP2">


</div1>
</pre>

Then we can use a linkgroup to pull this all together:
<pre>
<linkGrp type="callout">
<link targets="#CHAP1 #PD1"/>
<link targets="#CHAP2 #PD2"/>
</linkGrp>
</pre>

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

To store coordinates from an image that correspond with a given piece of XML content, the EPT simply allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg>

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

==Conclusions==
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Limited image file support
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-01T16:26:53Z

Dot.porter: /* What is METS? */

This page includes some examples of different approaches for facsimile (image-based) markup.

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

To store coordinates from an image that correspond with a given piece of XML content, the EPT simply allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg>

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard (http://www.loc.gov/standards/mets/)
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

==Conclusions==
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Limited image file support
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-01T15:42:19Z

Dot.porter: /* Conclusions */

This page includes some examples of different approaches for facsimile (image-based) markup.

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

To store coordinates from an image that correspond with a given piece of XML content, the EPT simply allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg>

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

==Conclusions==
*Draft Recommendations for TEI Digital Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Limited image file support
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-01T15:41:50Z

Dot.porter: /* Method used by the UVic Image Markup Tool: Annotate images */

This page includes some examples of different approaches for facsimile (image-based) markup.

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

To store coordinates from an image that correspond with a given piece of XML content, the EPT simply allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Stated goals of the Tool:

*be simple for novices to use
*load and display a wide variety of different image formats
*allow the user to specify arbitrary rectangles on the image, and associate them with annotations
*allow such rectangles to overlap if the user wishes
*provide mechanisms for bringing overlapped rectangles to the front easily
*allow annotations to be grouped into categories, distinguished by name and appearance, to allow different classes of annotation
*require no significant knowledge of XML or TEI
*allow the use of XML code if the user wishes
*save data in an XML file which conforms to a TEI P5-based schema
*reload data from its own files
*generate a simple "Web view" of the data for display in a browser
*come packaged with an installer, Help file, and basic tutorial
*be simple for novices to use!

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg>

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

==Conclusions==
*Draft Recommendations for TEI Digital�Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Limited image file support
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

File:Uvic-fig3.gif

2006-06-01T15:39:51Z

Dot.porter: This is a screenshot from a PowerPoint presentation by Dot Porter. It shows the browser view of output from the UVic Image Markup Tool. The manuscript facsimile is from BL Cotton Claudius B iv., provided to Ms. Porter by Ben Withers, University of Kentuck

This is a screenshot from a PowerPoint presentation by Dot Porter. It shows the browser view of output from the UVic Image Markup Tool. The manuscript facsimile is from BL Cotton Claudius B iv., provided to Ms. Porter by Ben Withers, University of Kentucky Art

LegacyFacsimileMarkup

2006-06-01T15:37:09Z

Dot.porter: /* Method used by the UVic Image Markup Tool: Annotate images */

This page includes some examples of different approaches for facsimile (image-based) markup.

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

To store coordinates from an image that correspond with a given piece of XML content, the EPT simply allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg>

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

==Conclusions==
*Draft Recommendations for TEI Digital�Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Limited image file support
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-01T15:36:51Z

Dot.porter: /* Method used by the UVic Image Markup Tool: Annotate images */

This page includes some examples of different approaches for facsimile (image-based) markup.

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

To store coordinates from an image that correspond with a given piece of XML content, the EPT simply allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg>

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

[[Image:Uvic-fig2.gif|left|thumb|Screenshot from the UVic IMT interface.]]
[[Image:Uvic-fig3.gif|thumb|Browser view of output from the UVic IMT.]]

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

==Conclusions==
*Draft Recommendations for TEI Digital�Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Limited image file support
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

File:Uvic-fig2.gif

2006-06-01T15:34:59Z

Dot.porter: This is a screenshot from a PowerPoint presentation by Dot Porter. It shows a screenshot of the UVic Image Markup Tool interface. The manuscript facsimile is from BL Cotton Claudius B iv., provided to Ms. Porter by Ben Withers, University of Kentucky Art

This is a screenshot from a PowerPoint presentation by Dot Porter. It shows a screenshot of the UVic Image Markup Tool interface. The manuscript facsimile is from BL Cotton Claudius B iv., provided to Ms. Porter by Ben Withers, University of Kentucky Art Department.

LegacyFacsimileMarkup

2006-06-01T15:33:25Z

Dot.porter: /* Method used by the UVic Image Markup Tool: Annotate images */

This page includes some examples of different approaches for facsimile (image-based) markup.

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

To store coordinates from an image that correspond with a given piece of XML content, the EPT simply allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg>

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

[[Image:Uvic-fig1.gif|left|thumb|Example of the coordinate system used by the UVic IMT.]]

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

==Conclusions==
*Draft Recommendations for TEI Digital�Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Limited image file support
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

File:Uvic-fig1.gif

2006-06-01T15:31:32Z

Dot.porter: This is a screenshot from a PowerPoint presentation by Dot Porter. It shows an example of the coordinate system used by the UVic Image Markup Tool. The manuscript facsimile is from BL Cotton Claudius B iv., provided to Ms. Porter by Ben Withers, Univ

This is a screenshot from a PowerPoint presentation by Dot Porter. It shows an example of the coordinate system used by the UVic Image Markup Tool. The manuscript facsimile is from BL Cotton Claudius B iv., provided to Ms. Porter by Ben Withers, Univ

LegacyFacsimileMarkup

2006-06-01T15:28:35Z

Dot.porter: /* Method used by the UVic Image Markup Tool: Annotate images */

This page includes some examples of different approaches for facsimile (image-based) markup.

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

To store coordinates from an image that correspond with a given piece of XML content, the EPT simply allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG (http://www.w3.org/Graphics/SVG/), to create a system for annotating images.

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg>

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

==Conclusions==
*Draft Recommendations for TEI Digital�Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Limited image file support
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-01T15:24:23Z

Dot.porter:

This page includes some examples of different approaches for facsimile (image-based) markup.

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

To store coordinates from an image that correspond with a given piece of XML content, the EPT simply allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG, to create a system for annotating images.

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg>

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

==Conclusions==
*Draft Recommendations for TEI Digital�Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Limited image file support
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

LegacyFacsimileMarkup

2006-06-01T15:22:34Z

Dot.porter: /* Attribute for Coordinates */

This page includes some examples of different approaches for facsimile (image-based) markup.

=Draft Recommendations for TEI Digital Facsimiles=

http://users.ox.ac.uk/~lou/wip/digfax.html

This document, authored by Richard Gartner and Lou Burnard and last updated in 2001, outlines ways to use TEI to represent three types of digital objects:

*complete digital transcriptions of the content of manuscript or print originals (possibly including illustrations as well as text)
*collections of digitized page images (''digital facsimiles'') intended for use as surrogates for complete manuscript or print originals
*digital objects (''digital editions'') combining both page facsimiles and transcriptions, possibly also including layers of editorial annotation

The authors attempt to address these areas of concern:

*the need to distinguish images of a manuscript or print source from images located within it;
*the need to support multiple formats of a single image;
*the need to associate metadata at different levels (e.g. collection level, item level);
*the need to associate transcription and facsimile in a standard way;
*the need to define practices which can be used equally well in both SGML and XML environments;
*the desire to avoid special purpose rules which assume nonstandard or ad hoc processing rules.

==Case 1: Transcription==

Updated to cite chapters in P5:

The content of a transcription should be marked up as a single <TEI> element using the standard TEI elements <text>, <body>, <div>, etc. from the TEI core tag sets.

Follow the Guidelines chapters 18 [http://www.tei-c.org/release/doc/tei-p5-doc/html/PH.html Transcription of Primary Resources] and 13 [http://www.tei-c.org/release/doc/tei-p5-doc/html/MS.html Manuscript Description].

If the source contains "significant illustrative material", use <figure> (and children) from Guidelines chapter 22 [http://www.tei-c.org/release/doc/tei-p5-doc/html/FT.html Tables, Formulae, and Graphics] to insert illustrations in their proper location in the transcript.

[[Image:Teidr-fig1.gif|left|thumb|Example of the TEI <figure> element.]]

<pre>
<lb n="12"/>feond mid his geferum eallum. Feollon þa ufon
<lb n="13"/>of heofnum þurhlonge swa þreo niht and da
<lb n="14"/>gas, þa englas of heofnum on helle, and heo ealle
<lb n="15"/>forsceop drihten to deoflum.

<figure>
<head>Fall of the Angels</head>
<figDesc>Above, God, cross-nimbed, beardless, and holding a closed book,
accompanied by three angels, turns and gestures toward three angels on
the left, one of whom (Lucifer?) holds a palm frond ...</figDesc>
</figure>

<pb n="17"/>
</pre>

==Case 2: Digital Facsimile==

Should be marked as a separate <TEI> element. TEI structural tags may be used, but need not be, especially if differences between textual structure and physical structure cause overlap.

Each distinct image making up the facsimile should be encoded as a <figure> element, arranged in the normal reading sequence of the facsimile. The appropriate milestone element (<pb/> or <cb/>) should be used at the appropriate place in the facsimile.

[[Image:Teidr-fig2.gif|left|thumb|Example of the TEI <figure> element with reference to manuscript folio number.]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
</figure>
<pb n="17"/>
<figure n="17">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
</figure>
</pre>

<figure> elements may be self-nested to show that one image logically contains others (in cases where two image fit together to form one larger image).

[[Image:Teidr-fig3.gif|left|thumb|Example of nesting TEI <figure> elements.]]

<pre>
<figure n="16">
<figDesc>
<figure>
<figDesc>[Page 16: 15 lines of text (detail of upper part)]</figDesc>
</figure>
<figure>
<figDesc>[Page 16: Image of "Fall of Angels" (Ohlgren 16.11) (detail of lower part)</figDesc>
</figure>
</figDesc>
</figure>
</pre>

==3: Techniques for Referencing Images==

Recommends declaring the file containing the image as an external entity and then referencing that entity using the "entity" attribute in <figure>. This approach depends on the use of the DTD (no longer practical given the TEI's move towards using the RelaxNG schema), and relies on an attribute that is no longer included in P5.

In TEI P5 there are also two new elements, <graphic> and <binaryObject> which may be used to represent image references or images respectively. These permit the encoding of figures containing multiple images, for example. The <graphic> element has a "url" attribute which enables the association of a <figure> with its corresponding image file. The recommendations in Gartner and Burnard need to be revised substantially in this respect.

[[Image:Teidr-fig4.gif|left|thumb|Example of the TEI <graphic> element with reference to image file URL]]

<pre>
<pb n="16"/>
<figure n="16">
<figDesc>[Page 16: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.11)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/16.jpg"/>
</figure>
<pb n="17"/>
<figure n="17" url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg">
<figDesc>[Page 17: 15 lines of text followed by image of "Fall of Angels"
(Ohlgren 16.12)]</figDesc>
<graphic url="http://image.ox.ac.uk/images/bodleian/msjunius11/17.jpg"/>
</figure>
</pre>

This approach is simple, though it is not practical if one has multiple images of the same page in various resolutions

<pre>
<figure>
<head>Figure One: The View from the Bridge</head>
<figDesc>A Whistleresque view showing four
or five sailing boats in the foreground, and a
series of buoys strung out between them.</figDesc>
<graphic url="http://www.somewhere.eu/fig1.png" scale="0.5"/>
</figure>
</pre>

Other options mentioned in the recommendation: Xlink or Xinclude.

==4: Aligning transcription and fascimile==

The TEI Guidelines propose a number of methods for aligning parts of a document (see www.tei-c.org/Guidelines/SA). These may be briefly summarized as follows
*use the @corresp attribute to assert that a <pb> (or other reference point) in the transcription corresponds with a <pb> in the facsimile (or the reverse);
*alternatively, use a stand-off <link> element to assert the association between the two <pb> elements;
*for cross-document linking, an intermediate <xptr> may be used as the target.
(see [http://www.tei-c.org/release/doc/tei-p5-doc/html/SA.html Chapter 14 Linking, Segmentation, and Alignment]).

[[Image:Teidr-fig5.gif|left|thumb|Example of linking image file with transcription using @corresp on <pb>.]]

=Method used by the Edition Production Technology (EPT): Link text and images=

The EPT (now EPPT: http://beowulf.engl.uky.edu/~eft/EPPT-Demo.html) uses a system combining a Image Catalog combined with a special attribute for coordinates to enable linking between text and image. For more details, see here: http://beowulf.engl.uky.edu/~kiernan/eBoethius/tech.htm#tech.

==Image Catalog==

The Image Catalog is a simple XML file that consists of lists of image files organized by category. There is one category for every set of image files for a given source.
*daylight (images taken under regular lighting)
*ultraviolet (images taken under ultraviolet lighting)
*microfilm (images scanned from microfilm)

Categories are assigned unique IDs.

Within each category, the user associates each file with an ID that is ''unique within the category''. IDs will repeat across categories. Essentially, these IDs associate the files with the same object, which may be represented by multiple images.

[[Image:Ept-fig1.gif|left|thumb|Example of the EPT Image Catalog configuration file.]]

<pre>
<category name="daylight" id="d">
<file name="aih0244-JPG.jpg" id="5v" />
<file name="aih0245-JPG.jpg" id="6r" />
<file name="aih0242-JPG.jpg" id="6v" />
</category>
<category name="ultraviolet" id="u">
<file name="uv-5v.jpg" id="5v" />
<file name="uv-6r.jpg" id="6r" />
<file name="uv-6v.jpg" id="6v" />
</category>
<category name="microfilm" id="m">
<file name="mf-5v.jpg" id="5v" />
<file name="mf-6r.jpg" id="6r" />
<file name="mf-6v.jpg" id="6v" />
</category>
</pre>

The file IDs from image catalog are then associated with an attribute within the text markup itself. The attribute used is configured by the user; for the Electronic Boethius, we used the attribute ''n'' in the element ''<fol>'' (folio). The content for each folio is thus associated with the correct image files (from every category):

<pre>
<fol n="5v">
</pre>
points to
<pre>
<daylight><file id="5v"/>
</pre>
and
<pre>
<ultraviolet><file id=“5v”/>
</pre>
and
<pre>
<microfilm><file id=“5v”/>
</pre>

[[Image:Ept-fig2.gif|left|thumb|Example of EPT Image Catalog links image files with sections of text.]]

==Attribute for Coordinates==

To store coordinates from an image that correspond with a given piece of XML content, the EPT simply allows the user to assign an attribute (Electronic Boethius uses ''coords''). In whatever elements that attribute is defined, the coordinates, selected by the editor, are automatically entered by the software. The ID assigned to the categories in the Image Catalog are appended to the beginning of the coordinates.

[[Image:Ept-fig3.gif|left|thumb|Example of @coords on <figure>.]]
[[Image:Ept-fig4.gif|thumb|Screenshot of EPPT]]
<pre>
<damage coords="d:1058,738,1093,798">
</pre>

=Method used by the UVic Image Markup Tool: Annotate images=

The UVic Image Markup Tool (http://www.tapor.uvic.ca/~mholmes/image_markup/) uses TEI, modified to allow for the inclusion of SVG, to create a system for annotating images.

Simplified example from the IMT web:
<pre>
<TEI>
<teiHeader>

</teiHeader>
<text>
<body>

<div type="imtAnnotatedImage">
<svg>

<image>

</image>
<rect>

</rect>
</svg>
<div type="imtAnnotationLayer">

</div>
</div>

</body>
</text>
</TEI>
</pre>

Using this system, a user can annotate many sections of a single image. Unlike the EPT system described above, in which the coordinates are stored directly in the element, here the image coordinates are stored in a separate section and linked to the annotations using unique IDs (''svg:id'' in ''<rect>'') to link the areas to the annotation content (''n'' in ''<div type="imtAnnotationLayer">'').

<pre>
<div type="imtAnnotatedImage" xml:id="NB-B-17328">
<svg xmlns="http://www.w3.org/2000/svg">
<image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="NB-B-17328.jpg" width="5060" height="6025"/>
<title>NB-B-17328.jpg</title>
<desc>5060 x 6025</desc>
<rect svg:id="NB-B-17328_0" x="4287" y="1412" width="580" height="426" style="3" color="#ff0000"/>
<rect svg:id="NB-B-17328_1" x="4067" y="2019" width="720" height="747" style="3" color="#ff0000"/>
</svg>
<div type="imtAnnotationLayer" n="NB-B-17328_0">
<head>la chandelle allume la découverte.</head>
<p>Il a trouvé la cache.</p>
</div>
<div type="imtAnnotationLayer" n="NB-B-17328_1">
<head>le couvercle de la malle</head>
<p>Il est pris sans vert</p>
</div>
</pre>

(TEI examples from the UVic file example: http://www.tapor.uvic.ca/~mholmes/image_markup/Amant.xml)

For more details on the TEI/SVG used by the IMT, see here: http://www.tapor.uvic.ca/~mholmes/image_markup/xml.php

=Using METS to link text and image=

==What is METS?==
*Metadata Encoding and Transmission Standard
*“a standard for encoding … metadata regarding objects within a digital library”
*Centered at the Library of Congress
*Developed out of the metadata specs from the LOC’s “Making of America 2” project (MOA2)
*Developed by librarians and archivists, for librarians and archivists
*Accepted standard with a broad user base (http://sunsite.berkeley.edu/mets/registry/)
*Unrelated to TEI
<blockquote>
While a library may record descriptive metadata regarding a book in its collection, the book will not dissolve into a series of unconnected pages if the library fails to record structural metadata regarding the book's organization, nor will scholars be unable to evaluate the book's worth if the library fails to note that the book was produced using a Ryobi offset press.” (METS: An Overview and Tutorial)
</blockquote>

==Why METS?==
*System to organize disparate parts and relate files (and pieces of files):
**Areas on images correspond with sections of text
**Areas on images relate to one another
**Areas of text relate to one another
*METS provides sections for defining the logical and/or physical structure of the digital object
**File Section (fileSec)
**Structural Map (structMap)

==File Section==
“lists all files containing content which comprise the electronic versions of the digital object.”
*Similar to the EPT Image Catalog

==Within the FileSec==
*FileSec consists of Groups of File Locaters
**File Group: contains related files
<blockquote><fileGrp USE="facsimile"></blockquote>
**File: assigns the individual files unique identifiers
<blockquote><file ID="C-Clbiv-69v" MIMETYPE="image/tiff"></blockquote>
**File Locater: points to the location of the file, using xlink syntax
<blockquote><FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.jpg"/></blockquote>

===Example (Images)===
<pre>
<fileGrp USE="facsimile">
<file ID="C-Clbiv-69v" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-69v.tif"/>
</file>
<file ID="C-Clbiv-70r" MIMETYPE="image/tiff">
<FLocat LOCTYPE="URN" xlink:href="images/C-Clbiv-70r.tif"/>
</file>
…
</fileGrp>
</pre>

===Example (Transcript)===
<pre>
<fileGrp USE="transcript">
<file ID="id-pref-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/pref-genesis.xml"/>
</file>
<file ID="id-genesis" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/genesis.xml"/>
</file>
<file ID="id-exodus" MIMETYPE="text/xml">
<FLocat LOCTYPE="URN" xlink:href=“transcription/exodus.xml"/>
</file>
…
</fileGrp>
</pre>

==Structural Map==
“outlines a hierarchical structure for the digital library object, and links the elements of that structure to content files … that pertain to each element.”
*Organization may be logical or physical
*A single METS file may contain multiple structural maps

==Within the StructMap==
*StructMap consists of organizational divisions, that may nest
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
...
</div>
</div>
</pre>
*The divisions contain pointers to the files, and areas of files, indexed in the fileSec
<pre>
<div LABEL="Genesis" ORDER="2">
<div LABEL="Folio 1v" ORDER="2">
<fptr FILEID="C-Clbiv-1v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="1v.32" END="1v.38"/>
</fptr>
</div>
</div>
</pre>

===Example (Basic)===
The first file pointer references the corresponding image file, while the second one references the corresponding line range (BEGIN and END) in the XML file (these are the values of, for example, @xml:id on <lb/>
<pre>
<div LABEL="Folio 69v" ORDER=“139">
<fptr FILEID="C-Clbiv-69v"/>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.12"/>
</fptr>
</div>
<div LABEL="Folio 70r" ORDER="140">
<fptr FILEID="C-Clbiv-70r"/>
<fptr>
<area FILEID="id-genesis" BEGIN="70r.1" END="70r.38"/>
</fptr>
</div>
</pre>

===Example (Advanced)===
*<area>: reference coordinates within an image file.
**especially useful for extensively illustrated manuscripts
*create links between text and image.
**@COORDS in <area> for image files
**@BEGIN and @END in <area> for XML/TEI files
*Simplifies encoding:
**no need to define @COORDS to clutter up the TEI;
**no need to find a place to store a linking section in the TEI file
**no need to use the SVG namespace
**separate the objects (image and XML files) from the indexing of their relationships with one another

[[Image:mets-fig1.gif|left|thumb|Advanced Example of using METS and TEI to link sections of text with sections of image]]

<pre>
<div LABEL="Folio 69v" ORDER="139">
<div LABEL="Annotation 1"
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="40,12,975,121"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.annot.1"/>
</fptr>
</div>
<div LABEL="Illustration 1">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="96,87979,572"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.illus.1"/>
</fptr>
</div>
<div LABEL="Text">
<fptr>
<area FILEID="C-Clbiv-69v" COORDS="71,531,978,859"/>
</fptr>
<fptr>
<area FILEID="id-genesis" BEGIN="69v.1" END="69v.9"/>
</fptr>
</div>
</div>
</pre>

==Conclusions==
*Draft Recommendations for TEI Digital�Facsimiles
**Not robust
**No specific image/text linking
**Need to be updated for TEI P5
*Edition Production Technology (EPT)
**Designed for textual annotation, but can annotate illustrations as well
**Markup schema is not defined
**Complex
**Dependent on editing software
**Limited image file support
**No visualization outside of the editing environment
*UVic Image Annotation Tool
**Simple
**Annotates via description – no “text encoding” (i.e., cannot include in an electronic transcription)
**Based on accepted standards
**Markup schema is defined (extended TEI + SVG)
**Visualization through SVG-enabled browser
*METS
**Very complex
**Objects separate from indexes
**Flexible – can link many textual and image sections (Venetus A – link main text and several layers of annotations)
**No visualization (yet) for the more advanced image-text links

File:Ept-fig4.gif

2006-06-01T15:20:56Z

Dot.porter: This is a screenshot from a PowerPoint presentation by Dot Porter. It shows a screenshot from the EPPT illustrating image-text linking. The manuscript facsimile is from BL Cotton Claudius B iv., provided to Ms. Porter by Ben Withers, Univ

This is a screenshot from a PowerPoint presentation by Dot Porter. It shows a screenshot from the EPPT illustrating image-text linking. The manuscript facsimile is from BL Cotton Claudius B iv., provided to Ms. Porter by Ben Withers, Univ