Skip to content
This repository has been archived by the owner on Mar 15, 2020. It is now read-only.

Настройка fb2mobi.config

rupor edited this page Feb 4, 2019 · 26 revisions

Содержание

По умолчанию, файл настроек fb2mobi.config находится в той же папке, что и сама программа. В принципе, можно вносить изменения прямо в этот файл, но в этом случае при обновлении программы необходимо быть внимательным, чтобы не затереть файл с вашими настройками дистрибутивным файлом.

Для предотвращения этого рекомендуется, перед внесением изменений в файл настроек, скопировать файлы fb2mobi.config, fb2mobi-gui.config, если он присутствует, файл spaces.xsl и папку profiles из папки программы в папку пользовательских настроек (предварительно создав её).

Для пользователей Mac OS. Чтобы найти указанные выше файлы и папки, в Finder найдите приложение fb2mobi-gui в папке Приложения (Application), щелкните правой кнопкой мыши и выберите "Показать содержимое пакета" (Show Package Contents). Откроется папка с содержимым пакета приложения. Нужные файлы находятся в папке Contents/MacOS.

Папка пользовательских настроек - папка с определенным именем в домашнем каталоге пользователя:

  • Для Windows - c:\Users\<имя вашего пользователя>\fb2mobi (или в Проводнике c:\Пользователи\<имя вашего пользователя>\fb2mobi)
  • Для Linux и Mac OS - ~/.fb2mobi (обратите внимание на точку в начале имени каталога)

Для Linux и Mac OS создать папку можно через терминал следующим образом

cd
mkdir .fb2mobi

Открыть папку из терминала можно следующей командой open .fb2mobi для Mac OS, xdg-open .fb2mobi для Linux.

fb2mobi.config представляет из себя файл в формате XML. При корректировке файла следите, чтобы каждый начальный тег <тег> закрывался конечным тегом </тег>. Используйте текстовый редактор с поддержкой кодировки UTF-8 (unicode).

Файл содержит три группы настроек:

  • Основные настройки конвертера
  • Настройки профилей конвертации
  • Настройки отправки книг на Kindle по электронной почте

debug

Назначение: Режим отладки конвертера
Возможные значения: True - включен, False - выключен
При включенном режиме отладки в выходной директории создается папка, содержащая промежуточные файлы, из которых утилита kindlegen формирует файл mobi. Включать не рекомендуется - используйте соответствующую опцию командной строки.

consoleLevel

Назначение: Уровень детальности сообщений, выводимых на экран.
Возможные значения: DEBUG, INFO, ERROR, CRITICAL
Возможные значения перечислены в порядке убывания детальности сообщений. DEBUG - самый детальный режим. Данная настройка имеет смысл только при использовании конвертера командной строки.

logFile

Назначение: Имя лог-файла

logLevel

Назначение: Уровень детальности сообщений при записи в лог-файл
Возможные значения: См. consoleLevel

outputFormat

Назначение: Формат выходного файла
Возможные значения: mobi, azw3, epub
Для устройств Kindle предназначены форматы mobi и azw3. Старые устройства Kindle могут не понимать формат azw3. Формат azw3 можно копировать на устройства Kindle только при подключении через USB, формат mobi можно копировать и через USB и отправлять по электронной почте на адрес, привязанный к данному устройству.

kindleCompressionLevel

Назначение: Уровень сжатия конечного файла в формате mobi
Возможные значения: 0 - без сжатия, 1 - стандартное сжатие, 2 - сильное сжатие
Рекомендуемое значение 1, как баланс между скоростью конвертации и размером конечного файла в формате mobi.

noDropcapsSymbols

Назначение: Список символов, запрещенных к преобразованию в буквицу

transliterate

Назначение: Включение транслитерации имени конечного файла
Возможные значения: True - включено, False - выключено
Некоторые старые устройства чтения электронных книг не поддерживают кириллицу в имени файла. В таком случае включите эту опцию.

noMOBIoptimization

