Go to file
unfoldingWord f7845cac89 Update twl_JOB.tsv from master to prepare for book package release
Signed-off-by: unfoldingWord <info@unfoldingword.org>
2024-08-14 22:42:35 +00:00
LICENSE.md Version 11 2022-03-31 11:29:08 -06:00
README.md Fix missed dash 2021-09-01 03:30:00 +00:00
manifest.yaml Replace Manifest with valid YAML file 2024-08-14 22:25:15 +00:00
twl_1CO.tsv Update twl_1CO.tsv from master to prepare for book package release 2024-08-14 22:38:52 +00:00
twl_1JN.tsv Update twl_1JN.tsv from master to prepare for book package release 2024-08-14 22:41:03 +00:00
twl_1PE.tsv Update twl_1PE.tsv from master to prepare for book package release 2024-08-14 22:40:37 +00:00
twl_1TH.tsv Update twl_1TH.tsv from master to prepare for book package release 2024-08-14 22:39:42 +00:00
twl_1TI.tsv Update twl_1TI.tsv from master to prepare for book package release 2024-08-14 22:40:02 +00:00
twl_2CO.tsv Update twl_2CO.tsv from master to prepare for book package release 2024-08-14 22:39:02 +00:00
twl_2JN.tsv Update twl_2JN.tsv from master to prepare for book package release 2024-08-14 22:41:11 +00:00
twl_2PE.tsv Update twl_2PE.tsv from master to prepare for book package release 2024-08-14 22:40:51 +00:00
twl_2TH.tsv Update twl_2TH.tsv from master to prepare for book package release 2024-08-14 22:39:55 +00:00
twl_2TI.tsv Update twl_2TI.tsv from master to prepare for book package release 2024-08-14 22:40:05 +00:00
twl_3JN.tsv Update twl_3JN.tsv from master to prepare for book package release 2024-08-14 22:41:18 +00:00
twl_ACT.tsv Update twl_ACT.tsv from master to prepare for book package release 2024-08-14 22:38:23 +00:00
twl_COL.tsv Update twl_COL.tsv from master to prepare for book package release 2024-08-14 22:39:31 +00:00
twl_EPH.tsv Update twl_EPH.tsv from master to prepare for book package release 2024-08-14 22:39:16 +00:00
twl_EST.tsv Update twl_EST.tsv from master to prepare for book package release 2024-08-14 22:42:27 +00:00
twl_EXO.tsv Update twl_EXO.tsv from master to prepare for book package release 2024-08-14 22:41:49 +00:00
twl_EZR.tsv Update twl_EZR.tsv from master to prepare for book package release 2024-08-14 22:42:11 +00:00
twl_GAL.tsv Update twl_GAL.tsv from master to prepare for book package release 2024-08-14 22:39:11 +00:00
twl_GEN.tsv Update twl_GEN.tsv from master to prepare for book package release 2024-08-14 22:41:39 +00:00
twl_HEB.tsv Update twl_HEB.tsv from master to prepare for book package release 2024-08-14 22:40:21 +00:00
twl_JAS.tsv Update twl_JAS.tsv from master to prepare for book package release 2024-08-14 22:40:30 +00:00
twl_JHN.tsv Update twl_JHN.tsv from master to prepare for book package release 2024-08-14 22:38:11 +00:00
twl_JOB.tsv Update twl_JOB.tsv from master to prepare for book package release 2024-08-14 22:42:35 +00:00
twl_JUD.tsv Update twl_JUD.tsv from master to prepare for book package release 2024-08-14 22:41:25 +00:00
twl_LUK.tsv Update twl_LUK.tsv from master to prepare for book package release 2024-08-14 22:38:02 +00:00
twl_MAT.tsv Update twl_MAT.tsv from master to prepare for book package release 2024-08-14 22:37:47 +00:00
twl_MRK.tsv Update twl_MRK.tsv from master to prepare for book package release 2024-08-14 22:37:54 +00:00
twl_NEH.tsv Update twl_NEH.tsv from master to prepare for book package release 2024-08-14 22:42:19 +00:00
twl_PHM.tsv Update twl_PHM.tsv from master to prepare for book package release 2024-08-14 22:40:15 +00:00
twl_PHP.tsv Update twl_PHP.tsv from master to prepare for book package release 2024-08-14 22:39:22 +00:00
twl_REV.tsv Update twl_REV.tsv from master to prepare for book package release 2024-08-14 22:41:31 +00:00
twl_ROM.tsv Update twl_ROM.tsv from master to prepare for book package release 2024-08-14 22:38:40 +00:00
twl_RUT.tsv Update twl_RUT.tsv from master to prepare for book package release 2024-08-14 22:42:01 +00:00
twl_TIT.tsv Update twl_TIT.tsv from master to prepare for book package release 2024-08-14 22:40:10 +00:00

