У каждой книги должна быть папка с ее исходниками. Исходники книг находятся в папках вида workshop/source/mybook. Если Вы используете Bulldoc, на сайте, то ваши папки с исходниками должны быть доступны веб-серверу.
Папка с исходниками книги имеет следующую структуру:
/pages -- тут лежат тексты страниц и картинки
introduction.html -- страница
/chapter1 -- папка подраздела
topic1.html -- страница подраздела
toc.yml -- файл структуры
book_data.yml -- Файл данных книги: Название, автор, год выхода и т.д.
Для создания новой книги в командной строке запустите:
bulldoc -c mybook
Эта команда создаст 2 папки:
workshop/source/mybook
workshop/source/mybook/pages
И два файла:
пустой /home/bulldoc/workshop/source/mybook/toc.yml
и /home/bulldoc/workshop/source/mybook/book_data.yml
Также в конец файла workshop/source/bookshelf.yml, допишется строчка:
mybook:
Отредактируйте файл workshop/source/mybook/book_data.yml, вписав туда название книги, и по желанию изменив другие параметры. Внимание! Файлы с yml разметкой используют пробелы, а не табуляцию!
Для того, чтобы программа находила файлы исходников Вашей книги, книгу нужно прописать в настройки книжной полки
Файл настроек находится в workshop/source/bookshelf.yml
Изначально там уже есть одна книга. Вот эта, которую Вы читаете.
Книги на полке — это совокупность исходников и настроек экспорта. Каждой такой группе назначается ID, который называется ключевым словом и может содержать буквы и цифры. В случае, когда используются настройки по умолчанию, достаточно в файле книжной полки просто упомянуть ключ книги:
mybook:
Однако иногда требуются дополнительные настройки. Полная секция описания книги выглядит так:
... mybook: title: BullDoc CHM rootIndexLevel: -1 #Показывать полное оглавление на обложке source: mybook_original dest: mybook_special theme: blueprint_chm outputMode: html hideOnBookShelf: 0 language: rus
mybook это ключевое слово книги на полке. Это слово будет использоваться в url для доступа к сайту книги, и так будут называться файлы для компиляции chm
title задает название книги, которое будет отображаться на книжной полке. Если параметр не задан, это значение возьмется из файла конфигурации самой книги. Если же и этого файла пока нет, то будет отображено ключевое слово книги.
source — это папка с исходником книги. dest показывает куда положить результат генерации статики. Если заданы абсолютные пути, то они и будут использоваться, иначе к относительным путям добавятся стандартные папки из workshop
rootIndexLevel Регулирует число уровней оглавления на самой первой странице (обложке) книги. Для подразделов можно задать другой уровень. Если у подраздела не задан уровень, используется rootIndexLevel. Значение -1 выключает ограничение и дерево оглавления выводится полностью.
theme. Имеется одна готовая тема blueprint. Вы можете скопировать эту тему под другим названием и отредактировать. Темы хранятся в workshop/themes. Значение параметра theme определяет имя папки, в которой тема хранится. Подробнее см. раздел Оформление и настройки. Тему можно вообще не указывать — тогда будет использована тема blueprint.
hideOnBookShelf если установлен и истинен, запись не будет отображаться на книжной полке.
outputMode Режим вывода, – html, html_single и chm.
language задает язык интерфейса и служебных элементов. Если Ваша книга написана не на языке, установленном в настройках, то следует явно указать язык. В настоящее время поддерживаются языки: русский-windows1251 (rus), русский-utf8 (utf8_rus) и английский (eng). Если локаль не совпадает с локалью по умолчанию для выбранного языка, то ее можно задать с помощью параметра locale. См. также раздел Язык интерфейса.
Со временем количество книг, с которыми Вы работаете может весьма возрасти. В таком случае для группировки книг можно использовать значения-разделители, т.е. псевдо-записи, в которых имеется параметр separatorTitle:
... general_title: separatorTitle: Основной раздел mybook1: mybook2: fiction_title: separatorTitle: Художественное fictionbook1: fictionbook2:
© H-type, 2008
www.bulldoc.ru