List of eXtensions to OSIS used in SWORD
- New page under construction.
Contents
Purpose
This page is intended to be a one-stop reference which lists all the extensions to OSIS recognized by the SWORD API.
Introduction
The OSIS reference standard permits custom extensions to XML elements in the form of attribute values with the prefix x-. [1]
Several such extensions are already in use by the SWORD API and are designed to facilitate solutions (or workarounds) to particular requirements that arise in the course of module creation.
Note:
- ↑ In rarer cases, the x-prefix has been used to define an attribute name or even an element name.
The list
- When documenting these extensions in this page, please keep them in alphabetical order.
State clearly which OSIS element and attribute they apply to, and most importantly, include any rules that govern their proper use.
- This list may be incomplete.
x-1, x-2, etc
x-added
This can be used within the seg element as a value of the attribute subType.
It can be used as a workaround for places where the text added by the translator is within a w element. See note in OSIS Bibles.
x-glossary
This can be used within the reference element as a value of the attribute type.
It may be used to link references to items in an ancillary glossary module, and should be accompanied by a valid osisRef attribute.
x-intro
x-preverse
This can be used within the title element as a value of the attribute subType.
It provides a means to correctly display a title just before the current verse. For proper use, the title element must occur within the verse element, or (for milestoned OSIS) after the verse sID milestone and before the eID milestone for the same verse or verse range. Failure to adhere to this rule can have the adverse effect of making the title display before the previous verse, or (worse still) in the previous chapter.
x-testament
x-transChange
x-Strongs:...
x-unit
The div attribute x-unit provides a level of division between book and chapter. It is sometimes used in GenBook modules.
