Difference between revisions of "OSIS Bibles"

From CrossWire Bible Society
Jump to: navigation, search
(Marking Notes: Example)
(Marking Notes: Result)
Line 65: Line 65:
 
==Marking Cross-References==
 
==Marking Cross-References==
 
==Marking Notes==
 
==Marking Notes==
 
 
<pre>
 
<pre>
 
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement  
 
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement  
Dieu<note osisRef="Gen.1.1" osisID="Gen.1.1!1">en hébreu: Élohim, pluriel d'Éloah, le Dieu suprême),
+
Dieu<note osisRef="Gen.1.1" osisID="Gen.1.1!1">en hébreu: Élohim, (pluriel d'Éloah, le Dieu suprême),
 
la Déité, dans le sens absolu.</note> créa les cieux et la terre.<verse eID="Gen.1.1"/>
 
la Déité, dans le sens absolu.</note> créa les cieux et la terre.<verse eID="Gen.1.1"/>
 
<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et  
 
<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et  
Line 74: Line 73:
 
sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.<verse eID="Gen.1.2"/>
 
sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.<verse eID="Gen.1.2"/>
 
</pre>
 
</pre>
 +
 +
{| border="1"
 +
|+Result
 +
|
 +
# Au commencement Dieu¹ créa les cieux et la terre.
 +
# Et la terre était désolation et vide², et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.
 +
 +
*¹ en hébreu: Élohim, (pluriel d'Éloah, le Dieu suprême), la Déité, dans le sens absolu.
 +
*² le vide.|
 +
|}
  
 
=osis2mod usage=
 
=osis2mod usage=

Revision as of 10:01, 21 September 2007

Introduction

This page is for practical examples of how to encode a Bible in OSIS 2.1.1 for building a Sword module with osis2mod. It represents CrossWire's experience and best practices in creating modules.

General structure

An OSIS document is a well-formed XML document, valid according to the OSIS schema. You can find the full normative description on the OSIS Website [1].

To produce a Bible, you can use this template:

<?xml version="1.0" encoding="UTF-8"?>
<osis
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://www.bibletechnologies.net/2003/OSIS/namespace"
	xmlns:osis="http://www.bibletechnologies.net/2003/OSIS/namespace"
	xsi:schemaLocation="http://www.bibletechnologies.net/2003/OSIS/namespace http://www.bibletechnologies.net/osisCore.2.1.1.xsd">
	<osisText osisIDWork="{NAME}" osisRefWork="bible" xml:lang="{LANG}" canonical="true">
		<header>
			{HEADER}
		</header>
		<div type="bookGroup">
			{BODY}
		</div>
	</osisText>
</osis>

With the following values:

{NAME}
Normalized name of the Bible version (Usually 3 letters for language, 3 for translation)
{LANG}
ISO-639 [2] language code
{HEADER}
Description of the included text; see below
{BODY}
Text; see below

For text without any character outside ASCII, you can use US-ASCII encoding (usually for english text). For every other language, please use UTF-8. See the tools section if you need to convert.

Header

Body

Here is the general structure of the body content:

<div type="bookGroup">
	<head>Old Testament</head>
	<div type="book" osisID="Gen">
		<title type="main" short="Genesis">Genesis</title>
		<chapter osisID="Gen.1" n="1">
			<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>In the
			beginning...<verse eID="Gen.1.1"/>
			<verse sID="Gen.1.1" osisID="Gen.1.2" n="2"/>The earth was
			formless and void...<verse eID="Gen.1.2"/>
			...
		</chapter>
	</div>
</div>

Examples

Marking with Strong's Numbers

Marking with Other Lemma

Marking Section Headings

Marking Cross-References

Marking Notes

	<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement 
	Dieu<note osisRef="Gen.1.1" osisID="Gen.1.1!1">en hébreu: Élohim, (pluriel d'Éloah, le Dieu suprême),
	la Déité, dans le sens absolu.</note> créa les cieux et la terre.<verse eID="Gen.1.1"/>
	<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et 
	vide<note osisRef="Gen.1.2" osisID="Gen.1.2!1">le vide.</note>, et il y avait des ténèbres
	sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.<verse eID="Gen.1.2"/>
Result
  1. Au commencement Dieu¹ créa les cieux et la terre.
  2. Et la terre était désolation et vide², et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.
  • ¹ en hébreu: Élohim, (pluriel d'Éloah, le Dieu suprême), la Déité, dans le sens absolu.
  • ² le vide.|

osis2mod usage

Tools

Charset conversion

XML well-formed test

Validate OSIS test

Perl and automatic text transformation

XSLT and automatic XML transformation

make and Makefile