TEITOK

Metadata Helper

This page describes some recommended fields for the teiHeader metadata, as used in various TEITOK projects. TEITOK files do not always follow TEI to the letter, as is explained here. The top gives the structure with its default interpretations, where items in red (and everything below them) are not (currently) standard TEI elements, while items in blue are standard TEI elements used differently. The bottom gives a list of defined fields with their explanation. In both, you can see the standard TEI definition for each field by moving your mouse over it. Clicking in the list will bring you to the corresponding page in the TEI P5 guidelines.

Title of the (digital) text Author of the original text Person responsible for the transcription of this text Person responsible for the revision of this text Person responsible for the normalization of this text Person responsible for the POS tagging of this text Funding body for the text or project Unique ID for this manuscript Institution where the manuscript is held Repository the manuscript belongs to Collection the manuscript belongs to Place/Settlement where the manuscript is held

Summary of the content of a manuscript

Description of the support of a manuscript Numbering system of the manuscript pages Description of the hands in a manuscript Description of the history of a manuscript Description of the recording Date the recording was made Monograph author Monograph title Monograph edition Monograph publisher Monograph publication place Monograph publication date Name of the student/speaker/author Birth place of the student/speaker/author Date of birth of the student/speaker/author Death place of the student/speaker/author Date of death of the student/speaker/author Native language of the student/speaker/author Other languages spoken by the student/speaker/author as native language Other languages learnt by the student/speaker/author as non-native language Previous course taken by the student for this L2 Country where student spent in a country the this L2 is spoken Proficiency level the student is training for Age (in years) of the student/speaker/author Occupation of the student/speaker/author Place of residence of the student/speaker/author Nationality of the student/speaker/author Language in which this text is written Domain of the text Description of the task (as given to the student) Institution where the current L2 course is given Genre of the task Extent of the task (typically in words) Settings of the task (time-limited, with reference material, etc.) Type of task Relevant background details about the task Date the task was handed in Date (year) this text was written (when there are multiple relevant dates) Place this text was written Type of text Title of the project Leader/coordinator of the project Description of the project Editorial principles used in the transcription

Collapsable tree of recommended teiHeader

fileDesc: Description of the digital file
- titleStmt: Information about the title of this work and those responsible for its content
  - title:
    Title of the (digital) text
    @fldid: title
  - author:
    Author of the original text
    @fldid: author
  - respStmt
    - resp[@n="transcription"]:
      Person responsible for the transcription of this text
      
      @fldid: transcription
    - resp[@n="revision"]:
      Person responsible for the revision of this text
      
      @fldid: revision
    - resp[@n="normalization"]:
      Person responsible for the normalization of this text
      
      @fldid: normalization
    - resp[@n="tagging"]:
      Person responsible for the POS tagging of this text
      
      @fldid: tagging
  - funder:
    Funding body for the text or project
    @fldid: funder
- sourceDesc: Description of the source from which this digital text was derived
  - msDesc: Description of a manuscript this text is transcribed from
    - msIdentifier
      - idno: Unique ID for this manuscript
        
        @fldid: msid
      - institution: Institution where the manuscript is held
        
        @fldid: msinstitution
      - repository: Repository the manuscript belongs to
        
        @fldid: msrepository
      - collection: Collection the manuscript belongs to
        
        @fldid: mscollection
      - settlement: Place/Settlement where the manuscript is held
        
        @fldid: mssettlement
    - msContents
      - summary: Summary of the content of a manuscript
        
        @fldid: mssummary
    - physDesc
      - objectDesc
        
        supportDesc
        
        support: Description of the support of a manuscript
        
        @fldid: mssupport
        
        foliation: Numbering system of the manuscript pages
        
        @fldid: msfoliation
        
        @form: Physical form of a manuscript
      - handDesc: Description of the hands in a manuscript
        
        @fldid: mshands
    - history
      - origin: Description of the history of a manuscript
        
        @fldid: msorigin
  - recordingStmt: The description of an audio/video recording for this file
    - recording
      - media:
        
        @url: Filename of the audio file (url or local file)
      - desc: Description of the recording
        
        @fldid: recdesc
      - date: Date the recording was made
        
        @fldid: recdate
  - biblStruct
    - monogr: Information about a monograph this text was transcribed from
      - author: Monograph author
        
        @fldid: monauthor
      - title: Monograph title
        
        @fldid: montitle
      - edition: Monograph edition
        
        @fldid: monedition
      - imprint
        
        publisher: Monograph publisher
        
        @fldid: monpublisher
        
        pubPlace: Monograph publication place
        
        @fldid: monplace
        
        date: Monograph publication date
        
        @fldid: mondate
