Описание формата модулей для Цитаты из Библии

Версия от 12.07.2011 21:25 UTC+02:00

Файл BibleQt.ini - основной файл любого модуля в программе Цитата из Библии. Большинство ошибок в работе модулей вызвано неправильным его оформлением.

Этот файл содержит информацию о модуле, и настройки его отображения в программе. Располагается в корневой папке (архиве) модуля.

ВНИМАНИЕ! Формат файла bibleqt.ini (UTF или ANSI) должен совпадать с форматом текстовых файлов модуля и параметром DefaultEncoding в самом файле.

Описание параметров в файле BibleQt.ini (обязательные отмечены *)

Существующие параметры (ключи)
Имя параметра	Функции параметра	Формат параметра (условия и ограничения)
BibleName *	Полное название модуля	на языке модуля, по возможности согласно печатному изданию. Должен быть уникальным для каждого модуля.
BibleShortName *	Короткое название модуля (сокращение). Используется в закладках "избранного" и кратких подписях после отрывка при копировании цитат.	Должен быть уникальным для каждого модуля. Параметр только английскими символами (по возможности - см.ниже). Совпадает с названием папки модуля\архива (желательно). Язык через знак подчеркивания, в тех модулях, которые существуют на нескольких языках, а затем год через знак подчеркивания где есть несколько отличающихся изданий. Если существует устоявшееся литературное сокращение для перевода, то используется оно, например: Септуагинта – LXX, Русский Синодальный перевод – РСП, Перевод В. кузнецовой – РВ, Византийский тип текста (Majority Text) принято обозначать буквой 𝔐.
Copyright	Авторские права	Указывается год издания и правообладатель Подразумевает наличие файла copyright.htm в корневом каталоге модуля. Если не указано ничего параметр приравнивается PublicDomainText из файла интерфейса языка lng. Если указать правообладателя, то Цитата будет показывать указанный текст и при нажатии на кнопку копирайта перебросит на страницу Copyright с данными из файла copyright.htm.
copyright.htm	Файл содержащий информацию об авторских правах и о переводе	по возможности предоставить обложки всех книг, которые входят в модуль. Название, автор (или главный редактор), год издания, издательства.
Bible *	Тип модуля (Библия, комментарий, книга) Bible Commentary Book	Ставится Y если это Библия или комментарий, N если это книга
OldTestament *	Наличие в модуле книг или комментариев Ветхого Завета (39 книг согласно файлу BibleBooks.cfg в корневой директории Ц.)	Этот параметр может быть равен Y только если *Bible=Y*
NewTestament *	Наличие в модуле книг или комментариев Нового Завета (27 книг согласно файлу BibleBooks.cfg в корневой директории Ц.)	Этот параметр может быть равен Y только если *Bible=Y*
Apocrypha *	Наличие в модуле второканонических книг или комментариев (11 книг согласно файлу BibleBooks.cfg в корневой директории Ц.)	Этот параметр может быть равен Y только если *Bible=Y*
ChapterZero	Наличие в модуле нулевой главы	Этот параметр влияет на отображение номеров глав в панели управления и на синхронизацию при переходе между модулями. Ставится Y тогда, когда есть вступление к книге. Если ChapterZero=Y, то нулевая глава синхронизируется с файлом 001.* в папке с аудиокнигой, первая – с 002.* и т.д.
EnglishPsalms	Использование в модуле английской нумерации стихов	Если EnglishPsalms=Y, то нумерация изменяется с принятой в РСП следующим образом: (фрагмент программного кода) JOB=40:1-40:5#-1;41:1-41:8#-1 JOB40=1-5#30;6-24#-5 JOB41=1-8#19;9-34#-8 PSA=10:1-147:11#-1 ECC=5:1#-1 SNG=6:13#+1 DAN=4:1-4:3#-1 DAN3=24-30#67 DAN4=1-3#97;4-37#-3 JON=1:17#1 ROM=16:25-16:27#-2 ROM16=25-27#-1 ECC5=1#16;2-20#-1 SNG1=2-16#-1 SNG6=13#-12 SNG7=1-13#1 JON2=1-10#1 PRO13=14-25#1 PRO18=8-24#1 2CO13=13#-1 Этот параметр может быть равен Y только если *Bible=Y*
StrongNumber	Наличие в модуле номеров Стронга	Ставится Y тогда, когда в модуле есть номера Стронга. Этот параметр может быть равен Y только если *Bible=Y*
StrongsDirectory	Путь к директории с номерами Стронга, которая соответствует модулю	Путь к папке с номерами Стронга. Если этот параметр не указан, но в модуле присутствуют номера Стронга, то информация будет извлекаться из директории *Strongs*. Работает только для модулей-Библий.
SoundDirectory	Путь к директории с аудио-файлами для книг (частей) модуля	В этом параметре можно указать относительный путь к папке с аудиокнигой к модулю. Звуковые файлы для Библии по умолчанию лежат в папке Sounds. О правилах оформления аудиокниг для Ц. см. соотв. раздел. Работает только для модулей-Библий.
NoForcedLineBreaks	Разделение не на стихи, а на абзацы	Стихи не отображаются в виде абзацев принудительно. Ставится Y тогда, стихи отображаются «сплошняком», если нет тегов <br> или аналогичных (их конечно необходимо указать в HTMLFilter).
HTMLFilter *	HTML-теги, которые будет понимать программа.	Указываются через пробел нижним регистром (малыми буквами). Для парных тегов указываются открытая и закрытая формы. По умолчанию Ц. «понимает» только теги <i></i>, <b></b>, <u></u>, <h1-6></h1-6>. Часто используемые теги, которые Цитата корректно обрабатывает Абзац: <br> <p <p> </p> <pre> </pre> <span </span> Параметры шрифтов: <font </font> <sup> </sup> <sub> </sub> <center> </center> <strong> </strong> <em> </em> Таблицы: <table </table> <tr <tr> </tr> <td <td> </td> <th> <th </th> <hr <hr> Списки: <ol </ol> <ul> </ul> <li> </li> Картинки: <img Гиперссылки: <a </a> - подключает псевдотеги <a name и <a class (см. ниже) Существует ряд тегов, которые Цитата обрабатывает некорректно, так как они не используются для форматирования текста модулей. Это, в частности, элементы управления (книпки, формы и т.д.) Поиск Цитата осуществляет в HTML-коде, а не в тексте, что следует учитывать при разметке модулей. Например, если в файле присутствуют комментарии вида <!--12345-->, то Цитата будет при поиске находить текст «1234», и выдавать ссылку на соответствующий стих/абзац, при этом не отображая самого текста «1234». Большинство вышеуказанных HTML-тегов также корректно обрабатывается в пользовательских заметках.
Language	Язык модуля	Стандартное сокращение языка латиницей из трех символов по стандарту iso-639-3
InstallFonts	Внедрение шрифтов в программу из папки модуля, не устанавливая их в OS Fonts Install Pending	Файлы шрифтов для подгрузки должны лежать в корне модуля. Перечисляются через запятую без пробелов с указанием расширения. В названиях файлов пробелы допускаются. Напр. InstallFonts=Greek Uncials.ttf,GU Greek.ttf,GU Hebrew.ttf,NetBibleGreek.ttf
DesiredFontName	Шрифт, который будет использовать программа для отображения текста книг (частей) в главном окне.	Если *DesiredFontName* совпадает не только с названием шрифта, но и с названием файла шрифта (без указания расширения TTF), то программа автоматически подгрузит его при обращении к модулю. Поэтому файл со специальным шрифтом при создании модуля нужно называть по имени шрифта (с добавлением расширения TTF). Указывается шрифт поддерживающий Unicode: Arial, Comic Sans MS, Courier New, Microsoft Sans Serif, Times New Roman. Рекомендуем использовать Times New Roman для Vista и 7, а Microsoft Sans Serif для XP.
Categories *	Привязка модуля к категориям	По-умолчанию программа разделяет Библии на категории ВЗ, НЗ, апокрифы. Необходимо указывать для Библии дополнительные параметры: \|Язык\|Тип перевода\|Конфессия\| Для книг указывать тему, ключевые слова (теги).
DesiredFontPath	Путь к файлу шрифта
DefaultEncoding *	Кодировка модуля по умолчанию	Параметр по умолчанию равен utf-8. *Windows-1250* для языков Центральной Европы, которые используют латинское написание букв (польский, чешский, словацкий, венгерский, словенский, хорватский, румынский и албанский) *Windows-1251* для кириллических алфавитов *Windows-1252* для западных языков *Windows-1253* для греческого языка *Windows-1254* для турецкого языка *Windows-1255* для иврита *Windows-1256* для арабского языка *Windows-1257* для балтийских языков *Windows-1258* для вьетнамского языка Utf-8, *Utf-16* и *Utf-32* набора символов Юникод
DesiredUIFont	Определяет шрифт заголовков названий книг	Отличается от DesiredFontName
UseCustomUIFont	Назначение параметра не установлено
UseRightAlignment	Поддержка правого выравнивания	Ставится Y тогда, когда в модуле весь текст нужно отображать по правому краю.
UseChapterHead	Поддержка отображения заголовков глав	Отображает предисловие в виде нулевого стиха без номера, если оно присутствует между знаком главы и знаком первого стиха.
ChapterSign *	Признак начала глав в модуле	Может быть тегом HTML, напр. <hr> или псевдотегом, напр. #bqchapter Не должен совпадать с VerseSign. В файле должен стоять в начале строки (не внутри!) Регистр в файле должен совпадать с описанным в bibleqt.ini. Например: Если в файле книги стоят теги <HR>, а в bibleqt.ini <hr> - программа не будет открывать модуль.
VerseSign *	Признак начала стихов в модуле	Может быть тегом HTML, напр. <p или псевдотегом, напр. #bqverse В файле должен стоять в начале строки (не внутри!) Регистр в файле должен совпадать с описанным в bibleqt.ini. Например: Если в файле книги стоят теги <p>, а в bibleqt.ini <P> - программа не будет открывать книгу модуля.
BookQty *	Количество книг в модуле	Максимальное количество книг в одном модуле 256 шт. Обязательно должно совпадать по количеству с параметром PathName (см. ниже)
Дальнейшие параметры указываются для каждой отдельной книги (части модуля), т.е. описываются столько раз, сколько указано в параметре BookQty
PathName	Имя файла с книгой (частью)	Указывается имя файла, «точка» и тип файла. Напр. 01.html
FullName	Полное название книги (части)	Указывается на языке модуля.
ShortName	Короткие названия книги (части)	Первыми указываются сокращения, используемые для языка модуля, далее сокращения из файла BibleBooks.cfg Это необходимо для нормального перемещения между модулями по запросам из командной строки и корректного отображения подписей к стиху (при копировании и в параллельных местах), а также для корректного сравнения книг в неполных модулях.
ChapterQty	Количество глав в книге (части) модуля	Должно совпадать с с количеством ChapterSign в соответствующем файле.