README.md

en_twl

Links from the original Bible languages to Translation Words.

Previously the links in UHB and UGNT were used (but that didn't enable the links to be customized for Gateway Languages).

Editing the TWL

To edit the TWL files there are three options:

  • Use LibreOffice (Recommended)
  • Use a text editor on your computer
  • Use the online web editor in DCS

Each of these options and their caveats are described below.

The first two options require you to clone the repository to your computer first. You may do this on the command line or using a program such as SmartGit. After making changes to the files you will need to commit and push your changes to the server and then create a Pull Request to merge them to the master branch.

Alternately, you may download the master branch as a zip file and extract that locally. After editing you would need to use the upload file feature in DCS to get your changes ready for a Pull Request.

Editing in LibreOffice

This is the recommended way to edit the TSV files. You may download LibreOffice for free.

After you have the file on your computer, you may open the respective TSV file with LibreOffice. Follow these notes on the Text Import Screen:

  • Set “Separated by” to “Tab”
  • Set “Text Delimiter” to blank, you will need to highlight the character and use backspace or delete to remove it

It should look like this:

Screenshot of LibreOffice Text Import dialog

When you are done editing, click Save and then select “Use Text CSV Format” on the pop up dialogue. Note that even though it says CSV, it will use tab characters as the field separators.

Note: Other spreadsheet editors should not be used because they will add or remove quotation marks which will affect the entries negatively.

Editing in a Text Editor

You may also use a regular text editor to make changes to the files.

Note: You must be careful not to delete or add any tab characters when editing with this method.

Editing in DCS

If you only need to change a word or two, this may be the quickest way to make your change. See the protected branch workflow document for step by step instructions.

Note: You must be careful not to delete any tab characters when editing with this method.

Structure

The TWL are structured as TSV files to simplify importing and exporting into various formats for translation and presentation. The TWLs are keyed to the original Greek and Hebrew text, but clones of this repository can be made for the Gateway Languages (GLs), and then the TW links can be adjusted to accommodate the workings of those languages.

TSV Format Overview

A Tab Separated Value (TSV) file is like a Comma Separated Value file except that the tab character is what divides the values instead of a comma. This makes it easier to include prose text in the files because many languages require the use of commas, single quotes, and double quotes in their sentences and paragraphs.

The TWL are structured as one file per book of the Bible and encoded in TSV format, for example, twl_GEN.tsv. The six columns are Reference, ID, Tags, OrigWords, Occurrence, and TWLink.

TWL TSV Column Description

The following lists each column with a brief description and example.

  • Reference: Chapter number (e.g. 1) then colon then verse number (e.g. 3) or intro
  • ID: Four character alphanumeric string unique within the verse for the resource (e.g. swi9)
    • This will be helpful in identifing which links came from the English resources and which links have been added by GLs.
    • The Universal ID (UID) of a note is the combination of the Book, Chapter, Verse, and ID values. For example, tit/1/3/swi9.
      • This is a useful way to unambiguously refer to links.
      • An RC link can resolve to a specific note like this: rc://en/tn/help/tit/01/01/swi9.
  • Tags: (optional) any of keyterm or name, separated by ; if there's more than one
  • OrigWords: Original language quote (e.g. ἐφανέρωσεν↔τὸν λόγον αὐτοῦ) but most often just one word
  • Occurrence: Specifies which occurrence in the original language text the entry applies to.
    • -1: entry applies to every occurrence of OrigWords in the verse
    • 0: entry does not occur in original language (for example, “Connecting Statement:”)
    • 1: entry applies to first occurrence of OrigWords only
    • 2: entry applies to second occurrence of OrigWords only
    • etc.
  • TWLink: A Resource Container link to a TranslationWords article, e.g., rc://*/tw/dict/bible/other/peace