<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<TITLE>Losfile DTD</TITLE>
<META NAME="Author" CONTENT="Helmut Steeb">
<LINK rel=stylesheet type="text/css" href="pub.css">
</HEAD>
<BODY TEXT="#000000" BGCOLOR="#FFFFBD">
<H1>Losung file structure</H1>
<P>See the <A href="losfile-dtd.htm">Document type definition</A>.</P>
<P>Contents:</P>
<P>
<A HREF="#c">C</A>
<A HREF="#cr">CR</A>
<A HREF="#default">DEFAULT</A>
<A HREF="#dow">DOW</A>
<A HREF="#em">EM</A>
<A HREF="#filevers">FILEVERS</A>
<A HREF="#head">HEAD</A>
<A HREF="#il">IL</A>
<A HREF="#l">L</A>
<A HREF="#losfile">LOSFILE</A>
<A HREF="#losung">LOSUNG</A>
<A HREF="#linetags">Line tags</A>
<A HREF="#months">MONTHS</A>
<A HREF="#otnt">NT</A>
<A HREF="#otnt">OT</A>
<A HREF="#s">S</A>
<A HREF="#sl">SL</A>
<A HREF="#sr">SR</A>
<A HREF="#sublang">SUBLANG</A>
<A HREF="#sub">SUB</A>
<A HREF="#sup">SUP</A>
<A HREF="#tl">TL</A>
<A HREF="#tlpattern">TLPATTERN</A>
<A HREF="#tt">TT</A>
<A HREF="#x">X</A>
<A HREF="#xlat">XLAT</A>
</P>
<P>See the <A HREF="#history">history of this file</A>.</P>
<HR>
<H2><A Name="losfile" href="losfile-dtd.htm#losfile">LOSFILE</A></H2>
<P>is the root element, it contains all the info
that describes the entire file.</P>
<P>In general, all information
that may be of interest to the end user is coded in
tags, all information that may primarily be used
by processing programs is coded in attributes.</P>
<TABLE BORDER CELLPADDING=5 width=100%>
<TR>
<TD>dtdmainvers</TD>
<TD>main version, a number >= 0. An application may reject a file
that has an unsupported main version.</TD>
</TR>
<TR>
<TD>dtdsubvers</TD>
<TD>minor version, a number >= 0. An application is expected to
process all minor versions of one main version. <BR>
In general, an application
should ignore all tags that it does not know, and simply process
their content. If a new tag is introduced in the dtd,
and we want that applications which do not know the new tag should ignore not only the
tag itself but also the content
of this new tag, then we must increment dtdmainvers (so that
old applications reject the file).</TD>
</TR>
<TR>
<TD>xml:lang</TD>
<TD>contains the language identification as described
in the XML 1.0 spec 2.12 "Language identification" in lower case,
ISO639Code with optional Subcode (no IanaCode, no UserCode).
E.g. "de" or "zh-TW", but no "i-de", no "x-de".
All texts in the file are in this language.</TD>
</TR>
<TR>
<TD>year</TD>
<TD>number > 1900. All texts in the file are for this year.</TD>
</TR>
</TABLE>
<HR>
<H2><A Name="head" href="losfile-dtd.htm#head">HEAD</A></H2>
<P>HEAD simply wraps the informational items FILEVERS etc.</P>
<HR>
<H2><A Name="filevers" href="losfile-dtd.htm#filevers">FILEVERS</A></H2>
<P>Version of the respective text file, any string (e.g. an RCS keyword).
Informational only.</P>
<HR>
<H2><A Name="xlat" href="losfile-dtd.htm#xlat">XLAT</A></H2>
<P>The translation (edition) used for the bible texts.
This string is informational only. It may be:</P>
<UL>
<LI>"*": it is known that several editions are used (e.g. Elberfelder and Luther in German)</LI>
<LI>"?": it is unknown which edition was used</LI>
<LI>else: any string describing the edition (e.g. "Luther 84").
This should also contain any copyright references for the contents of the xml file
(bible texts, bible readings).</LI>
</UL>
</P>
<HR>
<H2><A Name="sublang" href="losfile-dtd.htm#sublang">SUBLANG</A></H2>
<P>contains specific data for variants of the main language.
E.g. for the main language "de" (German),
SUBLANG may specify month names used in Austria
("Jänner") which are different from those used in German ("Januar").
A simple application will just display the <IL> lines which contain
data for the main language. A smarter application
may give the user a choice of the sublanguage ("de-DE", "de-AT", ...)
and compute the title lines
itself, using the data in the SUBLANG tag.</P>
<TABLE BORDER CELLPADDING=5 width=100%>
<TR>
<TD>SUBCODE:</TD>
<TD>language subcode as described in XML 1.0 spec 2.12.
Normally, this will be a two-character country code from ISO 3166 in upper case.</TD>
</TR>
</TABLE>
<HR>
<H2><A Name="tlpattern" href="losfile-dtd.htm#tlpattern">TLPATTERN</A></H2>
<P>contains a pattern for the title line (TL tag)
specific for the given sublanguage (if it occurs within the SUBLANG tag).
The pattern may contain the placeholders:</P>
<TABLE BORDER CELLPADDING=5 width=100%>
<TR>
<TD>[DOW]</TD>
<TD>the day of the week (as defined in the DOW tag)</TD>
</TR>
<TD>[dow]</TD>
<TD>the day of the week (as defined in the DOW tag, but the initial
character converted to lowercase. NOTE: some implementations
may have problems to support [dow]
in multibyte character sets such as chinese)</TD>
</TR>
<TR>
<TD>[D]</TD>
<TD>the day in the month (one or two digits as needed)</TD>
</TR>
<TR>
<TD>[DD]</TD>
<TD>the day in the month (two digits, zero padded)</TD>
</TR>
<TR>
<TD>[MONTH]</TD>
<TD>the month name (as defined in the MONTHS tag)</TD>
</TR>
<TR>
<TD>[month]</TD>
<TD>the month name (as defined in the MONTHS tag, but the initial
character converted to lowercase. NOTE: some implementations
may have problems to support [month]
in multibyte character sets such as chinese))</TD>
</TR>
<TR>
<TD>[M]</TD>
<TD>the month number (jan=1, ...; one or two digits as needed)</TD>
</TR>
<TR>
<TD>[MM]</TD>
<TD>the month number (jan=1, ...; two digits zero padded</TD>
</TR>
<TR>
<TD>[YY]</TD>
<TD>the year number, two digits</TD>
</TR>
<TR>
<TD>[YYYY]</TD>
<TD>the year number, four digits</TD>
</TR>
<TR>
</TABLE>
<HR>
<H2><A Name="months" href="losfile-dtd.htm#months">MONTHS</A></H2>
<P>the attributes of this tag contain
the month names for the given sublanguage .
The attribute names are the first three characters of the respective
english month names.</P>
<HR>
<H2><A Name="dow" href="losfile-dtd.htm#dow">DOW</A></H2>
<P>the attributes of this tag contain
the names of the seven days of the week for the given sublanguage.
The attribute names are the first three characters of the respective
english names.
</DD>
<HR>
<H2><A Name="losung" href="losfile-dtd.htm#losung">LOSUNG</A></H2>
<P>contains all data for one day in the language and
year described at LOSFILE. </P>
<P><STRONG>Note:</STRONG> one file does not necessarily contain LOSUNG elements
for all days of the year. It might e.g. contain only one month or only one half
of the year - for a new translation that comes up in the middle of the year,
the texts for the days already gone may well be left out.</P>
<TABLE BORDER CELLPADDING=5 width=100%>
<TR>
<TD>M</TD>
<TD>month in the year, 1 <= M <= 12 (1=january, ... 12=december)</TD>
</TR>
<TR>
<TD>D</TD>
<TD>day in the month, 1 <= D <= 31.</TD>
</TR>
<TR>
</DL>
</TABLE>
<HR>
<H2><A Name="linetags">Line tags</A></H2>
<P>In general, all tags ending with "L" are "line" tags. These
will normally be displayed as one single line (applications
that are more clever are free to ignore the line breaks).
These tags contain
text that is ready to be displayed to the user, as opposed
to the information conveyed by attributes which is meant
to be automatically processed by programs. E.g. the "SL"
is the displayable source data that may contain
"Eph." or "Ephesians", whereas the S attribute B
is the internal source data which must be exactly "E".<BR>
There is no information about the indentation of the lines in
the LOSUNG file. If a console application wants to center the
lines, it may achieve centering by a simple computation.<BR>
No application shall make assumptions about the formatting of the
line elements. E.g. lines in the LOSUNG file may start with <L> and end
with </L> to allow manual editing, but no application may rely on this
format. This means also that many line breaks and white spaces may occur
within a line element - the application must treat each such sequence
as exactly one space.</P>
<HR>
<H2><A Name="tl" href="losfile-dtd.htm#tl">TL = TitleLine</A></H2>
<P>e.g. "Watchwords for Saturday, 12 June 1999".
This is required, to be displayed as a title for the day. Smarter
applications may compute the title line themselves, e.g. using SUBLANG info.</P>
<HR>
<H2><A name="ot" href="losfile-dtd.htm#ot">OT</A> = Old Testimony,
<A name="nt" href="losfile-dtd.htm#nt">NT</A> = New Testimony</A></H2>
<P>These elements contain the verses selected by Herrnhut from the Old and New Testimony.</P>
<HR>
<H2><A name="tt" href="losfile-dtd.htm#tt">TT</A></H2>
<P>This is for "third texts" from the watchwords booklet. As of 2000-12-27, the
freeware watchwords programs are not allowed to use these texts, but
Petr Herman who prepares the Czech booklet would use this tag.</P>
<HR>
<H2><A Name="s" href="losfile-dtd.htm#s">S = Source</A></H2>
<P>This element contains bible references as attributes. It has no content.
The attributes shall allow machine processing and therefore
contain the names of biblical books, chapter and verse numbers.<BR>
The names of the biblical books are abbreviations taken from
Nestle-Aland 26. ed.<BR>
B is one of the abbreviations from Nestle-Aland. All other attributes are numbers.
Attributes not needed may be omitted or may be "0".</P>
<TABLE BORDER CELLPADDING=5 width=100%>
<TR>
<TD>B</TD>
<TD>names of the biblical books (case sensitive, see DTD)</TD>
</TR>
<TR>
<TD>Ch</TD>
<TD>Chapter number of the first verse. This will be missing
for verses from Philemon, Obadja, 2./3. John.
</TD>
</TR>
<TR>
<TD>V</TD>
<TD>the number of the first verse. This must always be specified.
</TD>
</TR>
<TR>
<TD>R2, Ch2, V2</TD>
<TD>the number of the second verse. Its chapter number may be omitted if it equals Ch.
If R2 is nonzero, Ch/V - Ch2/V2 is a range of verses.
</TD>
</TR>
<TR>
<TD>R3, Ch3, V3</TD>
<TD>the number of the third verse. Its chapter number may be omitted if it equals Ch2.
If R3 is nonzero, Ch2/V2 - Ch3/V3 is a range of verses.
</TD>
</TR>
<TR>
<TD>R4, Ch4, V4</TD>
<TD>the number of the fourth verse. Its chapter number may be omitted if it equals Ch3.
If R4 is nonzero, Ch3/V3 - Ch4/V4 is a range of verses.
</TD>
</TR>
<TR>
<TD>N</TD>
<TD>At present, this attribute is informational only, you may not rely on it
to be set where it should. In the future, it may well be dropped.<BR>
The attribute is '1' if the source data for the user differs from the data in the German text,
else '0' (default).<BR>
E.g. in 27 June 1999,
the NASB-u translation says the source for "Behold, on the mountains the feet of him
who brings good news" is <SL>"Nahum 1:15a"</SL>. But the normalized
(Luther) source is Nahum 2:1, i.e. <OT b='Nah' ch='2' v='1' n='1'>.
</TD>
</TR>
<TR>
<TD>TR</TD>
<TD>Bible translation used. Optional. Likely to be used for Czech.
</TD>
</TR>
</TABLE>
<P>The following combinations make sense:</P>
<UL>
<LI>Verses from one chapter: B Ch V...</LI>
<LI>One verse from previous, some from next chapter: B Ch V Ch2 V2...</LI>
<LI>Two verses from previous, some from next chapter: B Ch V V2 Ch3 V3...</LI>
<LI>No chapter (e.g. Philemon): B V...</LI>
</UL>
<P>Note:</P>
<UL>
<LI>there may be verses that do not immediately follow each other,
e.g. John 4,1.3.</LI>
<LI>B='J' Ch=8 V=35 Ch2=9 V2=1 V3=2 (the second verse is in the next chapter: Ch2)</LI>
<LI>B='J' Ch=8 V=34 V2=35 Ch3=9 V3=1 (the third verse is in the next chapter: Ch3)</LI>
<LI>The application <STRONG>cannot</STRONG> rely on the
order the attributes are written in the file (any xml processor may
e.g. write the attributes in alphabetical order)!</LI>
</UL>
<HR>
<H2><A Name="il" href="losfile-dtd.htm#il">IL = introline</A></H2>
<P>e.g. "Paul writes to the Ephesians:" <BR>
<P>This is optional and is used to mark text that is not
from the cited bible verses but that was added to explain the following bible text.</P>
<UL>
<LI>Explaining text that can be found some verses ahead in the bible
is marked with IL.</LI>
<LI>Explaining text that is from the quoted verses but that was slightly
changed (e.g. to form a grammatical correct sentence) is not marked with IL
(in a different translation the sentence might be changed, too).</LI>
</UL>
<P>This may be displayed in a smaller or lighter font, if possible:</P>
<P class="IL">Paul writes to the Ephesians:</P>
<P class="L">Grace be with you!</P>
<HR>
<H2><A Name="l" href="losfile-dtd.htm#l">L = Line</A></H2>
<P>a single text line</P>
<HR>
<H2><A Name="sl" href="losfile-dtd.htm#sl">SL = SourceLine</A></H2>
<P>e.g. "Eph. 2,15". This line is ready to be displayed to the end user.
It specifies the source of the verses in the given bible translation.
It may also specify the source of a third text.</P>
<HR>
<H2><A Name="cr" href="losfile-dtd.htm#cr">CR = continued reading</A></H2>
<P>A suggested bible reference for reading the bible continually (as in the German booklet).</P>
<HR>
<H2><A Name="sr" href="losfile-dtd.htm#sr">SR = selected reading</A></H2>
<P>A suggested bible reference for reading selected bible verses (as in the German booklet).</P>
<HR>
<H2><A Name="c" href="losfile-dtd.htm#c">C = multi line Comment</A></H2>
<P>Such comments are necessary to suffice the
license requirements, they may contain text like
"Did you already get the watchwords for the next year?".</P>
<HR>
<H2><A Name="x" href="losfile-dtd.htm#x">X = explanation</A></H2>
<P>e.g. the text in the parentheses in
"Denn hier ist Immanuel! (d.h. »Mit uns ist Gott!«)":<BR>
<L>Denn hier ist Immanuel! <X>(d.h. »Mit uns ist Gott!«)</X></L>.</P>
<P>This is optional and is used to mark text that is not
from the cited bible verses but that was added to explain the context.</P>
<P>This may be displayed in a smaller or lighter font, if possible:</P>
<P class="L">Denn hier ist Immanuel! <CITE class="X">(d.h. »Mit uns ist Gott!«)</CITE></P>
<HR>
<H2><A Name="em" href="losfile-dtd.htm#em">EM = emphasis</A></H2>
<P>This tag is used to mark text fragments that are
emphasized in the bible text (if somebody actually
takes pain to manually apply this tag...).
This may be displayed in italics, if possible.</P>
<HR>
<H2>
<A name="sub">SUB</a> = subscript,
<A name="sup">SUP</A> = superscript</A></H2>
<P>These are deprecated.
(They were meant for texts in special bible translations that
carry information about the Hebrew or Greek original text.)</P>
<HR>
<P class=footer>losfile.htm Version 1.11 2000/12/27 20:02:01</P>
<HR>
<P class><A NAME="history">History of this file:</A></P>
<PRE>
losfile.htm
# Revision 1.11 2000/12/27 20:02:01 Helmut_Steeb
# Added TR attribute of S
#
# Revision 1.10 2000/12/27 19:52:37 Helmut_Steeb
# ... and SR contains S* instead of S?.
#
# Revision 1.9 2000/12/27 19:40:05 Helmut_Steeb
# Added TT, dropped SUB/SUP.
# SL may be used for TT also.
#
# Revision 1.8 2000/10/05 21:39:30 Helmut_Steeb
# Links to dtd file "losfile-dtd.htm"
#
# Revision 1.7 1999/11/05 20:56:13 Helmut_Steeb
# Added IL again, adapted X.
#
# Revision 1.6 1999/10/09 17:31:42 Helmut_Steeb
# Adapted to dtd changes (dtdsubvers 2, Revision 1.11).
#
# Revision 1.5 1999/08/14 13:04:28 Helmut_Steeb
# Added remark that days may be missing in one losung file
#
# Revision 1.4 1999/08/11 22:45:13 Helmut_Steeb
# Added "Version" for grep
#
# Revision 1.3 1999/08/10 19:11:05 Helmut_Steeb
# Added RCS log keyword to create file history.
#
</PRE>
</BODY>
</HTML>