profileDesc: description of non-bibliographic aspects of the text
- particDesc: Description of the participants in this text
  - listPerson
    - person
      - name: Name of the student/speaker/author
        
        @fldid: personname
      - birth
        
        placeName: Birth place of the student/speaker/author
        
        @fldid: birthplace
        @geo: Geolocation coordinates (lat lng) of the birth place of the student/speaker/author
        
        date: Date of birth of the student/speaker/author
        
        @fldid: birthdate
        
        @fldid: birth
        @when: Year of birth of the student/speaker/author
      - death
        
        placeName: Death place of the student/speaker/author
        
        @geo: Geolocation coordinates (lat lng) of the death place of the student/speaker/author
        
        date: Date of death of the student/speaker/author
        
        @when: Year of death of the student/speaker/author
      - langKnowledge: Languages the author/student/speaker knows
        
        langKnown[@n="first"]: Native language of the student/speaker/author
        
        @tag: ISO 639-2 code for the native language of the student/speaker/author
        
        langKnown[@n="native"]: Other languages spoken by the student/speaker/author as native language
        
        langKnown[@n="foreign"]: Other languages learnt by the student/speaker/author as non-native language
      - langLearning: Description of the language learning circumstances (Learner corpus)
        
        duration:
        
        @months: Duration (in months) the student has been learning this L2
        
        previous: Previous course taken by the student for this L2
        
        stay: Country where student spent in a country the this L2 is spoken
        
        @duration: Duration (in months) the student spent in a country the this L2 is spoken
        
        proficiency: Proficiency level the student is training for
        
        @lang: ISO 639-2 code for the language the student is learning
      - sex:
        
        @fldid: sex
        @type: gender of the student/speaker/author (m/f)
      - age: Age (in years) of the student/speaker/author
        
        @fldid: age
      - occupation: Occupation of the student/speaker/author
        
        @fldid: personoccupation
      - residence: Place of residence of the student/speaker/author
        
        @fldid: personresidence
      - nationality: Nationality of the student/speaker/author
        
        @fldid: nationality
        @key: ISO 3166 code for the nationality of the student/speaker/author
      - @id: Unique ID for the student/speaker/author of this text
- langUsage: Language(s) used in this text
  - language:
    Language in which this text is written
    @fldid: textlang
    @ident: ISO 639-2 code for the language in which this text is written
    @dir: Writing direction of the text
- textDesc: Situational parameters for this text
  - channel:
    @fldid: textchannel
    @mode: Written or Spoken
  - domain:
    Domain of the text
    @fldid: textdomain
- taskDesc: Description of the task this text was created for
  - task
    - title:
      Description of the task (as given to the student)
      
      @fldid: tasktitle
    - affiliation:
      Institution where the current L2 course is given
      
      @fldid: taskaffiliation
    - genre:
      Genre of the task
      
      @fldid: taskgenre
    - extent:
      Extent of the task (typically in words)
      
      @fldid: taskextent
    - taskSetting:
      Settings of the task (time-limited, with reference material, etc.)
      
      @fldid: tasksetting
    - type:
      Type of task
      
      @fldid: tasktype
    - desc:
      Relevant background details about the task
      
      @fldid: taskdesc
    - date:
      Date the task was handed in
      
      @fldid: taskdate
      @when: Year the task was handed in
    - @id: Unique ID for the task of this text
- settingDesc: Description of the context of the text
  - setting
    - date:
      Date (year) this text was written (when there are multiple relevant dates)
      
      @fldid: textdate
      @when: Best guess year for this text
    - name[@n="place"]:
      Place this text was written
      
      @fldid: textplace
      @geo: Geolocation (lat lng) for the place where this manuscript was written
- textClass:
  Type of text
  - @fldid: textclass
encodingDesc: Relationship between the electronic text and the source
- projectDesc
  - title:
    Title of the project
    @fldid: projecttitle
  - leader:
    Leader/coordinator of the project
    @fldid: projectleader
  - desc:
    Description of the project
    @fldid: projectdesc
  - @id: Unique ID for the project (to link to external descriptions)
- editorialDecl:
  Editorial principles used in the transcription
  - @fldid: editorialdecl

List of recommendable fields

XPath

Description

/TEI/teiHeader/fileDesc/titleStmt/title

Title of the (digital) text

/TEI/teiHeader/fileDesc/titleStmt/title/@fldid

title

/TEI/teiHeader/fileDesc/titleStmt/author

Author of the original text

/TEI/teiHeader/fileDesc/titleStmt/author/@fldid

author

/TEI/teiHeader/fileDesc/titleStmt/respStmt/resp[@n="transcription"]

Person responsible for the transcription of this text

/TEI/teiHeader/fileDesc/titleStmt/respStmt/resp[@n="transcription"]/@fldid

