Файл: Методические рекомендации по созданию интерактивных электронных технических руководств в системе автоматизированной подготовки иэтр tg builder.pdf

Документ подписан простой электронной подписью
Информация о владельце:
ФИО: Локтионова Оксана Геннадьевна
Должность: проректор по учебной работе
Дата подписания: 28.01.2021 15:58:40
Уникальный программный ключ:
0b817ca911e6668abb13a5d426d39e5f1c11eabbf73e943df4a4851fda56d089

УДК 658.52.011.56; 65.011.56
Составитель: С.А. Чевычелов
Рецензент
Кандидат технических наук, доцент В.В. Куц
Создание
интерактивных
электронных
технических
руководств: Методические указания к выполнению лабораторной работы по дисциплинам «Теоретические основы CALS-технологий» и «Информационная поддержка жизненного цикла продукции
(CALS-технологии)» / cост.: С.А. Чевычелов; Юго-Зап. гос. ун-т.
Курск, 2012. 26 с.: ил. 28. Библиогр.: с. 26.
Излагаются методические рекомендации по созданию интерактивных электронных технических руководств в системе автоматизированной подготовки ИЭТР TG Builder.
Предназначены для студентов направления подготовки 151900.62 и студентов специальностей 151001.65 и 151003.65 .
Текст печатается в авторской редакции
Подписано в печать . Формат 60х84 1/16.
Усл. печ. л. . Уч.-изд. л. . Тираж 100 экз. Заказ Бесплатно.
Юго-Западный государственный университет
305040, г. Курск, ул. 50 лет Октября, 94.

Цель
работы: изучить возможности системы автоматизированной подготовки интерактивных электронных технических руководствTG Builder.
Задание: на основе бумажного руководства по эксплуатации создать его электронную версию.
TG Builder – это система автоматизированной подготовки интерактивных электронных технических руководств.
Функциональность TG Builder обеспечивает возможность работы коллектива авторов, планирования работ и обмена данными между разработчиками, кроме того, использование СУБД Oracle для хранения подготовленной документации обеспечивает возможность подготовки руководств огромного размера.
Более того, это тесная интеграция с PDM системами и различными офисными приложениями. Возможности синхронизации между PDM и TG Builder позволяют в значительной степени уменьшить объем работ и вероятность внесения в руководство некорректных данных.
К основным особенностям данного программного продукта следует отнести:
Подготовленные руководства соответствуют стандартам ISO
8879 (SGML), MIL 87268, MIL 87269.
Возможность работы над руководством коллектива авторов, включая планирование работ и обмен информацией по сети.
Четкое разделение прав пользователей, контроль доступа к данным.
Централизованное администрирование системы.
Интеграция с PDM системами и офисными приложениями.
Возможность использования в руководствах помимо текстовых и графических данных аудио /видео роликов и трехмерных моделей.
Сценарий лабораторной работы
1. Создание нового проекта (рис. 1)
Проектом по созданию интерактивного руководства называется руководящее указание в электронном виде, которое определяет

инициирование работ по подготовке интерактивного руководства, назначает исполнителей и сроки проведения работ.
Рис. 1
2. Редактирование структуры руководства
После инициализации работ по подготовке технической документации, создается структура будущего руководства, в которую на последующих этапах вносится информационное наполнение в редакторе глав руководства.
3. Редактирование глав руководства
В систему подготовки технических руководств встроен специальный текстовый редактор. С помощью этого редактора можно создавать и редактировать главы руководства, а также
1. Создание нового объекта
2. Редактирование структуры руководства
3. Редактирование глав руководства
3.3.
Предварительный просмотр руководства
4. Экспорт созданного руководства в один из двух форматов (HTML или бинарный)
3.1. Работа с текстом
3.2. Работа с изображениями
3.1.1. Создание гипертекстовых ссылок с фрагментов текста на другие разделы руководства
3.1.2. Создание ссылок с фрагментов иллюстраций на другие разделы руководства

