РАЗРАБОТКА ЭУМК С ПОМОЩЬЮ DOCBOOK

Миндалев Игорь Викторович

доц. кафедры Информационных систем и технологий в экономике,

ФГБОУ ВО «Красноярский Государственный аграрный университет»,

РФ, г. Красноярск

E-mail: 

THE DEVELOPMENT OF ELECTRONIC EDUCATIONAL COMPLEX USING DOCBOOK

Igor Mindalev

assistant professor of Information systems and technologies in economy,

Krasnoyarsk state agrarian university,

Russia, Krasnoyarsk

АННОТАЦИЯ

Сформулированы требования к системе автоматизированной подготовки электронного учебно-методического комплекса (ЭУМК) дисциплины. В качестве методологической основы такой системы выбран стандарт Docbook. Представлена технология разработки ЭУМК на базе Docbook.

ABSTRACT

The requirements to the system of automated preparation of electronic educational complex discipline. As a methodological basis of the system proposed by the standard Docbook.

Ключевые слова: ЭУМК, XML, docbook, xsltproc, документация.

Keywords: Electronic training complex, XML, Docbook, XSLTProc, Documentation.

Учебно-методический комплекс по дисциплине определяется, как «совокупность учебно-методических материалов по учебной дисциплине конкретного учебного плана по специальности (направлению), необходимых для организации и осуществления с их помощью учебного процесса» [1]. Соответственно при разработке комплекса с применением информационных технологий он принимает форму электронного учебно-методического комплекса (ЭУМК). Учебно-методические материалы (УММ) разрабатываются в соответствии с формами учебной деятельности студентов: лекции, лабораторные занятия, самостоятельная работа. Можно сказать, что ЭУМК – это УММ по определенной учебной дисциплине расположенные на электронных носителях.

В настоящее время разработка и поддержка ЭУМК полностью лежит на плечах преподавателей, по принципу: произошли изменения в учебном плане или в рабочей программе дисциплины – необходимо актуализировать учебно-методический комплекс. УММ представляют собой набор документов формата Microsoft Word, которые хранятся на компьютере преподавателя. А конечные документы комплекса должны быть в формате HTML. Возникают задачи по преобразованию документов из одного формата в другой, по стилевому оформлению.

Для их решения можно обратиться к смежным областям. Например, проблемы, возникающие при ведении технической документации в софтверных компаниях [3] совпадают с нашей ситуацией. Тогда допустим, что аналогом разработки ЭУМК в вузе является разработка технической документацию в области программного обеспечения. А разработка технической документации – вполне сформировавшийся сектор ИТ-индустрии.

Сформулируем следующие требования к системе для подготовки ЭУМК, аналогичные требованиям к системе разработки технической документации:

1.лицензия GNU GPL и ей подобные;

2.возможность создания конечного документа в формате HTML и других форматах в автоматическом режиме;

3.поддержка форматирования документа;

4.возможность декомпозиции конечного документа на составные элементы, для повторного использования;

5.соответствие принципу единого источника;

6.текстовой формат хранения документа, не Microsoft Word, чтобы иметь возможность использовать систему управления версиями ().

Первое требование связано с использованием программного обеспечения с лицензией GNU GPL [7], которое дает пользователям возможность на неограниченную установку, а также свободное использование и изменение программ. Кроме этого использование программ с такой лицензией позволяет экономить денежные средства: большая часть их бесплатны.

Второе требование определяет формат выходных документов системы по подготовке ЭУМК – это кроме HTML, еще желателен PDF, CHM. Кроме этого необходима возможность генерации выходных документов в автоматическом режиме.

Реализация третьего требования позволит преподавателям при разработке комплекса иметь возможность настраивать внешний вид выходных документов.

