Создание книги с помощью Asciidoctor

Создание книги с помощью Asciidoctor

1. Вступление

В этой быстрой статье мы покажем, как использоватьgenerate a book from an AsciiDoc document и как настроить вашу книгу с помощью различных вариантов стиля.

Если вы не знакомы с AsciiDoc в Java, вы можете прочитать нашIntroduction to AsciiDoctor.

2. Тип внутренней книги

Самый простой способ создать книгу с помощью AsciiDoctorj - использовать Maven, как в предыдущей статье. The only difference is that you have to specify doctype tag and set it to “book”.с

pdf
book

С заданным типом документа AsciiDoctorj знает, что вы хотите создать книгу, поэтому он создает:

  • Титульный лист

  • Оглавление

  • Первая страница содержания тела

  • Части и главы

Чтобы получить упомянутые части, в документе Asciidoc должны быть определены заголовок, разделы и другие части, которые являются нормальными для книги.

3. Определение собственного стиля

При написании книги естественно, что мы хотим использовать какой-то нестандартный стиль. Это можно сделать с помощью специального языка форматирования AsciiDoc, определенного в простом файле YAML.

Например, этот фрагмент кода будет определять, как будет выглядеть каждая страница в книге. Мы хотим быть в портретном режиме, 0,75-дюймовое поле сверху и снизу и 1-дюймовое поле по бокам на бумаге формата А4:

page:
    layout: portrait
    margin: [0.75in, 1in, 0.75in, 1in]
    size: A4

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

header:
  height: 0.5in
  line_height: 1
  recto_content:
    center: '{document-title}'
  verso_content:
    center: '{document-title}'

footer:
  height: 0.5in
  line_height: 1
  recto_content:
    right: '{chapter-title} | *{page-number}*'
  verso_content:
    left: '*{page-number}* | {chapter-title}

Дополнительные параметры форматирования можно найти наGithub page of AsciiDoctorj.

Чтобы включить пользовательскую тему в процесс создания книги, мы должны определить путь, где находится наш файл стиля. Местоположение указывается в части атрибутов вpom.xml:

${project.basedir}/src/themes
custom

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

С этими изменениями нашpom.xml выглядит так:


    src/docs/asciidoc
    target/docs/asciidoc
    
        ${project.basedir}/src/themes
        custom
    
    pdf
    book

4. Создание книги

Чтобы создать книгу, вам просто нужно запустить Maven в каталоге проекта, а сгенерированную книгу можно найти в каталогеtarget/docs/asciidoctor/.

5. Заключение

В этом уроке мы показали, как с помощью Maven создавать книги, оформленные в простом стиле.

Как всегда, код из этой статьи можно найтиover on GitHub.