Версия 1.0 стиля оформления <docbook>ЕСПД</docbook>

Представляем вашему вниманию версию 1.0 проекта <docbook>ЕСПД</docbook>. Новая версия — это достаточно функциональный набор DocBook-оформления для создания электронных и печатных документов по стандарту ГОСТ 19 (ЕСПД).

Стилевой набор покрывает большое количество элементов DocBook 5, оформляемых гармонично с требованиям ГОСТ 19. Некоторые важные стилевые возможности:

  • лист утверждения;
  • титульный лист;
  • лист регистрации изменений;
  • децимальный номер;
  • учет нюансов русской типографики.

Помимо приближенного к ГОСТ 19 оформления, проект содержит «современный» стиль для создания документов. Два стиля используют общие принципы и параметры и могут совместно применяться для исходной документации. В отличие от строго ЕСПД, современный стиль предлагает более развитые возможности оформления:

  • цветные заголовки, блоки команд и исходного кода;
  • привычное оформление заголовков и титульного листа;
  • цветные врезки (возможно с графическими элементами).

Концептуально современный стиль близок к стандартному стилю проекта Publican.

Для трансляции текста DocBook 5 с использованием стилей <docbook>ЕСПД</docbook> возможно использование Apache FOP 1.1. Для наилучшего результата рекомендуется актуальная версия FOP из репозитория проекта в связке с Saxon, вместо штатного Xalan во многих дистрибутивах Линукс.

Проект <docbook>ЕСПД</docbook> распространяется на условиях лицензии GPL 3.

Багтрекер проекта расположен на BitBucket.

10 Comments

  1. Eduard Tibet

    Добрый день!

    Рад, что хоть кто-то у нас в стране выпустил нечто подобное под GPL3 :) А то до этого момента были только закрытые разработки. Вопрос: у вас xsl под 5.0, а не 5.1? 5.1 уже в стадии CR4, скорее всего скоро будет Oasis Standard. Далее: насколько я понял, используются «обычные» — не -ns stylesheets.

      1. Eduard Tibet

        Понятно.
        Я немного глянул на код и заметил несколько неправильных вещей, с точки зрения проектирования и переносимости: 1. fop. conf c autodetect. 2. в *font family — название шрифтов, а не начертания (sans, serif). Это неправильно. Объясню почему. Допустим, человек скачал ваш customization layer. У него НЕТ шрифтов из *font.family. Что он получает? Правильно, fallback to default у fop. default fonts у fop — латиница (по умолчанию), следовательно значки ####. Далее человеку становится просто неинтересно.

        1. Шлыков Василий

          1) fop.xml. Не знаю как у вас, а у меня вообще никакие шрифты не подключаются без конфига fop. 2) Про *.font.family не понял. А как правильно по вашему?

          1. Eduard Tibet

            Нет, вы не поняли. Я имел в виду, что использование в fop. conf autodetect’а — bad practice. Когда вы делаете обычные документы и не по стандартам, такая практика имеет право на существование — в случае «сгенерировать и забыть». А если вам необходимо придерживаться стандарта, то нужен другой подход. В текущей ситуации у вас шрифт включает непосредственно в fo уже на первом уровне преобразования xml > fo (работа xsl stylesheets). Т. е. при любом изменении стандарта, вам надо перегенерировать fo. А нормальная практика — делать все максимально нейтрально (в данном случае font neutral). Т. е., фактически, вы должны исключать названия шрифта ВНУТРИ fo, а выносить его на второй уровень генерации fo >pdf (работа FOP). В fo же остаются НАЧЕРТАНИЯ (sans, serif, mono и т. п.) и при этом исключается название шрифта. Вам надо использовать conf c embed-url и font-triplet (в котором будет, например, serif). font. family в xsl — тоже serif (при этом устанавливается соответствие). Тогда изменяя значения шрифта в conf вы автоматически получите требуемый шрифт в документе. Изменится шрифт (например, по вопросам лицензии) — вам надо будет просто поменять conf, а не перегенерить большое количество .fo. М.б. несколько сумбурно получилось, но здесь в комментах нельзя делать отступы и абзацы.

          2. Шлыков Василий

            Мысль понятна, тащемто. Я согласен, что так правильно. Однако существующий подход проще, поскольку не нужно знать ничего про настройки FOP, а достаточно изменить шрифты, что описано в README. Возможно лучше вытащить ваш комментарий в README и сделать пример fop. xml? Надо попробовать, может и сделаю как вы предлагаете.

  2. Eduard Tibet

    Василий, пару месяцев назад был запущен форум «Технология единого источника в технической документации» (http://forum.singlesourcing.ru/). На форуме большая часть материала будет посвящена именно Docbook и аспектам его применения. Пока что все находится в стадии наполнения (т.к. проект некоммерческий, а скорее популяризационный). Однако, если у вас есть что сказать аудитории (пока что малочисленной) — можете присоединиться :)

Добавить комментарий для Eduard Tibet Отменить ответ

Ваш e-mail не будет опубликован. Обязательные поля помечены *