Revision as of 12:19, 4 May 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.1.xsd.

Markup

Linking Entries

There are three kinds of references in a Biblical dictionary:

Internal references to entries in the same dictionary.

<xr type="see">See: Cite error: Invalid <ref> tag;

invalid names, e.g. too many</xr> Note: the key text may be any representation of the key. For example, the key may be G0019a and the key text may be 19a.

External references to entries in another work.

<xr type="xref">Cite error: Invalid <ref> tag;

invalid names, e.g. too many</xr> Note: work is the short module name as found between square brackets as in [BDB]

Biblical references to scripture passages. These use osisRef and are discussed below.

OSIS References

For the purpose of facilitating the marking of Bible references and linking with OSIS documents, two attributes have been borrowed from OSIS:

osisID exists on virtually all elements and contains osisID(s) (optionally with work IDs). An osisID might be used to link from an OSIS document to your TEI dictionary entry.

osisRef exists on the Cite error: Closing </ref> missing for <ref> tag</xr>.

Validation

Use of the following XML header will assist in automated validation with most XML Schema Validators:

<?xml version="1.0" encoding="utf-8"?>
<TEI 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.1.xsd">

Importing