Header

From the Open Siddur Project Development Wiki

Jump to: navigation, search

The header is a specialized form of the TEI header, stored as tei:TEI/tei:teiHeader. It contains all necessary metadata about the document.

Contents

File Description

The file description is the first part of the header. It contains the title statement, the publication statement, and the source description.

Title statement

The title statement has the following form: 

<tei:titleStmt>
  <tei:title xml:lang="LANG"><!-- title in language LANG --></tei:title>
  <j:respList>
    <tei:respons j:role="CONTRIBUTOR_ROLE" locus="LOCATION_TYPE+" target="LOCAL_REFERENCE" resp="CONTRIBUTOR_URI_REFERENCE"/>
    <!-- additional responsibility statements go here -->
  </j:respList>
</tei:titleStmt>

The title of each file is the title of the file's content in the file's primary language (as defined by the @xml:lang attribute on the root element). It will usually be a description of a part of the service or an incipit. If the title has subparts, they should be handled the same way as subtitles in bibliography entries.

Following the title comes the responsibility list (j:respList element), which contains concise versions of the tei:respStmt element as tei:respons elements. Each tei:respons element assigns responsibility for one task (@locus) that was performed on one part of the document (@target) to one contributor (@resp). Valid values of @j:role are:

  • scanner
  • transcriber
  • proofreader
  • encoder
  • editor
  • author (for original works)

Valid values for @locus are defined in the TEI Guidelines as: name (name of element), location (positioning of element), value (content of element), start or end (positioning of the element in the text).

The target granularity need not be more precise than a TEI XPointer range() or an @xml:id reference. The @resp attribute must point to an entry in a contributor list. It will generally point to the contributor's entry in the global contributor list. If the edit is taking place on a local file, and the contributor has not yet contributed public information, a local contributor list may be used.

Further details, including the date of the change and the precise content of the change, are to be maintained in the project's revision control system.

The publication statement

The publication statement contains the file's publication information, including copyright licensing information.

The copyright licensing information is stored in a tei:availability element, which has two children. A computer-readable RDF version of the licensing information for each project-approved Creative Commons license is reproduced below. In conversions to canonical TEI, the RDF may be removed.

An example publication statement for a file that is released under the CC-BY-SA license is as follows: 

<tei:publicationStmt>
  <tei:availability status="free">
    <tei:p xml:lang="en">Copyright <tei:date>2009</tei:date> by the Contributors to the Jewish Liturgy Project. This file is available under the <tei:ref type="license" target="http://www.creativecommons.org/licenses/by-sa/3.0">Creative Commons Attribution ShareAlike 3.0 Unported</tei:ref> license.</tei:p>
    <!-- begin license RDF here -->
    <rdf:RDF>
      <cc:License rdf:about="http://creativecommons.org/licenses/by-sa/3.0/">
        <cc:legalcode rdf:resource="http://creativecommons.org/licenses/by-sa/3.0/legalcode"/>
        <cc:permits rdf:resource="http://creativecommons.org/ns#DerivativeWorks"/>
        <cc:permits rdf:resource="http://creativecommons.org/ns#Reproduction"/>
        <cc:permits rdf:resource="http://creativecommons.org/ns#Distribution"/>
        <cc:requires rdf:resource="http://creativecommons.org/ns#Attribution"/>
        <cc:requires rdf:resource="http://creativecommons.org/ns#ShareAlike"/>
        <cc:requires rdf:resource="http://creativecommons.org/ns#Notice"/>
      </cc:License>
    </rdf:RDF>
    <!-- end license RDF -->
  </tei:availability>
  <tei:idno type="svn">$Id$</idno>
</tei:publicationStmt>

The following local URIs point to the licenses' legal code:

URI License shorthand License name
http://jewishliturgy.org/base/text/license/cc0/1.0 CC0 Creative Commons Zero (Public domain dedication)
http://jewishliturgy.org/base/text/license/cc-by/3.0 CC-BY Creative Commons Attribution 3.0 Unported
http://jewishliturgy.org/base/text/license/cc-by-sa/3.0 CC-BY-SA Creative Commons Attribution ShareAlike 3.0 Unported

License statements and RDFs

These license statements should be used if the Jewish Liturgy Project is the originator of the work. If another entity originated the work, and it is being used under license, the other entity's license statement, required attribution, and required usage statement must be included in the tei:availability statement under a separate tei:p[@n="additional"]. A processor that uses the file must include the additional statement on its copyright page or contribution page.

Public domain certification

The public domain certification is a statement indicating that, to the best of the contributor's knowledge, the work was obtained by the contributor from the public domain. The contributor certifies that he/she claims no new copyright over the work.

Even though attribution is not required for a public domain work, the project maintains a contributor list. 

<tei:p xml:lang="en">This work is in the
<tei:ref type="license" target="http://creativecommons.org/licenses/publicdomain/">public domain</tei:ref>.
</tei:p>
<rdf:RDF>
  <cc:License rdf:about="http://creativecommons.org/licenses/publicdomain/">
    <cc:legalcode rdf:resource="http://creativecommons.org/licenses/publicdomain/"/>
    <cc:permits rdf:resource="http://creativecommons.org/ns#Reproduction"/>
    <cc:permits rdf:resource="http://creativecommons.org/ns#Distribution"/>
  </cc:License>