Четвертое требование связано с возможностью декомпозиции документа комплекса на элементы, для повторного использования при разработке ЭУМК похожего направления. Этими элементами могут быть модули, определяемые как «часть учебной дисциплины, по окончании изучения которой осуществляется промежуточный контроль знаний студентов» [2] или дидактические единицы (разделы, подразделы, темы).

Если программа в разных ситуациях должна выполнять одни и те же действия, их оформляют в виде функций или процедур. Если действия одинаковы в общем, но различаются в зависимости от конкретной ситуации, то программист предусматривает возможность передать функции или процедуре определенные аргументы. Для реализации этого программистского подхода к документированию в работе [4] был предложен принцип единого источника, который представлен в пятом требовании. Благодаря этому «можно несмотря на все своеобразие текста «выносить за скобки» одинаковое, параметризовать почти одинаковое и формировать из этих блоков документы в том виде, в котором их предпочитает получать их аудитория» [4].

Формирование документов на основе шаблонов (или модулей в нашем случае) и единого источника – основной принцип, на котором сегодня построены наиболее известные и развитые инструментальные средства для автоматизации документирования.

Шестое требование связано с системой управления версиями (VCS), которая позволяет хранить несколько версий одного и того же документа, при необходимости возвращаться к более ранним версиям, определять, кто и когда сделал то или иное изменение. Использование такой системы особенно важно для ЭУМК одной кафедры, где читаемые дисциплины взаимосвязаны.

Этим требованиям вполне удовлетворяет Docbook – стандарт консорциума OASIS, семантический язык разметки для технической документации, но он может быть использован для любого другого рода документации, в том числе и для разработки ЭУМК.

Разработка документа в формате Docbook напоминает работу с HTML, только используется свой набор тегов и правил их употребления, которые представлены на сайте проекта [8; 9]. Набор тегов для описания содержимого большой, но в повседневной работе нами использовались не более двадцати.

Первый шаг предлагаемой технологии разработки ЭУМК: это создание документа в формате Docbook.

Второй шаг: чтобы привести документ в пригодный для чтения или печати формат, например, HTML, необходимо использовать XSLT-процессор, который на основе содержимого документа и стилей оформления сформирует конечный документ. Модель XSLT-обработки представлена на рисунке 1.

Рисунок 1. XSLT-обработка

Документ в формате Docbook можно создать с помощью текстового процессора, например, LibreOffice Writer, который поддерживает этот формат. Но полученный документ содержит лишь базовые теги Docbook.

Дальнейшее редактирование документа по добавлению необходимых тегов осуществляется с помощью текстового редактора или с помощью XML-редактора, например, Syntext Serna [5]. Также с помощью Syntext Serna удобно выполнять проверку XML-файла на соответствие стандарту Docbook. Полученный файл формата Docbook XML является базовым документом ЭУМК.

В простейшем случае XSLT-процессор получает на входе два документа – входной XML-документ и таблицу стилей XSLT – и создает на их основе выходной документ.

Нами был использован XSLT-процессор XSLTPROC [11] в среде операционной системы ROSA Linux.

Для того чтобы работать над внешним видом выходного документа, понадобится задавать значение целой серии параметров. Делать это через командную строку неудобно, поэтому обычно создают XSL-драйвер, пример содержания которого представлен ниже.

<?xml version="1.0" encoding="windows-1251"?>

<xsl:stylesheet version="1.0"

xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

<xsl:import href="/home/mindal/docbook-xsl-1.78.1/xhtml/chunk.xsl"/>

<xsl:param name="chunker.output.encoding" select="'windows-1251'"/>

<xsl:param name="chapter.autolabel" select="'1'"/>

<xsl:param name="l10n.gentext.default.language" select="'ru'"/>

<xsl:param name="section.autolabel" select="'1'"/>

<xsl:param name="section.label.includes.component.label" select="'1'"/>

<xsl:param name="part.autolabel" select="'I'"/>

<xsl:param name="navig.graphics" select="0"/>

<xsl:param name="base.dir" select="'/home/mindal/ek2015/pzis/'"/>

