Languages
English is where the resources start, but they exist in many languages. Two tools say which: one lists the languages, the other says what a language has. An assistant should ask them before it assumes that English is the answer.
Finding a language
list_languages returns the languages that
have resources ready for translation work in the Door43 catalog. Every other tool takes a language code. The server accepts the common forms and settles on the one the catalog
uses:
"es" → Spanish
"spa" → the same language, by its three-letter code
"es-419" → Spanish as used in Latin America- languages
- A list of { code, name, englishName }. name is the language’s own name, often in its own script.
- total_count
- How many languages match, before paging.
- has_more
- True when more come after this page.
- limit, offset
- The page asked for. Pass filter to narrow the list, for example "es" for Spanish variants.
What a language has
Not every language has every resource. list_resources lists what one language has, and with a book it says which resources cover that book.
Many languages publish their own Translation Words and Translation Academy under other organisations
on Door43, not only unfoldingWord. The server finds the right one from the catalog, so the assistant
does not need to know where a language lives.
- available
- One row for each kind of resource the language has: type, subject, abbreviation (ult, tn, tw …), role.
- language, requestedLanguage
- The language answered, which can differ from the one asked after a variant is chosen.
- coversBook, books, bookCount
- On book-scoped rows: whether the book you asked about is covered.
- coverage
- A note that a resource being listed does not promise every book.
Language packs
A language pack is one language’s Door43 resources, prepared ahead of time. The notes, key terms and questions are already read and tidied, and each quoted phrase is already matched to the Greek or Hebrew word it explains and to the words of the language’s own Bible text. Servos, the offline translation app, uses these packs, and this server reads from them too.
When a language or chapter has a pack, the server answers notes and key-term links from it, which is faster. Where there is none, it reads Door43 directly instead, so the tool still answers. Which languages have a pack grows over time. You do not choose, and no tool argument changes.
See Resources for what each help is, and Limits and errors for what the answer is when a language lacks one.