составлять вспомогательные документы, сообщения электронной почты.
Задача подготовки глав руководства может быть поделена на две подзадачи:
1. Работа с текстом (пункт 3.1.). Информационное наполнение разделов электронного руководства может быть осуществлено следующими способами: или непосредственная перепечатка текста бумажного руководства в текстовом редакторе TG Builder или сканирование текста с последующим распознаванием текста и вставкой этих отсканированных фрагментов в редактор, где возможно их редактирование; или вставка текста из готовых файлов.
2. Работа с изображениями (пункт 3.2.). Как и при работе с текстом изображения могут быть получены путем сканирования и вставлены в электронное руководство.
Одной из задач при работе с текстом является создание ссылок с фрагментов текста на другие разделы руководства (пункт 3.1.1.), а при работе с изображениями простановка ссылок с частей изображения на другие разделы руководства и организация так называемых карт ссылок (пункт 3.1.2.).
3.3. Предварительный просмотр
В процессе создания руководства можно осуществить предварительный просмотр проекта.
4. Экспорт разделов
После того, как руководство создано, можно экспортировать в один из форматов, (бинарный формат (сопровождается средством автономного просмотра) или формат HTML).
Порядок выполнения работы
После установки на экране появляется главное окно TG Builder
(рис. 2).
Для запуска Диспетчера проектов нажимаем пиктограмму:
На экране появится окно Диспетчера проектов (рис. 3).

Рис. 2
Рис. 3

В окне диспетчера отображается информация о базовых обозначениях проекта, руководители проекта, списки исполнителей проекта и материалах для разработки. Конфигурацию окна диспетчера можно изменить, передвигая разделительные полосы между списками.
1. Создание нового проекта
Для того, чтобы сформировать новый проект, необходимо нажать на кнопку на функциональной панели диспетчера проектов откроется мастер формирования нового проекта (рис. 4), который в 4 этапа сформирует новый проект.
На первом шаге необходимо ввести название проекта, обозначение и наименование изделия, бортовой номер, здесь же необходимо выбрать базовое описание структуры документа (DTD) для всех документов проекта.
Рис. 4
По завершении ввода параметров, необходимо нажать кнопку
«Далее», а чтобы прервать работу мастера - кнопку «Отмена».

На втором шаге вводятся параметры основной задачи, ассоциированной со всем проектом в целом. Описываются название задачи, связанной с проектом в целом, дату начала и конца работы над проектом (рис. 5). Индикатор выполнения по умолчанию выставлен в значение «Работа не начата», если это не так, необходимо изменить его.
Рис. 5
Рис. 6

На третьем этапе необходимо определить список сотрудников, которые будут назначены к исполнению этой задачи.
Чтобы добавить пользователя необходимо нажать кнопку
, либо дважды щелкнуть левой кнопкой мыши на белом фоне окна
(рис. 6).
Рис. 7
Рис. 8
Необходимо выбрать iemu, нажать Выбрать (рис. 7).

Нажмите Готово (рис. 8). Откроется окно диспетчера проекта, в котором отображается сформированный проект (рис. 9).
Рис. 9
2. Редактирование структуры руководства
Для входа в редактор структуры руководства в диспетчере проектов левой кнопкой мыши необходимо выделить проект и нажать на кнопку
Создается корневой раздел руководства (рис. 10).
Декомпозиция разделов.
Структура руководства представляет собой иерархию разделов.
Для построения этой иерархии используется операция декомпозиции

раздела – то есть открытия его дочерних разделов (глав), состав которых удовлетворяет общему DTD проекта. Для декомпозиции раздела, необходимо нажать кнопку декомпозиции, которая находится в левой части прямоугольника обозначающего раздел.
Рис. 10
Для данного DTD иерархию структуры образуют разделы
(обозначаются синим цветом), которые могут содержать подразделы
(обозначаются зеленым цветом), являющиеся терминальными элементами иерархии. На прямоугольниках, обозначающих разделы и подразделы, находятся названия разделов (подразделов) (рис. 11).
Помимо обозначений разделов и глав в структуре встречаются так называемые индикаторы языка SGML, которые определяют количество дочерних разделов у заданного раздела.
Удалить элемент можно при помощи кнопки на панели инструментов TG Builder. Все разделы в редакторе структуры

выглядит одинаково – прямоугольники с названиями, но на самом деле каждый раздел относится к одному и только одному типу, который определяется декларацией элемента SGML – декларация элемента определяет правила, по которым разрешается создавать дочерние элементы раздела.
Рис. 11
3. Редактирование глав руководства
После того, как разработана структура руководства, необходимо перейти непосредственно к созданию глав руководства.
3.1 Работа с текстом
В систему подготовки технических руководств встроен специальный текстовый редактор.
Чтобы попасть в редактор необходимо:

1.
Выделить раздел, который необходимо редактировать: подвести курсор к нужному разделу и мышкой выделить его. В редактор можно попасть только с конечных терминальных элементов, которые в структуре руководства помечены зеленым цветом.
2.
Двойным щелчком левой кнопки «мыши» по выбранному разделу можно попасть в текстовый редактор.
На рис. 12 приведен пример подраздела, находящегося на редактировании.
Рис. 12
3.1.1 Ссылки с фрагментов текста
Возможность создавать и использовать гипертекстовые ссылки
– одна из специфических черт рассматриваемого редактора,