<xsl:param name="html.stylesheet" select="'pzis.css'"/>

<xsl:param name="chunk.tocs.and.lots" select="1"/>

<xsl:param name="chunk.section.depth" select="4"/>

</xsl:stylesheet>

Вопросы настройки Docbook, в том числе параметры, рассматриваются в книге [10].

Стандартные XSL-скрипты Docbook поддерживают специальный вариант трансляции в HTML — для последующего преобразования в Microsoft HTML Help.

Создание выходного документа, например, в виде набора html-файлов, запускается командой: xsltproc – nonet docbook2.xsl book_pzis.xml, где docbook2.xsl – XSL-драйвер, book_pzis.xml – базовый файл docbook.

Разработанный на основе технологии Docbook ЭУМК можно посмотреть на сайте университета [6].

Таким образом, представленная технология на базе Docbook позволяет автоматизировать процесс разработки электронного учебно-методического комплекса дисциплины. Она позволяет разработчику комплекса «забыть» о форматировании документов и о ручной html-верстке, а сосредоточиться на главном: на содержании комплекса.

Список литературы:
1.    Положение об учебно-методическом комплексе дисциплины. КрасГАУ-СМК-П-7.3.1-2013. – [Электронный ресурс] ФГБОУ ВО «Красноярский ГАУ». – Режим доступа – URL: http://kgau.ru/new/student/32/lna/pol_umkd.pdf (Дата обращения: 11.01.16).
2.    Положение о модульно-рейтинговой системе подготовки студентов. КрасГАУ-СМК-П-7.5.1-2013. – [Электронный ресурс] ФГБОУ ВО «Красноярский ГАУ». – Режим доступа – URL: http://kgau.ru/new/student/32/lna/pol_mrs.pdf (Дата обращения: 11.01.16).
3.    Разработка документации при помощи DocBook. – [Электронный ресурс] Хабрахабр. – Режим доступа – URL: http://habrahabr.ru/post/212881/ (Дата обращения: 11.01.16).
4.    Острогорский М. Разработка технической документации на основе единого источника. – [Электронный ресурс] Компания «Философт». – Режим доступа – URL: http://www.philosoft.ru/ssth-01.zhtml (Дата обращения: 11.01.16).
5.    Визуальный XML редактор Syntext Serna. – [Электронный ресурс] Хабрахабр. – Режим доступа – URL: http://habrahabr.ru/post/112371 (Дата обращения: 11.01.16).
6.    Теория экономических информационных систем. Электронный учебно-методический комплекс. – [Электронный ресурс] ФГБОУ ВО «Красноярский ГАУ». – Режим доступа – URL: http://www.kgau.ru/istiki/istiki/teis/index.html (Дата обращения: 11.01.16).
7.    GPLv3: краткое руководство. – [Электронный ресурс] – Операционная система GNU. – Режим доступа – URL: http://www.gnu.org/licenses/quick-guide-gplv3.ru.html (Дата обращения: 11.01.16).
8.    Docbook – [Электронный ресурс] – Docbook. – Режим доступа – URL: http://www.docbook.org/ (Дата обращения: 11.01.16).
9.    Walsh N., Muellner L. DocBook: The Definitive Guide. – [Электронный ресурс] – Docbook. – Режим доступа – URL: http://www.docbook.org/tdg/en/html/docbook.html (Дата обращения: 11.01.16).
10.    Stayton B. DocBook XSL: The Complete Guide XSLT processors. – [Электронный ресурс] – Sagehill Enterprises. – Режим доступа – URL: http://www.sagehill.net/docbookxsl/OptionsPart.html (Дата обращения: 11.01.16).
11.    The xsltproc tool. – [Электронный ресурс] The XML C parser and toolkit of Gnome. – Режим доступа – URL: http://xmlsoft.org/XSLT/xsltproc2.html (Дата обращения: 11.01.16).