Difference between revisions of "TEI Dictionaries"

From CrossWire Bible Society
Jump to: navigation, search
(initial outline, intro)
 
(switched to P5 (out since November) and posted info on new schema)
Line 1: Line 1:
 
=Introduction=
 
=Introduction=
In SWORD, the "LD" module type is used to contain modules keyed to non-hierarchical keys. Such modules include: dictionaries (indexed by words or numbers), glossaries (simple one-word translation dictionaries), and daily devotionals (indexed by dates).
+
In Sword, the "LD" module type is used to contain modules keyed to non-hierarchical keys. Such modules include: dictionaries (indexed by words or numbers), glossaries (simple one-word translation dictionaries), and daily devotionals (indexed by dates).
  
For lexicons and dictionaries, the use of TEI P4 markup is encouraged. TEI P4 is an XML standard, quite similar to OSIS and ThML, intended for encoding all types of electronic documents. Since TEI is modular, it is possible to ignore the majority of its modules and use only the much simpler set of tags included in the core, dictionaries, and linking modules.
+
For lexicons and dictionaries, the use of TEI P5 markup is encouraged. TEI P5 is an XML standard, quite similar to OSIS and ThML, intended for encoding all types of electronic documents. Since TEI is modular, it is possible to ignore the majority of its modules and use only the much simpler set of tags included in the core, dictionaries, and linking modules.
 +
 
 +
For the purpose using TEI P5 in Sword, we have developed a special XML Schema that includes the basic set of P5 modules necessary for dictionaries and adds osisID and osisRef attributes (with their normal OSIS syntax) to many elements. This will permit cross-referencing with OSIS modules and the use of standard Bible references in TEI documents. Our customized TEI schema is available at http://www.crosswire.org/osis/teiP5DictOsis.1.0.xsd.
  
 
=Markup=
 
=Markup=
Line 11: Line 13:
  
 
=Validation=
 
=Validation=
 +
 +
Use of the following XML header (prior to the <TEI> element) will assist in automated validation with most XML Schema Validators.
  
 
  <?xml version="1.0" encoding="utf-8"?>
 
  <?xml version="1.0" encoding="utf-8"?>
  <!DOCTYPE TEI.2
+
  <osis xmlns="http://www.crosswire.org/2008/TEIOSIS/namespace"
    PUBLIC "-//TEI P4//DTD Main Document Type//EN"
+
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    "http://www.tei-c.org/Guidelines/DTD/tei2.dtd" [
+
      xsi:schemaLocation="http://www.crosswire.org/2008/TEIOSIS/namespace
  <!ENTITY % TEI.XML          "INCLUDE" >
+
        http://www.crosswire.org/osis/teiP5DictOsis.1.0.xsd">
  <!ENTITY % TEI.dictionaries "INCLUDE" >
+
  <!ENTITY % TEI.linking      "INCLUDE" >
+
]>
+
  
 
=Importing=
 
=Importing=

Revision as of 12:33, 27 April 2008

Introduction

In Sword, the "LD" module type is used to contain modules keyed to non-hierarchical keys. Such modules include: dictionaries (indexed by words or numbers), glossaries (simple one-word translation dictionaries), and daily devotionals (indexed by dates).

For lexicons and dictionaries, the use of TEI P5 markup is encouraged. TEI P5 is an XML standard, quite similar to OSIS and ThML, intended for encoding all types of electronic documents. Since TEI is modular, it is possible to ignore the majority of its modules and use only the much simpler set of tags included in the core, dictionaries, and linking modules.

For the purpose using TEI P5 in Sword, we have developed a special XML Schema that includes the basic set of P5 modules necessary for dictionaries and adds osisID and osisRef attributes (with their normal OSIS syntax) to many elements. This will permit cross-referencing with OSIS modules and the use of standard Bible references in TEI documents. Our customized TEI schema is available at http://www.crosswire.org/osis/teiP5DictOsis.1.0.xsd.

Markup

Linking Entries

OSIS References

Validation

Use of the following XML header (prior to the <TEI> element) will assist in automated validation with most XML Schema Validators.

<?xml version="1.0" encoding="utf-8"?>
<osis xmlns="http://www.crosswire.org/2008/TEIOSIS/namespace"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.crosswire.org/2008/TEIOSIS/namespace
       http://www.crosswire.org/osis/teiP5DictOsis.1.0.xsd">

Importing