Skip to content

SBL

The default schema according to SBL’s academic style guide.

Whereas a new Schema must have all required properties when constructed, this schema is meant to be used as a default so particular properties can be overidden (see example).

If the property is not set, the default value will be used. Each property is documented below with their default values.

Click into each property’s “Overrides” for more information about that property.

Param

a Partial<Schema>

Example

Extend the default schema

transliterate("שָׁלוֹם", { SHIN: "sh" });
// shālôm

Extends

Constructors

new SBL()

new SBL(schema): SBL

Parameters

ParameterType
schemaPartial<Schema>

Returns

SBL

Overrides

Schema.constructor

Defined in

src/schema.ts:2117

Consonants

ALEF

ALEF: string

Default

"ʾ"

Overrides

Schema.ALEF

Defined in

src/schema.ts:1998


AYIN

AYIN: string

Default

"ʿ"

Overrides

Schema.AYIN

Defined in

src/schema.ts:2042


BET

BET: string

Default

"b"

Overrides

Schema.BET

Defined in

src/schema.ts:2000


BET_DAGESH

BET_DAGESH: undefined | string

Default

undefined

Overrides

Schema.BET_DAGESH

Defined in

src/schema.ts:2002


DALET

DALET: string

Default

"d"

Overrides

Schema.DALET

Defined in

src/schema.ts:2008


DALET_DAGESH

DALET_DAGESH: undefined | string

Default

undefined

Overrides

Schema.DALET_DAGESH

Defined in

src/schema.ts:2010


FINAL_KAF

FINAL_KAF: string

Default

"k"

Overrides

Schema.FINAL_KAF

Defined in

src/schema.ts:2024


FINAL_MEM

FINAL_MEM: string

Default

"m"

Overrides

Schema.FINAL_MEM

Defined in

src/schema.ts:2032


FINAL_NUN

FINAL_NUN: string

Default

"n"

Overrides

Schema.FINAL_NUN

Defined in

src/schema.ts:2036


FINAL_PE

FINAL_PE: string

Default

"p"

Overrides

Schema.FINAL_PE

Defined in

src/schema.ts:2044


FINAL_TSADI

FINAL_TSADI: string

Default

""

Overrides

Schema.FINAL_TSADI

Defined in

src/schema.ts:2050


GIMEL

GIMEL: string

Default

"g"

Overrides

Schema.GIMEL

Defined in

src/schema.ts:2004


GIMEL_DAGESH

GIMEL_DAGESH: undefined | string

Default

undefined

Overrides

Schema.GIMEL_DAGESH

Defined in

src/schema.ts:2006


HE

HE: string

Default

"h"

Overrides

Schema.HE

Defined in

src/schema.ts:2012


HET

HET: string

Default

""

Overrides

Schema.HET

Defined in

src/schema.ts:2018


KAF

KAF: string

Default

"k"

Overrides

Schema.KAF

Defined in

src/schema.ts:2026


KAF_DAGESH

KAF_DAGESH: undefined | string

Default

undefined

Overrides

Schema.KAF_DAGESH

Defined in

src/schema.ts:2028


LAMED

LAMED: string

Default

"l"

Overrides

Schema.LAMED

Defined in

src/schema.ts:2030


MEM

MEM: string

Default

"m"

Overrides

Schema.MEM

Defined in

src/schema.ts:2034


NUN

NUN: string

Default

"n"

Overrides

Schema.NUN

Defined in

src/schema.ts:2038


PE

PE: string

Default

"p"

Overrides

Schema.PE

Defined in

src/schema.ts:2046


PE_DAGESH

PE_DAGESH: undefined | string

Default

undefined

Overrides

Schema.PE_DAGESH

Defined in

src/schema.ts:2048


QOF

QOF: string

Default

"q"

Overrides

Schema.QOF

Defined in

src/schema.ts:2054


RESH

RESH: string

Default

"r"

Overrides

Schema.RESH

Defined in

src/schema.ts:2056


SAMEKH

SAMEKH: string

Default

"s"

Overrides

Schema.SAMEKH

Defined in

src/schema.ts:2040


SHIN

SHIN: string

Default

"š"

Overrides

Schema.SHIN