Назначение: Отключение режима оптимизации конечного файла в формате mobi
Возможные значения: True - включено, False - выключено
Когда noMOBIoptimization включено, mobi файл после его генерации kindlegen'ом вообще не трогается программой. Это иногда бывает полезно, чтобы понять где именно скрывается проблема - в том, как программа оптимизируе полученный файл, в пересылке файла (Амазон процессирует файлы при пересылке на kindle) или же на устройстве чтения. При обычном использовании эта опция практически никогда не нужна.

screenWidth

Назначение: Ширина экрана устройства чтения в пикселях
Используется для оптимизации размера обложки книги, чтобы она отображалась на весь экран. В дистрибутивном файле приведены значения некоторых популярных устройств чтения.

screenHeight

Назначение: Высота экрана устройства чтения в пикселях
См. screenWidth

defaultProfile

Назначение: Имя профиля, который используется конвертером по умолчанию
Если у вас настроено несколько профилей, можете указать один из них в качестве умолчательного для конвертера. Данной настройки влияет только на конвертер командной строки.

profiles

Назначение: Содержит список описания профилей конвертации
См. описание ниже

sendToKindle

Назначение: Настройки отправки книг на Kindle по электронной почте
См. описание ниже

Настройка каждого профиля заключается в тег

<profile description="Описание профиля" name="имя_профиля">
...
</profile>

Следите, чтобы имя профиля было уникальным.

openBookFromCover

Назначение: Открывать книгу с обложки
Возможные значения: True - включено, False - выключено
При открытии книги на устройствах они открываются с первой значимой страницы (начало текста). Если хотите при открытии книги видеть сначала ее обложку, включите данную опцию. Если специфицирован выходной формат для Kindle (mobi или azw3) данная опция игнорируется.

hyphens

Назначение: Расставлять "мягкие" переносы при конвертации
Возможные значения: True - включено, False - выключено
При включенной настройке конвертер расставляет в словах особые символы, указывающие устройству чтения в каких местах слово можно перенести на новую строку. Таким образом, текст на экране устройства выглядит более аккуратным, без больших пробелов между словами. Современные устройства Kindle уже имеют функцию расстановки переносов "из коробки", поэтому для таких устройств эту опцию можно отключить.

transliterateAuthorAndTitle

Назначение: Включение транслитерации метаданных конечного файла
Возможные значения: True - включено, False - выключено
Некоторые старые устройства чтения электронных книг не поддерживают кириллицу в метаданных книги (автор, название). В таком случае включите эту опцию.

hyphensReplaceNBSP

Назначение: Заменять символы неразрывного пробела (nbsp) на обычный пробел при расстановке переносов
Возможные значения: True - включено, False - выключено
Данная настройка работает, если включена опция расстановки переносов hyphens. Настройка предназначена для предотвращения конфликтов с hyphenation engine, встроенным в прошивку современных устройств Kindle - он считает неразрывный пробел частью слова (а не разделителем слов в предложении) и сбивается.

dropcaps

Назначение: Расставлять буквицы
Возможные значения: None- выключено, Simple - простой режим, Smart - "умный режим"
При включении данной опции первый символ первого абзаца каждой главы будет помечаться стилем буквицы (dropcaps). Стиль отображения буквицы настраивается в файле css, указанном в параметре css текущего профиля. В режиме Samrt проводится анализ на наличие дополнительного форматирования начала абзаца.

tocBeforeBody

Назначение: Управляет положением страницы оглавления книги
Возможные значения: True - страница в начале книги, False - страница в конце книги
Данная настройка имеет смысл только при включенной опции generateTOCPage. Как правило, многие современные устройства чтения электронных книг имеют средства навигации по оглавлению. В этом случае располагайте страницу оглавления в конце книги или отключите ее генерацию с помощью опции generateTOCPage.

tocMaxLevel

