Difference between revisions of "List of eXtensions to OSIS used in SWORD"

Revision as of 10:03, 28 April 2012

New page under construction.

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.^[2]

Notes:

1. ↑ In rarer cases, the x-prefix has been used to define an attribute name or even an element name.
2. ↑ Not all front-end applications support these extensions to OSIS. For some further details, refer to Choosing a SWORD program.

The list

This list may be incomplete. When adding extensions to 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.
If any are now deprecated for use in new modules, please mention this status, even though existing modules may have made use thereof.

x-1, x-2, etc

These can be used within the seg element as a value of the attribute subType.

They are used along with type="x-variant" to identify whether the reading is the primary or secondary variant. See marking variants.

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-center

x-centered

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.
See the Module Support table in the comparison of notable front-end applications.

x-intro

This can be used within the title element as a value of the attribute type.

It may be used to identify a title for a Bible book introduction. See module support.

x-level-1, x-level-2, etc

x-noindent

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-right

x-testament

This can be used within the div element as a value of the attribute type.

This may be used to indicate one of the two traditional top-level major text divisions of a Bible. See Text Divisions.
It is functionally equivalent to the type attribute value bookGroup. See body under the general structure for OSIS Bibles.

x-transChange

This can be used within the seg element as a value of the attribute type.

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-Strongs:...

This can be used within the w element as a value of the attribute lemma.

The colon is followed by the Strongs reference(s).

x-StrongsMorph:...

This can be used within the w element as a value of the attribute morph.

The colon is followed by the morphology reference.

x-unit

The div attribute x-unit provides a level of division between book and chapter. It is sometimes used in GenBook modules.

x-variant

This can be used within the seg element as a value of the attribute type.

It can be use for marking variants present in different versions of a text. See marking variants.