Defined in

src/schema.ts:2058


SIN

SIN: string

Default

"ś"

Overrides

Schema.SIN

Defined in

src/schema.ts:2060


TAV

TAV: string

Default

"t"

Overrides

Schema.TAV

Defined in

src/schema.ts:2062


TAV_DAGESH

TAV_DAGESH: undefined | string

Default

undefined

Overrides

Schema.TAV_DAGESH

Defined in

src/schema.ts:2064


TET

TET: string

Default

""

Overrides

Schema.TET

Defined in

src/schema.ts:2020


TSADI

TSADI: string

Default

""

Overrides

Schema.TSADI

Defined in

src/schema.ts:2052


VAV

VAV: string

Default

"w"

Overrides

Schema.VAV

Defined in

src/schema.ts:2014


YOD

YOD: string

Default

"y"

Overrides

Schema.YOD

Defined in

src/schema.ts:2022


ZAYIN

ZAYIN: string

Default

"z"

Overrides

Schema.ZAYIN

Defined in

src/schema.ts:2016

Marks

DAGESH

DAGESH: string

Default

""

Overrides

Schema.DAGESH

Defined in

src/schema.ts:1964


DAGESH_CHAZAQ

DAGESH_CHAZAQ: string | boolean

Default

true

Overrides

Schema.DAGESH_CHAZAQ

Defined in

src/schema.ts:1966


MAQAF

MAQAF: string

Default

"-"

Overrides

Schema.MAQAF

Defined in

src/schema.ts:1968


PASEQ

PASEQ: string

Default

""

Overrides

Schema.PASEQ

Defined in

src/schema.ts:1970


SOF_PASUQ

SOF_PASUQ: string

Default

""

Overrides

Schema.SOF_PASUQ

Defined in

src/schema.ts:1972

Orthographic Features

ADDITIONAL_FEATURES

ADDITIONAL_FEATURES: undefined | (WordFeature | SyllableFeature | ClusterFeature)[]

Default

[
{
FEATURE: "syllable",
HEBREW: /[\u{05B4}\u{05BB}]/u,
TRANSLITERATION: (syllable, heb, schema) => {
const hasMater = syllable.clusters.some((cluster) => cluster.isMater);
if (syllable.isAccented && !hasMater) {
const macron = "\u0304";
const output = syllable.hasVowelName("HIRIQ") ? schema["HIRIQ"] + macron : schema["QUBUTS"] + macron;
return syllable.text.replace(heb, output.normalize("NFC"));
}
return syllable.text;
}
}
]

Overrides

Schema.ADDITIONAL_FEATURES

Defined in

src/schema.ts:2092


BET_DAGESH

BET_DAGESH: undefined | string

Default

undefined

Overrides

Schema.BET_DAGESH

Defined in

src/schema.ts:2002


DAGESH_CHAZAQ

DAGESH_CHAZAQ: string | boolean

Default

true

Overrides

Schema.DAGESH_CHAZAQ

Defined in

src/schema.ts:1966


DALET_DAGESH

DALET_DAGESH: undefined | string

Default

undefined

Overrides

Schema.DALET_DAGESH

Defined in

src/schema.ts:2010


DIVINE_NAME

DIVINE_NAME: string

Default

"yhwh"

Overrides

Schema.DIVINE_NAME

Defined in

src/schema.ts:2066


DIVINE_NAME_ELOHIM

DIVINE_NAME_ELOHIM: undefined | string

Default

undefined

Overrides

Schema.DIVINE_NAME_ELOHIM

Defined in

src/schema.ts:2068


FURTIVE_PATAH

FURTIVE_PATAH: string

Default

"a"

Overrides

Schema.FURTIVE_PATAH

Defined in

src/schema.ts:1976


GIMEL_DAGESH

GIMEL_DAGESH: undefined | string

Default

undefined

Overrides

Schema.GIMEL_DAGESH

Defined in

src/schema.ts:2006


HIRIQ_YOD

HIRIQ_YOD: string

Default

"î"

Overrides

Schema.HIRIQ_YOD

Defined in

src/schema.ts:1978


HOLAM_VAV

HOLAM_VAV: string

Default

"ô"