Назначение: Максимальный уровень вложенности заголовка (секции) для помещения на страницу оглавления книги
Возможные значения: Число от 1. Значение по умолчанию - 1000
. Если книга содержит большое количество вложенных разделов, страница оглавления получится достаточно объемная. С помощью этого параметра можно ограничить уровень вложенности заголовка для включения его в страницу оглавление. На оглавление, доступное через средства навигации устройства чтения электронных книг, этот параметр не влияет.

tocKindleLevel

Назначение: Ограничивает уровень иерархии оглавления для устройств Kindle
Возможные значения: Число от 1. Значение по умолчанию 2
На текущий момент устройства Kindle поддерживают двухуровневое оглавление, доступное через средства навигации. Если в будущем ситуация изменится, с помощью этого параметра можно установить максимальный уровень вложенности оглавления. Данный параметр влияет на оглавление, если установлен tocType=Kindle.

tocType

Назначение: Управляет стилем оглавления, доступным через средства навигации, встроенных в устройство чтения
Возможные значения: Flat - "плоское" оглавление, Kindle - оглавление в стиле Kindle, Normal - многоуровневое оглавление
Формат файла fb2 позволяет выстраивать различные части книги в виде дерева. Например:

  • Книга 1
    • Часть 1
      • Глава 1
      • Глава 2
    • Часть 2
      • Глава 1
      • Глава 2

При генерации оглавления в режиме Normal эта иерархия сохраняется.

К сожалению, устройства Kindle поддерживают только два уровня иерархии. Соответственно, оглавление в режиме Kindle будет выглядеть так:

  • Книга 1
    • Часть 1
    • Глава 1
    • Часть 2
    • Глава 1
  • Книга 2
    • Часть 1
    • Глава 1

В режиме Flat все оглавление будет на одном уровне.

css

Назначение: Имя файла стилей css, используемого при конвертации данным профилем
Файл css содержит описание оформления различных элементов текста книги, таких как заголовки, абзац, эриграф, стихи и прочее.

xslt

Назначение: Имя файла xslt, используемого при конвертации данным профилем
В этом файле можно описать xslt преобразования текста исходного файла при конвертации. Например, заменить различные символы, используемые в файлах fb2 для указания прямой речи (минус, дефис) на длинное тире и т.п.

chapterOnNewPage

Назначение: Указывает конвертеру начинать ли главу с новой страницы
Возможные значения: True - глава начинается с новой страницы, False - глава располагается сразу за окончанием предыдущей главы

chapterLevel

Назначение: Опеределяет на каком уровне вложенности секции fb2 считаются главами
Возможные значения: Число (по умолчанию 100). Работает вместе с chapterOnNewPage
Если включено chapterOnNewPage и уровень вложенности секции меньше указанного числа - секция начинает новую главу в TOC. Кроме того (и это не зависит от значения chapterOnNewPage) для ее заголовка используется css стиль .titleblock, в противном случае (уровень вложенности больше или равен указанному числу) используется .titleblock_nobreak.

authorFormat

Назначение: Шаблон имени автора в метаданных конечного файла
Возможные значения: комбинация следующих шаблонов: #f - имя, #m - отчество, #l - фамилия, #fi - инициал имени, #mi - инициал имени
В данной настройке вы можете указать порядок формирования имени автора, которое будет отражаться в списке книг на устройстве чтения. Например,

#f #m #l - Лев Николаевич Толстой
#l, #f #m - Толстой, Лев Николаевич
#f #l - Лев Толстой
#l #fi #mi - Толстой Л. Н.

bookTitleFormat

Назначение: Шаблон названия книги в метаданных конечного файла
Возможные значения: комбинация следующих шаблонов: #title - название книги, #date - дата (год) издания книги, #series- название серии, #abbrseries - аббревиатура серии (складывается из первых букв каждого слова из названия серии), #number - номер книги в серии, #padnumber - номер книги серии, дополненный нулями до размера, указанного в настройке seriesPositions
Кроме того, можно использовать фигурные скобки {} для указания части шаблона, который вырезается, если в элементах, заключенных в скобки отсутствует значение.

Наиболее универсальный шаблон содержится в дистрибутивном файле настроек:

