Difference between revisions of "OSIS Commentaries"
(Initial discussion of OSIS Commentary construction.) |
(→Introduction: Add general structure) |
||
| (12 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | =Introduction= | + | == Introduction == |
In SWORD a commentary is structured just like a Bible. The difference is that instead of verse text the commentary has discussion about verse text. | In SWORD a commentary is structured just like a Bible. The difference is that instead of verse text the commentary has discussion about verse text. | ||
| − | = | + | ==General structure== |
| − | + | ||
| + | To produce an OSIS Commentary, you can use this template: | ||
| + | |||
<pre> | <pre> | ||
| − | < | + | <?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="Commentary" xml:lang="{LANG}" canonical="true"> | ||
| + | <header> | ||
| + | {HEADER} | ||
| + | </header> | ||
| + | <div type="bookGroup"> | ||
| + | {BODY} | ||
| + | </div> | ||
| + | </osisText> | ||
| + | </osis> | ||
</pre> | </pre> | ||
| − | + | == Markup == | |
| + | An OSIS Commentary differs from an OSIS Bible in that an [[OSIS Bibles]] use: | ||
| + | <pre> | ||
| + | <verse osisID="Gen.1.1">Blah blah...</verse> | ||
| + | </pre> | ||
| + | |||
| + | But the fundamental mechanism of markup for an OSIS commentary replaces that with: | ||
<pre> | <pre> | ||
<div type="section" annotateType="commentary" annotateRef="Gen.1.1"><p>Blah blah...</p></div> | <div type="section" annotateType="commentary" annotateRef="Gen.1.1"><p>Blah blah...</p></div> | ||
| Line 17: | Line 39: | ||
'''type'''<br/>This attribute can have any valid value or even be absent. osis2mod will not use this value. | '''type'''<br/>This attribute can have any valid value or even be absent. osis2mod will not use this value. | ||
| − | '''annotateType'''<br/>This attribute must have the value ''commentary'' will be used to know that we are processing an entry for a commentary. | + | '''annotateType'''<br/>This attribute must have the value ''commentary'' and will be used to know that we are processing an entry for a commentary. |
'''annotateRef'''<br/>This attribute can contain any valid osisRef, but the references must not have a work prefix, such as 'Bible:'. The default for all references and the only ones that SWORD supports at this time are Bible references. We'll tackle work prefixes at a later date. | '''annotateRef'''<br/>This attribute can contain any valid osisRef, but the references must not have a work prefix, such as 'Bible:'. The default for all references and the only ones that SWORD supports at this time are Bible references. We'll tackle work prefixes at a later date. | ||
| Line 30: | Line 52: | ||
Discontinuous references are to be separated by whitespace, "osisRef osisRef". For example: | Discontinuous references are to be separated by whitespace, "osisRef osisRef". For example: | ||
annotateRef="Gen.1.1 Gen1.5" | annotateRef="Gen.1.1 Gen1.5" | ||
| + | |||
| + | == Importing == | ||
| + | [[osis2mod]] (>= 1.5.11) is used for both Bibles and Commentaries. See [[osis2mod]] for details. | ||
| + | |||
| + | == Config file == | ||
| + | It's very important that all the necessary properties are included in the .conf file, otherwise the commentary module may not behave as required.<br> | ||
| + | e.g. The module being made from OSIS source text, this property should be specified: | ||
| + | SourceType=OSIS | ||
| + | Otherwise, it would default to Plaintext. For further details, please refer to [[DevTools:conf Files]]. | ||
| + | |||
| + | [[Category:Guides|OSIS Commentaries]] | ||
| + | |||
| + | [[Category:OSIS]] | ||
Latest revision as of 09:51, 19 December 2020
Introduction
In SWORD a commentary is structured just like a Bible. The difference is that instead of verse text the commentary has discussion about verse text.
General structure
To produce an OSIS Commentary, 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="Commentary" xml:lang="{LANG}" canonical="true">
<header>
{HEADER}
</header>
<div type="bookGroup">
{BODY}
</div>
</osisText>
</osis>
Markup
An OSIS Commentary differs from an OSIS Bible in that an OSIS Bibles use:
<verse osisID="Gen.1.1">Blah blah...</verse>
But the fundamental mechanism of markup for an OSIS commentary replaces that with:
<div type="section" annotateType="commentary" annotateRef="Gen.1.1"><p>Blah blah...</p></div>
A couple of things to note:
type
This attribute can have any valid value or even be absent. osis2mod will not use this value.
annotateType
This attribute must have the value commentary and will be used to know that we are processing an entry for a commentary.
annotateRef
This attribute can contain any valid osisRef, but the references must not have a work prefix, such as 'Bible:'. The default for all references and the only ones that SWORD supports at this time are Bible references. We'll tackle work prefixes at a later date.
A single reference uses single "osisID":
annotateRef="Gen.1.1"
A range will be of the form, "osisID-osisID":
annotateRef="Gen.1.1-Gen.2.3"
where the first and the second reference are complete osisIDs and they are separated by a - (and no spaces). And the first reference must precede the second.
Discontinuous references are to be separated by whitespace, "osisRef osisRef". For example:
annotateRef="Gen.1.1 Gen1.5"
Importing
osis2mod (>= 1.5.11) is used for both Bibles and Commentaries. See osis2mod for details.
Config file
It's very important that all the necessary properties are included in the .conf file, otherwise the commentary module may not behave as required.
e.g. The module being made from OSIS source text, this property should be specified:
SourceType=OSIS
Otherwise, it would default to Plaintext. For further details, please refer to DevTools:conf Files.