Overrides

Schema.HOLAM_VAV

Defined in

src/schema.ts:1986


KAF_DAGESH

KAF_DAGESH: undefined | string

Default

undefined

Overrides

Schema.KAF_DAGESH

Defined in

src/schema.ts:2028


MS_SUFX

MS_SUFX: string

Default

"āyw"

Overrides

Schema.MS_SUFX

Defined in

src/schema.ts:1996


PATAH_HE

PATAH_HE: undefined | string

Default

undefined

Overrides

Schema.PATAH_HE

Defined in

src/schema.ts:1990


PE_DAGESH

PE_DAGESH: undefined | string

Default

undefined

Overrides

Schema.PE_DAGESH

Defined in

src/schema.ts:2048


QAMATS_HE

QAMATS_HE: string

Default

"â"

Overrides

Schema.QAMATS_HE

Defined in

src/schema.ts:1988


SEGOL_HE

SEGOL_HE: undefined | string

Default

undefined

Overrides

Schema.SEGOL_HE

Defined in

src/schema.ts:1992


SEGOL_YOD

SEGOL_YOD: string

Default

"ê"

Overrides

Schema.SEGOL_YOD

Defined in

src/schema.ts:1982


SHIN

SHIN: string

Default

"š"

Overrides

Schema.SHIN

Defined in

src/schema.ts:2058


SHUREQ

SHUREQ: string

Default

"û"

Overrides

Schema.SHUREQ

Defined in

src/schema.ts:1984


SIN

SIN: string

Default

"ś"

Overrides

Schema.SIN

Defined in

src/schema.ts:2060


STRESS_MARKER

STRESS_MARKER: undefined | {exclude: "never" | "final" | "single";location: "before-syllable" | "after-syllable" | "before-vowel" | "after-vowel";mark: string; }

Default

undefined

Overrides

Schema.STRESS_MARKER

Defined in

src/schema.ts:2094


SYLLABLE_SEPARATOR

SYLLABLE_SEPARATOR: undefined | string

Default

undefined

Overrides

Schema.SYLLABLE_SEPARATOR

Defined in

src/schema.ts:2070


TAV_DAGESH

TAV_DAGESH: undefined | string

Default

undefined

Overrides

Schema.TAV_DAGESH

Defined in

src/schema.ts:2064


TSERE_HE

TSERE_HE: undefined | string

Default

undefined

Overrides

Schema.TSERE_HE

Defined in

src/schema.ts:1994


TSERE_YOD

TSERE_YOD: string

Default

"ê"

Overrides

Schema.TSERE_YOD

Defined in

src/schema.ts:1980

Syllabification

allowNoNiqqud

allowNoNiqqud: undefined | boolean

Default

true

Overrides

Schema.allowNoNiqqud

Defined in

src/schema.ts:2110


article

article: undefined | boolean

Default

true

Overrides

Schema.article

Defined in

src/schema.ts:2108


holemHaser

holemHaser: undefined | "update" | "preserve" | "remove"

Default

"remove"

Overrides

Schema.holemHaser

Defined in

src/schema.ts:2114


ketivQeres

ketivQeres: undefined | KetivQere[]

Default

undefined

Overrides

Schema.ketivQeres

Defined in

src/schema.ts:2116


longVowels

longVowels: undefined | boolean

Default

true

Overrides

Schema.longVowels

Defined in

src/schema.ts:2096


qametsQatan

qametsQatan: undefined | boolean

Default

true

Overrides

Schema.qametsQatan

Defined in

src/schema.ts:2098


shevaAfterMeteg

shevaAfterMeteg: undefined | boolean

Default

true

Overrides

Schema.shevaAfterMeteg

Defined in

src/schema.ts:2100


shevaWithMeteg

shevaWithMeteg: undefined | boolean

Default

false

Overrides

Schema.shevaWithMeteg

Defined in

src/schema.ts:2102


sqnmlvy

sqnmlvy: undefined | boolean

Default

true

Overrides

Schema.sqnmlvy

Defined in

src/schema.ts:2104


strict

strict: undefined | boolean

Default

false

Overrides

Schema.strict

Defined in

src/schema.ts:2112


wawShureq