{(#abbrseries{ #padnumber}) }#title

Заголовки книг, сделанные по этому шаблону будут выглядеть примерно так:

(гп 01) Гарри Поттер и философский камень - есть серия и номер книги в серии
(бпинф) Гиперболоид инженера Гарина - есть серия (Библиотека приключений и научной фантастики)
Алые паруса - только название книги

seriesPositions

Назначение: Количество знаков для номера книги в серии. См. настройку bookTitleFormat

annotationTitle

Назначение: Название страницы аннотации
При конвертации из метаданных файла fb2 формируется отдельная страница в конечном файле, содержащая краткое описание или анонс книги. Название этой страницы берется из этой настройки. Если книга на иностранном языке, вы можете указать название этого раздела на языке книги. Например, для книг на английском языке, "Annotation".

tocTitle

Назначение: Название страницы оглавления
При конвертации файла fb2 формируется отдельная страница в конечном файле, содержащая оглавление книги. Название этой страницы берется из этой настройки. Если книга на иностранном языке, вы можете указать название этого раздела на языке книги. Например, для книг на английском языке, "Contents".

notesMode

Назначение: Режим отображения сносок
Возможные значения: default, inline, block, float

  • default - сноски в тексте книги отображаются как гиперссылки на текст сноски в отдельном разделе книги, помещаемом в конце книги. Как правило, для возврата к основному тексту книги требуется нажать специальную кнопку на устройстве чтения Назад/Back.
  • inline - текст сноски включается в основной текст книги непосредственно за местом размещения сноски. Визуальный стиль оформления текста сноски отличается от основного текста и есть возможность его изменить в файле css.
  • block - текст всех сносок, встречающихся в одном абзаце, размещается в виде блока непосредственно после этого абзаца. Визуальный стиль оформления блока сносок отличается от основного текста и есть возможность его изменить в файле css.
  • float - текст сноски показывается в отдельном всплывающем окне при нажатии на сноску, при условии, что устройства чтения поддерживает этот режим отображения сносок.

Для современных устройств Kindle рекомендуется режим float.

notesBodies

Назначение: Содержит список разделов файла fb2, определяемых конвертером, как разделы, содержащие тексты сносок.
В общем случае значение настройки должно содержать notes,Примечания. Для изменения этой настройке рекомендую ознакомиться с форматом fb2.

coverDefault

Назначение: Содержит путь к jpeg файлу с картинкой. В соответсвтвии с APG Kindle book должна иметь cover image. Если он отсутствует в FB2 - будет использован указанный файл.

coverStamp

Назначение: Позволяет поместить информацию о книге на cover image. Штамп всегда черный с белыми буквами
Возможные значения: None, Top, Center, Bottom

  • None - cover не будет проштампован.
  • Top - штамп займет 1/4 поверхности cover image сверху.
  • Center - штамп займет 1/4 поверхности cover image в центре.
  • Bottom - штамп займет 1/4 поверхности cover image снизу.

Cover page, подставляемый при отсутствии в оригинале всегда штампуется

coverFont

Назначение: Если специфицирован штамп (coverStamp или опция коммандной строки stamp-cover выставлены в Top или Bottom), то обязательно должен быть специфицирован TTF фонт, которым осуществляется штамповка.

scaleImages

Назначение: Если специфицировано положительное не нулевое рациональное число, размер всех PNG и JPEG изображений (кроме cover image) из оригинального FB2 будет принудительно изменен с указанным кофициентом. Если в оригинальном изображении не было специфицировано DPI - будет использовано (300, 300), если было - оно будет сохранено.

generateTOCPage

Назначение: Создавать при конвертации страницу с оглавлением книги
Возможные значения: True - включено, False - выключено
Связанные настройки tocBeforeBody, tocTitle

generateAnnotationPage

Назначение: Создавать при конвертации страницу аннотации
Возможные значения: True - включено, False - выключено
Связанная настройка annotationTitle

generateOPFGuide

Назначение: Создавать при конвертации порядок следования страниц в книге
Возможные значения: True - включено, False - выключено
Зачем добавлял эту опцию, уже не помню. Рекомендуется всегда ее включать.

kindleRemovePersonalLabel

Назначение: Удалять метку "Personal" для конечных файлов в форматах mobi и azw3
Возможные значения: True - включено, False - выключено
Устройства Kindle различают книги, купленные в магазине Amazon и книги, созданные с помощью утилиты kindlegen. На старых версиях ПО прошивки Kindle книги, созданные с помощью kindlegen имели визуальную метку "Personal". Включение данной опции позволяет создать файл, который будет восприниматься устройством Kindle также, как и книга, купленная в Amazon, что позволяет удалить метку "Personal".

Если вы включили опцию kindleRemovePersonalLabel, обратите внимание на следующие особенности:

  • При пересылке книг через сервис Send to Kindle не работает синхронизация позиции чтения от Amazon между несколькими устройствами.
  • При передаче книг на устройство Kindle через USB, не отображаются миниатюры обложек. Их можно создать с помощью утилиты 'synccovers', входящей в дистрибутив конвертера. Для версии с графическим интерфейсом это не требуется - программа автоматически создает миниатюры обложек при отправке книг на устройство Kindle.

removePngTransparency

Назначение: Контролирует преобразование прозрачных PNG картинок в непрозрачные
Возможные значения: True - включено, False - выключено

generateAPNX

Назначение: Генерация индексного файла для поддержки нумерации страниц в файлах формата mobi и azw3
Возможные значения: Таг отсутствует - выключено, eInk - генерация индексного для устройств Kindle, PC - генерация индексного файла для Kindle for PC
По умолчанию на устройствах Kindle прогресс чтения отображается в процентах и условных местах (location), либо временем, оставшимся до конца главы или книги. Генерация индексного файла позволяет устройству Kindle отображать условный "номер страницы". Размер страницы задается в буквах (символах) с помощью опции charactersPerPage (по умолчанию, 2300 букв).

Следует понимать, что эти "номера" страниц условные и при перелистывании страницы необязательно будет изменятся номер. Это зависит от количества символов, расположенных на экране.

charactersPerPage

Назначение: Размер "страницы" для устройства Kindle при генерации индексного файла
См. настройку generateAPNX.

outputPattern

Назначение: Шаблон названия конечного файла
Возможные значения: комбинация следующих шаблонов:
#title - название книги, #series- название серии,
#abbrseries - аббревиатура серии (складывается из первых букв каждого слова из названия серии),
#number - номер книги в серии,
#padnumber - номер книги серии, дополненный нулями до размера, указанного в настройке seriesPositions,
#authors - строка имени автора (будет расширяться строкой, сформированной по правилам <authorFormat>), состоит из полного списка всех заявленных авторов,
#author - строка имени автора, если авторов несколько состоит из имени первого автора (будет расширяться строкой, сформированной по правилам <authorFormat>) и указателя на их количество (в зависимости от языка книги, для 'ru' - " и др", для остальных - ", et al"),
#bookid - уникальный id книги (будет использован указанный в FB2, если отсутствует - сгенерированный)
Кроме того, можно использовать фигурные скобки {} для указания части шаблона, который вырезается, если в элементах, заключенных в скобки отсутствует значение.

В качестве примера см. документацию по <bookTitleFormat>. Для работы необходимо, чтобы входной файл был FB2 и имя конечного файла не было явно заданно в коммандной строке, иначе будет игнорироваться.

vignettes

Назначение: Настройка виньеток
Виньетка - небольшой рисунок или орнамент в начале или в конце текста книги или главы. Программа предоставляет базовые возможности вставки рисунков в виде виньеток. Поддерживается вставка виньетки перед названием главы, после названия главы и в конце текста главы. Примеры рисунков виньеток включены в состав дистрибутива. Их можно найти в подпапке profiles/vignettes. Если хотите использовать собственные рисунки в качестве виньеток, поместите файлы рисунков в формате png или jpeg в указанную подпапку.

Виньетки можно настроить как в целом для книги, так и для определенного уровня вложенности раздела книги в формате fb2. Либо определить виньетки для любого уровня вложенности и для определенных уровней их переопределить. Для понимания уровней вложенности разделов книги в формате fb2 рекомендую ознакомиться с данным форматом. Базовое понимание вложенности разделов см. в описании настройки tocType. В общем случае, описание виньеток для разделов определенного уровня вложенности описывается так:

<vignette level="уровень_вложенности">
    <beforeTitle>profiles/vignettes/title_before.png</beforeTitle>
    <afterTitle>profiles/vignettes/title_after.png</afterTitle>
    <chapterEnd>profiles/vignettes/chapter_end.png</chapterEnd>
</vignette>

Тег beforeTitle содержит ссылку на виньетку, располагаемую перед заголовком главы. Тег afterTitle содержит ссылку на виньетку, располагаемую после заголовка главы. Тег chapterEnd содержит ссылку на виньетку, располагаемую после текста главы. Для отключения отображения какой-либо виньетки укажите в качестве значения тега None.

<beforeTitle>None</beforeTitle>

Поддерживаются уровни вложенности от 0 до 6. Как правило, уровень 0 это заголовок самой книги. Уровни вложенности в параметре level указываются с префиксом h - h0, h1...h6. Также существует специальное значение уровня вложенности default, которое указывает на настройку виньеток любого уровня вложенности, если в явном виде для какого-либо уровня не определены другие настройки виньеток. Пример настройки виньеток приведен ниже. В данном примере определены виньетки по умолчанию, для уровня вложенности 0 виньетки отключены и переопределены для 1-го и 3-го уровня вложенности.

<vignettes>
   <vignette level="default">
       <beforeTitle>profiles/vignettes/title_before.png</beforeTitle>
       <afterTitle>profiles/vignettes/title_after.png</afterTitle>
       <chapterEnd>profiles/vignettes/chapter_end.png</chapterEnd>
   </vignette>
   <vignette level="h0">
       <beforeTitle>None</beforeTitle>
       <afterTitle>None</afterTitle>
       <chapterEnd>None</chapterEnd>
   </vignette>
   <vignette level="h1">
       <beforeTitle>profiles/vignettes/title_before1.png</beforeTitle>
       <afterTitle>profiles/vignettes/title_after1.png</afterTitle>
       <chapterEnd>profiles/vignettes/chapter_end1.png</chapterEnd>
  </vignette>
  <vignette level="h3">
      <beforeTitle>profiles/vignettes/title_before2.png</beforeTitle>
      <afterTitle>profiles/vignettes/title_after2.png</afterTitle>
      <chapterEnd>None</chapterEnd>
   </vignette>
</vignettes>

Данные настройки работают только для конвертера командой строки. В версии с графическим интерфейсом эти настройки игнорируются (и при необходимости, принудительно отключаются) - в этой версии содержатся свои настройки.

send

Назначение: Включить или выключить отправку при конвертации
Возможные значения: True - включено, False - выключено

deleteSendedBook

Назначение: Удалять отправленные файлы в формате mobi
Возможные значения: True - включено, False - выключено

smtpServer

Назначение: Имя smtp-сервера

smtpPort

Назначение: Номер порта smtp

smtpLogin

Назначение: Логин на smtp-сервер

smtpPassword

Назначение: Пароль на smtp-сервер

fromUserEmail

Назначение: Адрес e-mail, с которого отправляются книги
Адрес должен быть прописан в настройках учетной записи Amazon. Зайдите на сайт kindle.com. Перейдите по ссылке Manage Your Content and Devices, в разделе Settings добавьте этот адрес e-mail в список Approved Personal Document E-mail List.

toKindleEmail

Назначение: Адрес e-mail устройства Kindle
При регистрации устройства Kindle Amazon автоматически присваивает каждому устройству адрес электронной почты. Узнать его можно в настройках вашей учетной записи Amazon, в разделе Settings->Send-to-Kindle E-Mail Settings.