Инструкция по созданию модулей для программы Bzoom

1. Что такое «модуль» и для чего нужна данная инструкция

Под модулем программы Bzoom понимается специальная база данных в виде набора текстовых файлов, в которых хранится текст определенного перевода или любого другого материала.

Данная инструкция раскрывает  формат модуля для того, чтобы любой желающий пользователь Bzoom, мог создавать свои собственные модули и, таким образом, расширял бы функциональные возможности программы.

По умолчанию в первой версии Bzoom включены следующие модули:

rst – Русский Синодальный перевод

kassian - Перевод под редакцией Кассиана

ukr – Украинская Библия - Біблія (переклад Огієнка)

kjv – Английская версия - King James Version

eliza - Елизаветинская Библия (1751 год)

cars - Восточный смысловой перевод (CARS)

2. Структура модуля

Все пользовательские модули находятся в каталоге «usermod». Каждый отдельный модуль имеет свой каталог с сокращенным именем (латин. без пробелов и спец. символов). В каталоге модуля находятся текстовые файлы в формате Unicode (UTF-8).

Для каждой отдельной главы в Библии создается отдельный файл со следующим именем 

name10.bzt

 , где 

name – сокращенное имя модуля (такое же имя у каталога модуля)

10 – номер книги (интервал номеров книг для ВЗ: от -1 до -39 (отрицательные значения), для НЗ: от 1 до 27)

Так же в каталоге модуля должен иметься текстовый файл с именем info.txt так же в формате Unicode (UTF-8). В данном файле храниться общая информация о модуле.

3. Формат файлов модуля

Каждый файл книги имеет следующий текстовый формат:

В каждой новой строке должна находиться запись в формате: ~G~S@Text

, где

G – номер главы

S – номер стиха

Text – текст данного стиха

Например:

~1~1@В начале сотворил Бог небо и землю.

~1~2@Земля же была безвидна и пуста, и тьма над бездною, и Дух Божий носился над водою.

~1~3@И сказал Бог: да будет свет. И стал свет.

О формате файла info.txt

В этом файле две обязательных строки: 

первая строка должна содержать краткое название модуля (см. п.2), 

вторая полное название модуля .

Например:

cars

Восточный смысловой (CARS)