Желаемые (или анонсированные) параметры (ключи)
CommentariesDirectory	Путь к директории с комментариями, которые соответствуют модулю
Dictionary	Путь к idx-файлу словаря, который соответствует модулю	Напр. Dictionary = gr_parsed.idx
Language	Язык модуля	Стандартное сокращение языка латиницей из трех символов по стандарту iso-639-3 Этот параметр понимает программа ClipboardQuote
BookUniqueId	Уникальный идентификатор для книги
GenericBookId		C форума: У любого библейского модуля или комментария значения GenericBookId соответствующих модулей совпадают можете добавлять GenericBookId и GenericModId как строки латиницы+цифры типа GenericModId=canons01CommentsASDF GenericModId=canonApostolic01QWERTY но когда это будет реализовано в коде - это разработчик затрудняется сказать.

Устаревшие параметры (ключи)
Alphabet	Алфавит дополнительных символов	Перечень символов, которые не входят в кодовую страницу языка используемого в модуле. Параметр перешел из версий, не поддерживающих юникод, поэтому в модулях для BQ6 может не указываться.
DesiredFontCharset	Желаемая кодовая страница текстов модуля	Параметр перешел из версий не поддерживающих юникод, поэтому в модулях для BQ6 может не указываться.
Greek = Y/N		Параметр перешел из версий не поддерживающих юникод, поэтому в модулях для BQ6 может не указываться.
ShowVerseNumbers	Отображение нумерации стихов	ShowVerseNumbers = Y/N В версии 6 не работает
RightToLeft	Поддержка направленности текста справа на лево (для еврейского и арабского языков)	В версии 6 не работает
ParagraphSkips	Для чего использовался – достоверно неизвестно	Значения: ParagraphSkips=1/0 В версии 6 никак не влияет на отображение модуля

