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

Consonants

ALEF

ALEF: string

Default

"ʾ"

Overrides

Schema.ALEF

Defined in

src/schema.ts:1969


AYIN

AYIN: string

Default

"ʿ"

Overrides

Schema.AYIN

Defined in

src/schema.ts:2013


BET

BET: string

Default

"b"

Overrides

Schema.BET

Defined in

src/schema.ts:1971


BET_DAGESH

BET_DAGESH: undefined | string

Default

undefined

Overrides

Schema.BET_DAGESH

Defined in

src/schema.ts:1973


DALET

DALET: string

Default

"d"

Overrides

Schema.DALET

Defined in

src/schema.ts:1979


DALET_DAGESH

DALET_DAGESH: undefined | string

Default

undefined

Overrides

Schema.DALET_DAGESH

Defined in

src/schema.ts:1981


FINAL_KAF

FINAL_KAF: string

Default

"k"

Overrides

Schema.FINAL_KAF

Defined in

src/schema.ts:1995


FINAL_MEM

FINAL_MEM: string

Default

"m"

Overrides

Schema.FINAL_MEM

Defined in

src/schema.ts:2003


FINAL_NUN

FINAL_NUN: string

Default

"n"

Overrides

Schema.FINAL_NUN

Defined in

src/schema.ts:2007


FINAL_PE

FINAL_PE: string

Default

"p"

Overrides

Schema.FINAL_PE

Defined in

src/schema.ts:2015


FINAL_TSADI

FINAL_TSADI: string

Default

""

Overrides

Schema.FINAL_TSADI

Defined in

src/schema.ts:2021


GIMEL

GIMEL: string

Default

"g"

Overrides

Schema.GIMEL

Defined in

src/schema.ts:1975


GIMEL_DAGESH

GIMEL_DAGESH: undefined | string

Default

undefined

Overrides

Schema.GIMEL_DAGESH

Defined in

src/schema.ts:1977


HE

HE: string

Default

"h"

Overrides

Schema.HE

Defined in

src/schema.ts:1983


HET

HET: string

Default

""

Overrides

Schema.HET

Defined in

src/schema.ts:1989


KAF

KAF: string

Default

"k"

Overrides

Schema.KAF

Defined in

src/schema.ts:1997


KAF_DAGESH

KAF_DAGESH: undefined | string

Default

undefined

Overrides

Schema.KAF_DAGESH

Defined in

src/schema.ts:1999


LAMED

LAMED: string

Default

"l"

Overrides

Schema.LAMED

Defined in

src/schema.ts:2001


MEM

MEM: string

Default

"m"

Overrides

Schema.MEM

Defined in

src/schema.ts:2005


NUN

NUN: string

Default

"n"

Overrides

Schema.NUN

Defined in

src/schema.ts:2009


PE

PE: string

Default

"p"

Overrides

Schema.PE

Defined in

src/schema.ts:2017


PE_DAGESH

PE_DAGESH: undefined | string

Default

undefined

Overrides

Schema.PE_DAGESH

Defined in

src/schema.ts:2019


QOF

QOF: string

Default

"q"

Overrides

Schema.QOF

Defined in

src/schema.ts:2025


RESH

RESH: string

Default

"r"

Overrides

Schema.RESH

Defined in

src/schema.ts:2027


SAMEKH

SAMEKH: string

Default

"s"

Overrides

Schema.SAMEKH

Defined in

src/schema.ts:2011


SHIN

SHIN: string

Default

"š"

Overrides

Schema.SHIN

Defined in

src/schema.ts:2029


SIN

SIN: string

Default

"ś"

Overrides

Schema.SIN

Defined in

src/schema.ts:2031


TAV

TAV: string

Default

"t"

Overrides

Schema.TAV

Defined in

src/schema.ts:2033


TAV_DAGESH

TAV_DAGESH: undefined | string

Default

undefined

Overrides

Schema.TAV_DAGESH

Defined in

src/schema.ts:2035


TET

TET: string

Default

""

Overrides

Schema.TET

Defined in

src/schema.ts:1991


TSADI

TSADI: string

Default

""

Overrides

Schema.TSADI

Defined in

src/schema.ts:2023


VAV

VAV: string

Default

"w"

Overrides

Schema.VAV

Defined in

src/schema.ts:1985


YOD

YOD: string

Default

"y"

Overrides

Schema.YOD

Defined in

src/schema.ts:1993


ZAYIN

ZAYIN: string

Default

"z"

Overrides

Schema.ZAYIN

Defined in

src/schema.ts:1987

Marks

DAGESH

DAGESH: string

Default

""

Overrides

Schema.DAGESH

Defined in

src/schema.ts:1937


DAGESH_CHAZAQ

DAGESH_CHAZAQ: string | boolean

Default

true

Overrides

Schema.DAGESH_CHAZAQ

Defined in

src/schema.ts:1939


MAQAF

