Skip to content

JLPTEI 101: 01: The contributor definition file

EveLevavi edited this page Dec 17, 2013 · 5 revisions

The contributor definition file is required as a way to claim responsibility (or blame?) for work on Open Siddur texts. It is stored in the /data/user collection in the database, and accessed via the [/api/user] (http://dev.jewishliturgy.org/exist/restxq/api/user) REST API.

An example of the format is:

<j:contributor 
  xmlns:tei="http://www.tei-c.org/ns/1.0"
  xmlns:j="http://jewishliturgy.org/ns/jlptei/1.0">
  <tei:idno>testuser</tei:idno>
  <tei:name><tei:forename>Test</tei:forename> <tei:surname>User</tei:surname>, <tei:genName>Jr.</tei:genName></tei:name>
  <tei:email>a.test.user@gmail.com</tei:email>
    <tei:affiliation>
        <tei:orgName>Academic University</tei:orgName>
        <tei:ptr type="url" target="http://university.edu/testuser"/>
    </tei:affiliation>
</j:contributor>

Minimally, only tei:idno is required. Additional information, such as real name (tei:name), email (tei:email), real world address (tei:address), academic, organization, or publishing affiliation (tei:affiliation), or URL (tei:ptr type="url") may also be included.

Contributor definition files are required for all contributors, whether or not they are logged in users. That is, an offsite transcriber must also have a contributor definition file.