INI файл может содержать:

· пустые строки;

· комментарии — от символа ";" (точка с запятой) или "//" (две косые линии) до конца строки;

· значения параметров — строки вида "имя_параметра = значение".

ОПИСАНИЕ КАТЕГОРИЙ ДЛЯ БИБЛИИ

(|Язык|Тип перевода|Конфессия|)

Типы перевода:

· Оригинал,

· Подстрочный,

· Дословный,

· Буквальный,

· Смысловой,

· Художественный,

· Парафраз,

· Поэтический,

· Древний,

· Славянизирующий,

· Современный,

· Традиционный,

· Критический,

· Неортодоксальный,

· Миссионерский,

· Специальный (напр. Basic English),

· Реконструирующий.

Конфессии:

· Православие,

· Католицизм,

· Внеконфессиональный,

· Библейское общество,

· Атеизм,

· Иудаизм,

· СИ,

· Мормоны,

· и т.д.

Формат архивных файлов модуля для Библий, книг, комментариев.

Расширение	Описание, тип файла	Расположение в модуле
.bqb	BibleQuote Compressed Module модуль сжатый в один файл	\Compressed\Modules - для Библий и книг или \Compressed\Commentaries - для комментариев

Формат файлов модуля словарей и номеров Стронга.

Расширение	Назначение	Расположение в папке Цитаты
.htm	Основной файл. Содержит текст словаря. Формат UTF-16 или ANSI.	\Strongs или \Dictionaries
.idx	Индексный файл. Формат UTF-16 или ANSI.	\Strongs или \Dictionaries
.php	Скрипт для генерации idx-файла	\Strongs или \Dictionaries
.ini	Файл инициализации - определение параметров	Нет единого формата для ini файлов словарей, так как Цитата их не обрабатывает.