MAQAF: string

Default

"-"

Overrides

Schema.MAQAF

Defined in

src/schema.ts:1941


PASEQ

PASEQ: string

Default

""

Overrides

Schema.PASEQ

Defined in

src/schema.ts:1943


SOF_PASUQ

SOF_PASUQ: string

Default

""

Overrides

Schema.SOF_PASUQ

Defined in

src/schema.ts:1945

Orthographic Features

ADDITIONAL_FEATURES

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

Default

undefined

Overrides

Schema.ADDITIONAL_FEATURES

Defined in

src/schema.ts:2043


BET_DAGESH

BET_DAGESH: undefined | string

Default

undefined

Overrides

Schema.BET_DAGESH

Defined in

src/schema.ts:1973


DAGESH_CHAZAQ

DAGESH_CHAZAQ: string | boolean

Default

true

Overrides

Schema.DAGESH_CHAZAQ

Defined in

src/schema.ts:1939


DALET_DAGESH

DALET_DAGESH: undefined | string

Default

undefined

Overrides

Schema.DALET_DAGESH

Defined in

src/schema.ts:1981


DIVINE_NAME

DIVINE_NAME: string

Default

"yhwh"

Overrides

Schema.DIVINE_NAME

Defined in

src/schema.ts:2037


DIVINE_NAME_ELOHIM

DIVINE_NAME_ELOHIM: undefined | string

Default

undefined

Overrides

Schema.DIVINE_NAME_ELOHIM

Defined in

src/schema.ts:2039


FURTIVE_PATAH

FURTIVE_PATAH: string

Default

"a"

Overrides

Schema.FURTIVE_PATAH

Defined in

src/schema.ts:1949


GIMEL_DAGESH

GIMEL_DAGESH: undefined | string

Default

undefined

Overrides

Schema.GIMEL_DAGESH

Defined in

src/schema.ts:1977


HIRIQ_YOD

HIRIQ_YOD: string

Default

"î"

Overrides

Schema.HIRIQ_YOD

Defined in

src/schema.ts:1951


HOLAM_VAV

HOLAM_VAV: string

Default

"ô"

Overrides

Schema.HOLAM_VAV

Defined in

src/schema.ts:1959


KAF_DAGESH

KAF_DAGESH: undefined | string

Default

undefined

Overrides

Schema.KAF_DAGESH

Defined in

src/schema.ts:1999


MS_SUFX

MS_SUFX: string

Default

"āyw"

Overrides

Schema.MS_SUFX

Defined in

src/schema.ts:1967


PE_DAGESH

PE_DAGESH: undefined | string

Default

undefined

Overrides

Schema.PE_DAGESH

Defined in

src/schema.ts:2019


QAMATS_HE

QAMATS_HE: string

Default

"â"

Overrides

Schema.QAMATS_HE

Defined in

src/schema.ts:1961


SEGOL_HE

SEGOL_HE: string

Default

"ê"

Overrides

Schema.SEGOL_HE

Defined in

src/schema.ts:1963


SEGOL_YOD

SEGOL_YOD: string

Default

"ê"

Overrides

Schema.SEGOL_YOD

Defined in

src/schema.ts:1955


SHIN

SHIN: string

Default

"š"

Overrides

Schema.SHIN

Defined in

src/schema.ts:2029


SHUREQ

SHUREQ: string

Default

"û"

Overrides

Schema.SHUREQ

Defined in

src/schema.ts:1957


SIN

SIN: string

Default

"ś"

Overrides

Schema.SIN

Defined in

src/schema.ts:2031


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:2045


SYLLABLE_SEPARATOR

SYLLABLE_SEPARATOR: undefined | string

Default

undefined

Overrides

Schema.SYLLABLE_SEPARATOR

Defined in

src/schema.ts:2041


TAV_DAGESH

TAV_DAGESH: undefined | string

Default

undefined

Overrides

Schema.TAV_DAGESH

Defined in

src/schema.ts:2035


TSERE_HE

TSERE_HE: string

Default

"ê"

Overrides

Schema.TSERE_HE

Defined in

src/schema.ts:1965


TSERE_YOD

TSERE_YOD: string

Default

"ê"

Overrides

Schema.TSERE_YOD

Defined in

src/schema.ts:1953

Other

new SBL()

new SBL(schema): SBL

Parameters

ParameterType
schemaPartial<Schema>

Returns

SBL

Overrides

Schema.constructor

Defined in

src/schema.ts:2066

Syllabification

allowNoNiqqud

allowNoNiqqud: undefined | boolean

Default

true

Overrides

Schema.allowNoNiqqud

Defined in

src/schema.ts:2061


article

article: undefined | boolean

Default

true

Overrides

Schema.article

Defined in

src/schema.ts:2059


holemHaser

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

Default

"remove"

Overrides

Schema.holemHaser

Defined in

src/schema.ts:2065


longVowels

