Go Bible Home | News | Forum | About | Contact | Developer

Go Bible Logo

Go Bible

For the glory of our Lord Jesus Christ and the furtherance of His Kingdom.
Developer

OSIS

OSIS is an XML-based format for describing theological texts by including tags for scripture references, etc. A Bible consists of sections (eg. Preface, Old Testament, New Testament), books, chapters and verses. There are OSIS tags that represent each of these. The OSIS specification details many tags that can be used within an OSIS file, however, only those required by GoBibleCreator are described here. To begin with, an OSIS file must have an <osis> pair of tags. GoBibleCreator will only use content that is within the <osis> tag. Next the <osis> tag must contain an <osisText> pair of tags. Again, only content within the <osisText> tag will be used by GoBibleCreator. Next there are OSIS tags for each type of section in the Bible:

<div> (top level) The outer div tag is used to represent the top-level sections within the Bible such as the Preface, Old Testament, and New Testament. GoBibleCreator doesn't actually use the div tags perse but since most encodings of the Bible will identify the Old and New Testaments by div tags then GoBibleCreator assumes that they will be there.
<div> (second level) Second level div tags represent individual books of the Bible. OSIS provides the <osisID> attribute to identify each book. This attribute is a standardised attribute with identifiers for each book of the Bible. The identifiers are abbreviated English book names (eg. 'Gen', 'Ex', etc.), which are not suitable for display, especially for non-English translations. Therefore when working with OSIS file it is desirable to use the Book-Name-Map property of the Collections.txt file to provide presentable book names.
<div> or <chapter> Chapters are represented either in chapter tags or third level div tags. The Chapter tag must contain the following attribute:
  • osisID - The osisID will contain the chapter of the book in the form "Gen.2". Where the first part 'Gen' is the Book osisID and the number of the dot is the chapter number.
<verse> Each verse is contained within the verse tag.
<span> The ThML format supports the span tag to indicate Christ's words in red, however, GoBibleCreator does not currently support Christ's words in red in OSIS files. This may be added in a later version.

File Format

XML files are often in UTF-8 format and this is mostly true for OSIS files as well. GoBibleCreator requires that all input files are in UTF-8 format, if a file isn't then it will need to be converted to UTF-8 first before being processed by GoBibleCreator. The OSIS file should begin with the following tag:

  • <?xml version="1.0" encoding="UTF-8" standalone="yes"?>

Example

Below is a simple example of the minimum OSIS tags required by GoBibleCreator.

  • <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  • <osis>
    • <osisText>
      • <div>
        • <div osisID="Gen">
          • <chapter osisID="Gen.1">
            • <verse>
              • In the beginning God created the heaven and the earth.
            • </verse>
            • <verse>
              • And the earth was without form, and void; and darkness was upon the face of the deep. And the Spirit of God moved upon the face of the waters.
            • </verse>
          • </chapter>
        • </div>
      • </div>
    • </osisText>
  • </osis>