Формат файлов модуля параллельных ссылок.

Расширение

Описание

Расположение в модуле

.ini

Файл инициализации - определения параметров

Пример:

01_genesis.ini

[1]

1=1Pe 2:21-23;

%BQDir%\TSK

ДРУГИЕ ПАРАМЕТРЫ

· Название папки/архива модуля только английскими буквами.

· BibleBooks.cfg – файл, в котором содержится информация о составе канона Библии и стандартные сокращения каждой книги Библии. Стандартные сокращения из этого файла используются парсером ссылок на Библию и для синхронизации книг Библии из разных (в т.ч. неполных модулей).

ЧЕГО НЕ ДОЛЖНО БЫТЬ В МОДУЛЯХ

· Пустых книг (какие бы функции они не исполняли).

· Лишних файлов, которые не используются Цитатой или дополнительными программами для отображения модуля.

ОПИСАНИЕ СТАНДАРТНЫХ ПСЕВДОТЕГОВ ЦИТАТЫ

Ссылка на другой модуль

Ссылка на Ис. 1:11

Ссылка на любой файл, который откроется в окне комментариев.

Cсылка на файл oba_note.htm, который откроется в окне комментариев. В нем должна быть закладка <a name="fn0">. Ссылка отформатирована тегами , чтобы имела вид надстрочной сноски. ^[1]

Описание формата модулей для Цитаты из Библии

Дальнейшие параметры указываются для каждой отдельной книги (части модуля), т.е. описываются столько раз, сколько указано в параметре BookQty