Create DocConverterKlen.adoc

This commit is contained in:
Юлия Болотина
2023-01-12 09:13:23 +03:00
commit 878de9fb44

248
DocConverterKlen.adoc Normal file
View File

@@ -0,0 +1,248 @@
= ИНСТРУКЦИЯ ПО ФОРМИРОВАНИЮ ПАКЕТОВ УЧЕБНЫХ МАТЕРИАЛОВ
:figure-caption: Рисунок
:table-caption: Таблица
:note-caption: Примечание
:imagesdir: ./images
:sectnums:
:toc:
:toc-title: Содержание
<<<
== ИСПОЛЬЗУЕМОЕ ПО. ЗАПУСК
Для формирования пакетов учебных материалов (далее ПУМ) используйте конвертер, который размещен на сервере: _________. Конвертер также можно загрузить из
https://msk.dinamika-avia.ru/redmine/issues/7326[Redmine].
Скопируйте программу на свое рабочее место.
Для открытия программы запустите файл «Converter.exe» (рис. 1).
Окно программы после запуска имеет вид, показанный на рис. 2.
.Файл «Converter.exe»
image::image01.png[100%, align="center"]
.Стартовое окно конвертера
image::image02.png[100%, align="center"]
<<<
== ЗАГРУЗКА СТРУКТУРЫ АУК ПОИСК ОШИБОК
Для открытия файла со структурой автоматизированного учебного курса (далее АУК) нажмите кнопку «Импортировать данные из файла Lyx» image:pic1.png[100%] . В появившемся системном окне выберите файл со структурой АУК и нажмите «Открыть».
Открытая в программе структура АУК показана на рис. 3.
[NOTE]
====
. Если модуль сценария имеет длинное название, то при попытке открытия оно будет обрезано. Перед работой в конвертере рекомендуется скопировать АУК на свое рабочее место.
. При повторном открытии конвертера по умолчанию будет открыт АУК, с которым велась работа в последний раз.
====
.Структура АУК
image::image03.png[100%, align="center"]
Для просмотра наличия ошибок в файле сценария нажмите по его названию в структуре АУК. В разделе «Ошибки импорта файла Lyx» при наличии ошибок будут выведены соответствующие данные (рис. 4):
* расположение файла сценария;
* результаты импорта.
.Отображение файла сценария. Раздел «Ошибки импорта файла Lyx»
image::image04.png[100%, align="center"]
Возможны следующие варианты отображения данных импорта:
* ошибки отсутствуют (рис. 5);
* ошибки некритичные (рис. 6) обозначаются серым цветом;
* в файле сценария есть ошибки, требующие устранения (рис. 7) обозначаются красным цветом.
В квадратных скобках рядом с ошибкой указывается строка файла сценария, в которой она обнаружена.
.Результат импорта: ошибки отсутствуют
image::image05.png[100%, align="center"]
.Результат импорта: есть некритичные ошибки
image::image06.png[100%, align="center"]
.Результат импорта: есть ошибки
image::image07.png[100%, align="center"]
Если ошибку невозможно отследить (визуально ее не видно) в редакторе «Lyx», откройте файл сценария в программе «Notepad» и перейдите к той строке, которая указана в описании ошибки.
После исправления ошибок в файлах сценариев нажмите кнопку «Обновить из Lyx файла» image:pic2.png[100%] . Убедитесь в том, что ошибки отсутствуют. Для проверки отсутствия ошибок необходимо просмотреть все модули сценариев, последовательно выбирая каждую ветку дерева АУК.
После проверки данных темы / раздела / модуля нажмите на значок image:pic3.png[100%] , чтобы вручную отметить в системе завершение проверки темы / раздела / модуля (рис. 8). Значок поменяет вид на image:pic4.png[100%] . Если метка устанавливалась в модуле сценария, то в дереве АУК с названия модуля будет снята метка image:pic3.png[100%] (рис. 9).
Если модуль сценария был обновлен, и в нем сохранились критические ошибки, то его метка вернется к виду image:pic3.png[100%] (см. рис. 8).
.Вид метки модуль не проверен
image::image08.png[100%, align="center"]
.Вид метки модуль проверен
image::image09.png[100%, align="center"]
<<<
== ПРОСМОТР ПУБЛИКАЦИИ
Для просмотра публикации в окне браузера нажмите кнопку «Открыть модуль в браузере» image:pic5.png[100%] (рис. 10), которая доступна только для модулей сценариев.
Просмотр сценариев посредством браузера обязательная процедура тестирования.
Возможность просматривать файлы с вопросами до их загрузки в систему управления обучением (далее СУО) отсутствует.
Пример окна просмотра публикации показан на рис. 11.
.Кнопка «Открыть модуль в браузере» на панели инструментов
image::image10.png[100%, align="center"]
.Просмотр публикации
image::image11.png[100%, align="center"]
В окне просмотра публикации отображается панель (см. рис. 11), которая открывается при нажатии левой кнопкой мыши по любой кнопке панели (рис. 12):
image:pic6.png[50, 50] список логических частей модуля сценария (для них при редактировании сценария в «Lyx» должен быть назначен стиль «Подподраздел*», см. «Создание сценариев АУК в редакторе «Lyx», п. 2.21);
image:pic7.png[50, 50] список рисунков сценария;
image:pic8.png[50, 50] список мультимедийных элементов (видео) сценария;
image:pic9.png[50, 50] список таблиц сценария.
Для перехода к любому элементу списка нажмите по его названию в списке.
Нажмите кнопку image:pic10.png[100%] , чтобы скрыть панель.
Для возврата к началу модуля сценария нажмите кнопку image:pic11.png[100%] внизу окна просмотра.
.Панель окна просмотра: список рисунков модуля сценария
image::image12.png[100%, align="center"]
Распространенные ошибки, которые встречаются в тексте сценария при его просмотре в браузере или конвертере, представлены в таблице 1.
.Наиболее распространенные ошибки в сценариях
[cols="2,^4,3"]
|===
|Тип ошибки
|Вид ошибки в сценарии
|Описание и причины ошибки. Способы ее устранения
|Некорректная ссылка на термин
|image:pic12.png[100%]
|Рядом с глоссарным термином появляется многоточие это означает, что ссылка на глоссарный термин введена в модуле, который в структуре курса располагается «ниже» текущего.
Введите термин в текущем модуле или модуле, который в структуре АУК располагается «выше».
.2+|Неверное оформление стиля для заголовка части модуля
|image:pic13.png[100%]
|При вызове панели не отображается заголовок выделенной части модуля. Это означает, что такой заголовок оформлен не стилем «Подподраздел*», а выделен полужирным.
В редакторе «Lyx» оформите заголовок стилем «Подподраздел*» (см. «Создание сценариев АУК в редакторе «Lyx», п. 2.21).
|image:pic14.png[100%]
<|Перед заголовком части модуля указано «\series bold». Это означает, что к заголовку применили формат «полужирный».
Примените в «Lyx» для заголовка сначала формат «Обычный» (чтобы снять все стили), а затем «Подподраздел*» (см. «Создание сценариев АУК в редакторе «Lyx», п. 2.21).
|Неверное оформление стиля для рисунка
|image:pic15.png[100%]
|В конвертере в разделе ошибок отображается описание ошибки с меткой «fig». Это означает, что для указанного рисунка применен неверный стиль.
Поставьте курсор в начало строки с объектом «рисунок» и выберите стиль «Обычный».
|Неверное оформление стиля для таблицы
|image:pic16.png[100%]
|В конвертере в разделе ошибок отображается описание ошибки с меткой «tab». Это означает, что для указанной таблицы применен неверный стиль.
Поставьте курсор в начало строки с объектом «таблица» и выберите стиль «Обычный».
|===
<<<
== ЗАПОЛНЕНИЕ СЛУЖЕБНЫХ ДАННЫХ
В разделе программы «Публикация» информационные поля, требующие заполнения, подсвечены розовым цветом (рис. 13-15).
Заполнение данных полей осуществляется автоматически для каждой темы / раздела / модуля в отдельности при нажатии кнопки «Сформировать пакеты выходных данных» . После нажатия кнопки перейдите к выполнению п. 5.1.
Если в окне конвертера были изменены названия тем / разделов / модулей (поля «Титул» или «Техническое имя»), то эти изменения попадут только в публикацию, названия в исходных файлах останутся прежними.
.Раздел «Публикация» для уровня темы АУК
image::image13.png[100%, align="center"]
.Раздел «Публикация» для уровня раздела АУК
image::image14.png[100%, align="center"]
.Раздел «Публикация» для уровня модуля АУК
image::image15.png[100%, align="center"]
<<<
== ФОРМИРОВАНИЕ ПАКЕТОВ ВЫХОДНЫХ ДАННЫХ
=== Конфигурирование пакетов
Для формирования пакетов выходных данных на панели инструментов нажмите кнопку «Сформировать пакеты выходных данных» image:pic17.png[100%] . Откроется окно «Формирование и конфигурирование пакетов» (рис. 16).
При обнаружении ошибки будет выведено сообщение (рис. 17). Нажмите «ОК».
[NOTE]
====
Если в конвертере для модуля сценария или файла с вопросами метка image:pic3.png[100%] не была изменена на image:pic4.png[100%] , то в окне конфигурирования пакетов напротив соответствующего сценария будет стоять значок image:pic18.png[100%] (см. рис. 16).
====
.Окно «Формирование и конфигурирование пакетов»
image::image16.png[100%, align="center"]
.Пример окна с сообщением об ошибке
image::image17.png[100%, align="center"]
Для добавления пакета необходимо последовательно выполнить следующие шаги.
. В поле «Имя конфигурации пакета» введите его краткое обозначение.
Имя конфигурации пакета это название категории обучаемых.
Имя конфигурации пакета не должно содержать символы русского языка и пробелы.
В одном пакете нельзя указывать одновременно две категории обучаемых.
Рекомендуемые имена для конфигурации пакета приведены в таблице 2.
=== Формирование пакетов учебных материалов в оконном режиме
=== Формирование пакетов учебных материалов в консольном режиме
<<<
== ПОДКЛЮЧЕНИЕ ПУМ В СУО. ПРОСМОТР АУК
Текст.
Пусть здесь будет начинаться текст.
Тут текст продолжается.
*Жирный текст*
_Курсив_
Нумерованный список:
. Первый.
. Второй:
.. с третьего по пятый:
... с пятого по девятый;
. Десятый.
Ненумерованный список:
* пункт;
* пункт:
** подпункт;
** подпункт:
*** мини:
**** микро;
* пункт.
https://oc.msk.dinamika-avia.ru[Облачко]
image::test.png[100%,align="center"]