transcription

/TEI/teiHeader/fileDesc/titleStmt/respStmt/resp[@n="revision"]

Person responsible for the revision of this text

/TEI/teiHeader/fileDesc/titleStmt/respStmt/resp[@n="revision"]/@fldid

revision

/TEI/teiHeader/fileDesc/titleStmt/respStmt/resp[@n="normalization"]

Person responsible for the normalization of this text

/TEI/teiHeader/fileDesc/titleStmt/respStmt/resp[@n="normalization"]/@fldid

normalization

/TEI/teiHeader/fileDesc/titleStmt/respStmt/resp[@n="tagging"]

Person responsible for the POS tagging of this text

/TEI/teiHeader/fileDesc/titleStmt/respStmt/resp[@n="tagging"]/@fldid

tagging

/TEI/teiHeader/fileDesc/titleStmt/funder

Funding body for the text or project

/TEI/teiHeader/fileDesc/titleStmt/funder/@fldid

funder

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msIdentifier/idno

Unique ID for this manuscript

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msIdentifier/idno/@fldid

msid

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msIdentifier/institution

Institution where the manuscript is held

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msIdentifier/institution/@fldid

msinstitution

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msIdentifier/repository

Repository the manuscript belongs to

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msIdentifier/repository/@fldid

msrepository

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msIdentifier/collection

Collection the manuscript belongs to

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msIdentifier/collection/@fldid

mscollection

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msIdentifier/settlement

Place/Settlement where the manuscript is held

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msIdentifier/settlement/@fldid

mssettlement

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msContents/summary

Summary of the content of a manuscript

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/msContents/summary/@fldid

mssummary

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/physDesc/objectDesc/supportDesc/support

Description of the support of a manuscript

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/physDesc/objectDesc/supportDesc/support/@fldid

mssupport

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/physDesc/objectDesc/supportDesc/foliation

Numbering system of the manuscript pages

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/physDesc/objectDesc/supportDesc/foliation/@fldid

msfoliation

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/physDesc/objectDesc/@form

Physical form of a manuscript

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/physDesc/handDesc

Description of the hands in a manuscript

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/physDesc/handDesc/@fldid

mshands

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/history/origin

Description of the history of a manuscript

/TEI/teiHeader/fileDesc/sourceDesc/msDesc/history/origin/@fldid

msorigin

/TEI/teiHeader/fileDesc/sourceDesc/recordingStmt/recording/media/@url

Filename of the audio file (url or local file)

/TEI/teiHeader/fileDesc/sourceDesc/recordingStmt/recording/desc

Description of the recording

/TEI/teiHeader/fileDesc/sourceDesc/recordingStmt/recording/desc/@fldid

recdesc

/TEI/teiHeader/fileDesc/sourceDesc/recordingStmt/recording/date

Date the recording was made

/TEI/teiHeader/fileDesc/sourceDesc/recordingStmt/recording/date/@fldid

recdate

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author

Monograph author

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author/@fldid

monauthor

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title

Monograph title

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title/@fldid

montitle

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/edition

Monograph edition

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/edition/@fldid

monedition

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/publisher

Monograph publisher

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/publisher/@fldid

monpublisher

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/pubPlace

Monograph publication place

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/pubPlace/@fldid

monplace

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/date

Monograph publication date

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/date/@fldid

mondate

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/name

Name of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/name/@fldid

personname

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/birth/placeName

Birth place of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/birth/placeName/@fldid

birthplace

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/birth/placeName/@geo

Geolocation coordinates (lat lng) of the birth place of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/birth/date

Date of birth of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/birth/date/@fldid

birthdate

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/birth/@fldid

birth

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/birth/@when

Year of birth of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/death/placeName

Death place of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/death/placeName/@geo

Geolocation coordinates (lat lng) of the death place of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/death/date

Date of death of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/death/@when

Year of death of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/langKnowledge/langKnown[@n="first"]

Native language of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/langKnowledge/langKnown[@n="first"]/@tag

ISO 639-2 code for the native language of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/langKnowledge/langKnown[@n="native"]

Other languages spoken by the student/speaker/author as native language

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/langKnowledge/langKnown[@n="foreign"]

Other languages learnt by the student/speaker/author as non-native language

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/langLearning/duration/@months

Duration (in months) the student has been learning this L2

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/langLearning/previous

Previous course taken by the student for this L2

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/langLearning/stay

Country where student spent in a country the this L2 is spoken

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/langLearning/stay/@duration

Duration (in months) the student spent in a country the this L2 is spoken

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/langLearning/proficiency

Proficiency level the student is training for

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/langLearning/@lang

ISO 639-2 code for the language the student is learning

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/sex/@fldid

sex

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/sex/@type