делающего его применимым к задаче построения технической документации. Ссылки позволяют пользователю, просматривающему документы, быстро попадать из одних разделов в другие, переходить от описаний узлов к чертежам и т. д. Для того, чтобы установить ссылку из некоторого текста на другой раздел, необходимо выделить текст, нажать правую кнопку мыши и выбрать пункт всплывающего меню «Установить ссылку» (рис. 13).
В появившемся окне необходимо выбрать соответствующий раздел (рис. 14).
Рис. 13
3.2. Работа с изображениями
Следующий этап разработки руководства – включение в руководство изображений из файлов. Для того чтобы вставить изображение в TG Builder необходимо:

Рис. 14 1. На панели инструментов редактора нажать на кнопку
2. Выбрать пункт
3. Открыть папку, где хранится вставляемое изображение.
4. Вставить изображение.
3.2.1 Ссылки с фрагментов изображения
Редактор позволяет устанавливать ссылки с частей изображения на другие разделы руководства – организации так называемых карт ссылок.
1.
Необходимо взять изображение и вставить в документ, щелчком левой кнопки мыши на изображении выделить его, нажать правую кнопку, выбирать «Размеры блока» (рис. 15).
2.
Установить размеры блока (рисунка) (рис. 16):
3.
Взять блок в таблицу – щелчком левой кнопки мыши на изображении выделить его, нажать правую кнопку, выбрать «Взять в таблицу» (рис. 17):

4.
Установить размеры ячеек,
(размер ячейки устанавливается больше размера рисунка приблизительно на 20-30
%) – нажатием левой кнопки мыши (обязательно на границе таблицы), выделить таблицу с рисунком, нажать правую кнопку, в появившемся окне выбирать «Размеры ячеек» (рис. 18). Задать размеры ячеек (рис. 19).
Рис. 15
Рис. 16

Рис. 17 5.
Привязать рисунок (к левому верхнему углу) (рис. 20).
6.
Создать таблицу, состоящую из одной ячейки. Эту новую таблицу необходимо разместить в таблице, в которой находится изображение. Для этого установить курсор в таблице с изображением. Нажать на кнопку «Создать таблицу» на панели инструментов редактора, задать параметры таблицы. Размер ячейки берется таким, чтобы в эту ячейку поместилась та часть изображения, с которой необходимо установить ссылку. В нашем случае (столбцов – 1, строк – 1, ширина столбцов – 50) (рис. 21).

Рис. 18
Рис. 19

Рис. 20
Рис. 21 7.
Аналогично пункту 5 установить привязку таблицы к левому верхнему углу (рис. 22).

Рис. 22 8.
Выделить созданную ячейку (нажать мышкой на границе), выбирать пункт «Свойства ячеек» (рис. 23) и в появившемся окне выбирать «нет рамки» (рис. 24).
9.
Включить невидимые символы, нажав « » (рис. 25).
10. Указать часть изображения, с которой планируется сделать ссылку: удерживая кнопку Ctrl, подвести «стрелку» к границе ячейки, нажать левую кнопку мыши, перенести ячейку на ту часть изображения, на которую необходимо установить ссылку (рис. 25).
11. Нажимая правой кнопкой мыши на рамке таблицы, выбрать опцию «Установить ссылку» (рис. 26).

Рис. 23
Рис. 24

Рис. 25 12. Выбирать раздел, на который необходимо установить ссылку (рис. 27).
3.3 Предварительный просмотр
В процессе создания руководства можно осуществлять предварительный просмотр проекта. Для этого необходимо: войти в
«Менеджер проектов», нажать на кнопку «Предварительный просмотр».

4. Экспорт разделов
После того, как руководство создано, его можно экспортировать в один из форматов (бинарный формат или формат HTML).
Для экспорта выбранного раздела его необходимо выделить и нажать кнопку «Экспорт». После этого появится окно «Экспорт документации» (рис. 28).
Пользователь может выбрать целевой формат экспортируемого документа в верхней части окна, а также целевой каталог, в который будет произведен экспорт. Выбор диска производится с помощью выпадающего списка. Справа от выпадающего списка указывается наименование каталога, в который будет произведен экспорт. Для экспортирования документации необходимо выбрать каталог, указать целевой формат и нажать кнопку «Экспортировать».
Рис. 26