longVowels: undefined | boolean

Default

true

Overrides

Schema.longVowels

Defined in

src/schema.ts:2047


qametsQatan

qametsQatan: undefined | boolean

Default

true

Overrides

Schema.qametsQatan

Defined in

src/schema.ts:2049


shevaAfterMeteg

shevaAfterMeteg: undefined | boolean

Default

true

Overrides

Schema.shevaAfterMeteg

Defined in

src/schema.ts:2051


shevaWithMeteg

shevaWithMeteg: undefined | boolean

Default

false

Overrides

Schema.shevaWithMeteg

Defined in

src/schema.ts:2053


sqnmlvy

sqnmlvy: undefined | boolean

Default

true

Overrides

Schema.sqnmlvy

Defined in

src/schema.ts:2055


strict

strict: undefined | boolean

Default

false

Overrides

Schema.strict

Defined in

src/schema.ts:2063


wawShureq

wawShureq: undefined | boolean

Default

true

Overrides

Schema.wawShureq

Defined in

src/schema.ts:2057

Taamim

MAQAF

MAQAF: string

Default

"-"

Overrides

Schema.MAQAF

Defined in

src/schema.ts:1941


SOF_PASUQ

SOF_PASUQ: string

Default

""

Overrides

Schema.SOF_PASUQ

Defined in

src/schema.ts:1945

Vowel

MS_SUFX

MS_SUFX: string

Default

"āyw"

Overrides

Schema.MS_SUFX

Defined in

src/schema.ts:1967

Vowels

FURTIVE_PATAH

FURTIVE_PATAH: string

Default

"a"

Overrides

Schema.FURTIVE_PATAH

Defined in

src/schema.ts:1949


HATAF_PATAH

HATAF_PATAH: string

Default

"ă"

Overrides

Schema.HATAF_PATAH

Defined in

src/schema.ts:1917


HATAF_QAMATS

HATAF_QAMATS: string

Default

"ŏ"

Overrides

Schema.HATAF_QAMATS

Defined in

src/schema.ts:1919


HATAF_SEGOL

HATAF_SEGOL: string

Default

"ĕ"

Overrides

Schema.HATAF_SEGOL

Defined in

src/schema.ts:1915


HIRIQ

HIRIQ: string

Default

"i"

Overrides

Schema.HIRIQ

Defined in

src/schema.ts:1921


HIRIQ_YOD

HIRIQ_YOD: string

Default

"î"

Overrides

Schema.HIRIQ_YOD

Defined in

src/schema.ts:1951


HOLAM

HOLAM: string

Default

"ō"

Overrides

Schema.HOLAM

Defined in

src/schema.ts:1931


HOLAM_HASER

HOLAM_HASER: string

Default

"ō"

Overrides

Schema.HOLAM_HASER

Defined in

src/schema.ts:1933


HOLAM_VAV

HOLAM_VAV: string

Default

"ô"

Overrides

Schema.HOLAM_VAV

Defined in

src/schema.ts:1959


PATAH

PATAH: string

Default

"a"

Overrides

Schema.PATAH

Defined in

src/schema.ts:1927


QAMATS

QAMATS: string

Default

"ā"

Overrides

Schema.QAMATS

Defined in

src/schema.ts:1929


QAMATS_HE

QAMATS_HE: string

Default

"â"

Overrides

Schema.QAMATS_HE

Defined in

src/schema.ts:1961


QAMATS_QATAN

QAMATS_QATAN: string

Default

"o"

Overrides

Schema.QAMATS_QATAN

Defined in

src/schema.ts:1947


QUBUTS

QUBUTS: string

Default

"ū"

Overrides

Schema.QUBUTS

Defined in

src/schema.ts:1935


SEGOL

SEGOL: string

Default

"e"

Overrides

Schema.SEGOL

Defined in

src/schema.ts:1925


SEGOL_HE

SEGOL_HE: string

Default

"ê"

Overrides

Schema.SEGOL_HE

Defined in

src/schema.ts:1963


SEGOL_YOD

SEGOL_YOD: string

Default

"ê"

Overrides

Schema.SEGOL_YOD

Defined in

src/schema.ts:1955


SHUREQ

SHUREQ: string

Default

"û"

Overrides

Schema.SHUREQ

Defined in

src/schema.ts:1957


TSERE

TSERE: string

Default

"ē"

Overrides

Schema.TSERE

Defined in

src/schema.ts:1923


TSERE_HE

TSERE_HE: string

Default

"ê"

Overrides

Schema.TSERE_HE

Defined in

src/schema.ts:1965


TSERE_YOD

TSERE_YOD: string

Default

"ê"

Overrides

Schema.TSERE_YOD

Defined in

src/schema.ts:1953


VOCAL_SHEVA

VOCAL_SHEVA: string

Default

"ǝ"

Overrides

Schema.VOCAL_SHEVA

Defined in

src/schema.ts:1913