Target Text

ClearAligner's TSV file format.

ClearAligner uses a simple TSV file format to describe tokenized texts. Starting a project is as easy as importing a TSV file representing the text. The required columns are id, text, and source_verse. UTF-8 encoding is expected.

How do I generate a TSV for my project?

We have created a toolkit called Kathairo for generating TSVs from USFM. We also have a public repository that contains checked TSVs for openly-licensed texts. If find a problem with an existing TSV or need help generating a new one, create an issue here.

What does ClearAligner's TSV format look like?

Example

id	source_verse	text	skip_space_after	exclude
01001001001	01001001	Hapo
01001001002	01001001	mwanzo
01001001003	01001001	Mungu
01001001004	01001001	aliumba
01001001005	01001001	mbingu
01001001006	01001001	na
01001001007	01001001	dunia	y
01001001008	01001001	.		y

Details

Column: `id`

The id column should contain BCVW values correlating to the target text's native versification:

• Book: 2 characters

• Chapter: 3 characters

• Verse: 3 characters

• Word: 3 characters

Column: `source_verse`

The source_verse column should contain BCV correlating to the source text versification (often referred to as org).

What is this column for?

Bible editions may use different approaches to identify the same verse content. For example, most English Bibles identify Malachi’s statement, “Behold, I will send you Elijah the prophet before the great and awesome day of the LORD comes.” as Malachi chapter 4, verse 5. However, Hebrew Bibles designate this content as Mal 3:23. These schemes are called the versification of the Bible, and there are several common systems and ways to map between them.

ClearAligner allows users to navigate scripture via a versification scheme that is native to the target text. The source_verse column maps targets tokens in to source (aka org) versification scheme.

Column: `text`

The text column should contain UTF-8 tokens representing the text to be aligned.

Column: `skip_space_after`

The skip_space_aftercolumn is used to correctly render spaces between tokens when displaying the text. If empty, ClearAligner assumes a falsy value. If value yis present, the result is truthy.

Column: `exclude`

Theexcludecolumn is used to mark tokens that should be displayed (for correct rendering of the text) but cannot be aligned. If empty, ClearAligner assumes a falsy value. If value yis present, the token will be displayed but cannot be aligned. It is common to exclude punctuation tokens from alignment.