wawShureq: undefined | boolean

Default

true

Overrides

Schema.wawShureq

Defined in

src/schema.ts:2106

Taamim

MAQAF

MAQAF: string

Default

"-"

Overrides

Schema.MAQAF

Defined in

src/schema.ts:1968


SOF_PASUQ

SOF_PASUQ: string

Default

""

Overrides

Schema.SOF_PASUQ

Defined in

src/schema.ts:1972

Vowel

MS_SUFX

MS_SUFX: string

Default

"āyw"

Overrides

Schema.MS_SUFX

Defined in

src/schema.ts:1996

Vowels

FURTIVE_PATAH

FURTIVE_PATAH: string

Default

"a"

Overrides

Schema.FURTIVE_PATAH

Defined in

src/schema.ts:1976


HATAF_PATAH

HATAF_PATAH: string

Default

"ă"

Overrides

Schema.HATAF_PATAH

Defined in

src/schema.ts:1944


HATAF_QAMATS

HATAF_QAMATS: string

Default

"ŏ"

Overrides

Schema.HATAF_QAMATS

Defined in

src/schema.ts:1946


HATAF_SEGOL

HATAF_SEGOL: string

Default

"ĕ"

Overrides

Schema.HATAF_SEGOL

Defined in

src/schema.ts:1942


HIRIQ

HIRIQ: string

Default

"i"

Overrides

Schema.HIRIQ

Defined in

src/schema.ts:1948


HIRIQ_YOD

HIRIQ_YOD: string

Default

"î"

Overrides

Schema.HIRIQ_YOD

Defined in

src/schema.ts:1978


HOLAM

HOLAM: string

Default

"ō"

Overrides

Schema.HOLAM

Defined in

src/schema.ts:1958


HOLAM_HASER

HOLAM_HASER: string

Default

"ō"

Overrides

Schema.HOLAM_HASER

Defined in

src/schema.ts:1960


HOLAM_VAV

HOLAM_VAV: string

Default

"ô"

Overrides

Schema.HOLAM_VAV

Defined in

src/schema.ts:1986


PATAH

PATAH: string

Default

"a"

Overrides

Schema.PATAH

Defined in

src/schema.ts:1954


PATAH_HE

PATAH_HE: undefined | string

Default

undefined

Overrides

Schema.PATAH_HE

Defined in

src/schema.ts:1990


QAMATS

QAMATS: string

Default

"ā"

Overrides

Schema.QAMATS

Defined in

src/schema.ts:1956


QAMATS_HE

QAMATS_HE: string

Default

"â"

Overrides

Schema.QAMATS_HE

Defined in

src/schema.ts:1988


QAMATS_QATAN

QAMATS_QATAN: string

Default

"o"

Overrides

Schema.QAMATS_QATAN

Defined in

src/schema.ts:1974


QUBUTS

QUBUTS: string

Default

"ū"

Overrides

Schema.QUBUTS

Defined in

src/schema.ts:1962


SEGOL

SEGOL: string

Default

"e"

Overrides

Schema.SEGOL

Defined in

src/schema.ts:1952


SEGOL_HE

SEGOL_HE: undefined | string

Default

undefined

Overrides

Schema.SEGOL_HE

Defined in

src/schema.ts:1992


SEGOL_YOD

SEGOL_YOD: string

Default

"ê"

Overrides

Schema.SEGOL_YOD

Defined in

src/schema.ts:1982


SHUREQ

SHUREQ: string

Default

"û"

Overrides

Schema.SHUREQ

Defined in

src/schema.ts:1984


TSERE

TSERE: string

Default

"ē"

Overrides

Schema.TSERE

Defined in

src/schema.ts:1950


TSERE_HE

TSERE_HE: undefined | string

Default

undefined

Overrides

Schema.TSERE_HE

Defined in

src/schema.ts:1994


TSERE_YOD

TSERE_YOD: string

Default

"ê"

Overrides

Schema.TSERE_YOD

Defined in

src/schema.ts:1980


VOCAL_SHEVA

VOCAL_SHEVA: string

Default

"ə"

Overrides

Schema.VOCAL_SHEVA

Defined in

src/schema.ts:1940