gender of the student/speaker/author (m/f)

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/age

Age (in years) of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/age/@fldid

age

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/occupation

Occupation of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/occupation/@fldid

personoccupation

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/residence

Place of residence of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/residence/@fldid

personresidence

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/nationality

Nationality of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/nationality/@fldid

nationality

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/nationality/@key

ISO 3166 code for the nationality of the student/speaker/author

/TEI/teiHeader/profileDesc/particDesc/listPerson/person/@id

Unique ID for the student/speaker/author of this text

/TEI/teiHeader/profileDesc/langUsage/language

Language in which this text is written

/TEI/teiHeader/profileDesc/langUsage/language/@fldid

textlang

/TEI/teiHeader/profileDesc/langUsage/language/@ident

ISO 639-2 code for the language in which this text is written

/TEI/teiHeader/profileDesc/langUsage/language/@dir

Writing direction of the text

/TEI/teiHeader/profileDesc/textDesc/channel/@fldid

textchannel

/TEI/teiHeader/profileDesc/textDesc/channel/@mode

Written or Spoken

/TEI/teiHeader/profileDesc/textDesc/domain

Domain of the text

/TEI/teiHeader/profileDesc/textDesc/domain/@fldid

textdomain

/TEI/teiHeader/profileDesc/taskDesc/task/title

Description of the task (as given to the student)

/TEI/teiHeader/profileDesc/taskDesc/task/title/@fldid

tasktitle

/TEI/teiHeader/profileDesc/taskDesc/task/affiliation

Institution where the current L2 course is given

/TEI/teiHeader/profileDesc/taskDesc/task/affiliation/@fldid

taskaffiliation

/TEI/teiHeader/profileDesc/taskDesc/task/genre

Genre of the task

/TEI/teiHeader/profileDesc/taskDesc/task/genre/@fldid

taskgenre

/TEI/teiHeader/profileDesc/taskDesc/task/extent

Extent of the task (typically in words)

/TEI/teiHeader/profileDesc/taskDesc/task/extent/@fldid

taskextent

/TEI/teiHeader/profileDesc/taskDesc/task/taskSetting

Settings of the task (time-limited, with reference material, etc.)

/TEI/teiHeader/profileDesc/taskDesc/task/taskSetting/@fldid

tasksetting

/TEI/teiHeader/profileDesc/taskDesc/task/type

Type of task

/TEI/teiHeader/profileDesc/taskDesc/task/type/@fldid

tasktype

/TEI/teiHeader/profileDesc/taskDesc/task/desc

Relevant background details about the task

/TEI/teiHeader/profileDesc/taskDesc/task/desc/@fldid

taskdesc

/TEI/teiHeader/profileDesc/taskDesc/task/date

Date the task was handed in

/TEI/teiHeader/profileDesc/taskDesc/task/date/@fldid

taskdate

/TEI/teiHeader/profileDesc/taskDesc/task/date/@when

Year the task was handed in

/TEI/teiHeader/profileDesc/taskDesc/task/@id

Unique ID for the task of this text

/TEI/teiHeader/profileDesc/settingDesc/setting/date

Date (year) this text was written (when there are multiple relevant dates)

/TEI/teiHeader/profileDesc/settingDesc/setting/date/@fldid

textdate

/TEI/teiHeader/profileDesc/settingDesc/setting/date/@when

Best guess year for this text

/TEI/teiHeader/profileDesc/settingDesc/setting/name[@n="place"]

Place this text was written

/TEI/teiHeader/profileDesc/settingDesc/setting/name[@n="place"]/@fldid

textplace

/TEI/teiHeader/profileDesc/settingDesc/setting/name[@n="place"]/@geo

Geolocation (lat lng) for the place where this manuscript was written

/TEI/teiHeader/profileDesc/textClass

Type of text

/TEI/teiHeader/profileDesc/textClass/@fldid

textclass

/TEI/teiHeader/encodingDesc/projectDesc/title

Title of the project

/TEI/teiHeader/encodingDesc/projectDesc/title/@fldid

projecttitle

/TEI/teiHeader/encodingDesc/projectDesc/leader

Leader/coordinator of the project

/TEI/teiHeader/encodingDesc/projectDesc/leader/@fldid

projectleader

/TEI/teiHeader/encodingDesc/projectDesc/desc

Description of the project

/TEI/teiHeader/encodingDesc/projectDesc/desc/@fldid

projectdesc

/TEI/teiHeader/encodingDesc/projectDesc/@id

Unique ID for the project (to link to external descriptions)

/TEI/teiHeader/encodingDesc/editorialDecl

Editorial principles used in the transcription

/TEI/teiHeader/encodingDesc/editorialDecl/@fldid

editorialdecl