</rdf:RDF>

CC0

CC0 is an international public domain dedication, backed up by a no-rights-reserved copyright license for jurisdictions where copyright cannot be waived: 

<tei:p xml:lang="en">To the extent possible under law, 
the contributors who associated  
<tei:ref type="license" target="http://creativecommons.org/licenses/publicdomain/zero/1.0">Creative Commons Zero</tei:ref> 
with this work have waived all copyright and related or neighboring rights to this work.  
</tei:p>
<rdf:RDF>
  <cc:License rdf:about="http://creativecommons.org/publicdomain/zero/1.0/">
    <cc:legalcode rdf:resource="http://creativecommons.org/publicdomain/zero/1.0/legalcode"/>
    <cc:permits rdf:resource="http://creativecommons.org/ns#Reproduction"/>
    <cc:permits rdf:resource="http://creativecommons.org/ns#Distribution"/>
  </cc:License>
</rdf:RDF>

Even though attribution is not required for a CC0 work, the project maintains a contributor list.

Attribution (CC-BY) 

<tei:p xml:lang="en">Copyright <tei:date>YEAR</tei:date> by the Contributors to the Open Siddur Project. 
This file is available under the 
<tei:ref type="license" target="http://creativecommons.org/licenses/by/3.0">Creative Commons Attribution 3.0 Unported</tei:ref> license.  
A list of contributors is available at 
</tei:p>
<rdf:RDF>
  <cc:License rdf:about="http://creativecommons.org/licenses/by/3.0/">
    <cc:legalcode rdf:resource="http://creativecommons.org/licenses/by/3.0/legalcode"/>
    <cc:permits rdf:resource="http://creativecommons.org/ns#DerivativeWorks"/>
    <cc:permits rdf:resource="http://creativecommons.org/ns#Distribution"/>
    <cc:permits rdf:resource="http://creativecommons.org/ns#Reproduction"/>
    <cc:requires rdf:resource="http://creativecommons.org/ns#Notice"/>
    <cc:requires rdf:resource="http://creativecommons.org/ns#Attribution"/>
  </cc:License>
</rdf:RDF>
Additional attribution statements

If a work comes from a different source and additional attribution statements are required by the license, they may be added to the file as: 

<tei:p n="attribution" xml:lang="LANGUAGE"><!-- insert attribution statement here --></tei:p>

Attribution (CC-BY-SA) 

<tei:p xml:lang="en">Copyright <tei:date>2009</tei:date> by the Contributors to the Jewish Liturgy Project. 
This file is available under the 
<ref type="license" target="licenses/cc-by/3.0">Creative Commons Attribution 3.0 Unported</ref> 
license.  A list of contributors is available at 
<ref type="attribution" target="http://jewishliturgy.org/base/text/contributors">http://jewishliturgy.org/base/text/contributors</ref>.
</tei:p>
<rdf:RDF>
  <cc:License rdf:about="http://creativecommons.org/licenses/by-sa/3.0/">
    <cc:legalcode rdf:resource="http://creativecommons.org/licenses/by-sa/3.0/legalcode"/>
    <cc:permits rdf:resource="http://creativecommons.org/ns#DerivativeWorks"/>
    <cc:permits rdf:resource="http://creativecommons.org/ns#Reproduction"/>
    <cc:permits rdf:resource="http://creativecommons.org/ns#Distribution"/>
    <cc:requires rdf:resource="http://creativecommons.org/ns#Attribution"/>
    <cc:requires rdf:resource="http://creativecommons.org/ns#ShareAlike"/>
    <cc:requires rdf:resource="http://creativecommons.org/ns#Notice"/>
  </cc:License>
</rdf:RDF>

The source description

The source description uses a list of short form bibliographic links to list all the sources of a particular file. The tei:bibl/tei:ptr points to an entry in the global bibliography support file. All sources used in the file must be listed in its own tei:bibl inside tei:sourceDesc, including the original work of an author written for the project. 

<tei:sourceDesc>
  <tei:bibl>
    <tei:ptr target="BIBLIOGRAPHIC_URI_REFERENCE"/>
  </tei:bibl>
</tei:sourceDesc>

Encoding description

The vast majority of files within the project do not use most of the features of the encoding description. A single global header file contains the tei:refsDecl, tei:editorialDecl, tei:projectDesc, and tei:tagsDecl elements, describing project policy. These project policies are mostly described in these guidelines.

The tei:encodingDesc/tei:appInfo tag may be used, if a specific application was used to process the file, as shown below: 

<tei:appInfo>
 <tei:application version="APPLICATION_VERSION" ident="APPLICATION_NAME">
  <tei:label><!-- long application name --></tei:label>
 </tei:application>
</tei:appInfo>

One or more tei:application/tei:ptr elements may be used to point to specific parts of the file that had been processed by the application.

Retrieved from "http://wiki.jewishliturgy.org/Header"
Personal tools
NAVIGATION