Для студентов РУДН по предмету ДругиеИнтеграция технологии DocLine в Adobe FrameMakerИнтеграция технологии DocLine в Adobe FrameMaker
2024-06-292024-06-29СтудИзба
Курсовая работа: Интеграция технологии DocLine в Adobe FrameMaker
Описание
Содержание
Введение............................................................................................................................................. 5
Постановка задачи.............................................................................................................................. 7
Глава 1. Обзор предметной области................................................................................................ 8
Продукт Adobe FrameMaker........................................................................................................... 8
Структурный режим.................................................................................................................... 8
Книга........................................................................................................................................... 10
Технология DocBook..................................................................................................................... 10
Реализация в Adobe FrameMaker............................................................................................. 10
Технология DITA............................................................................................................................ 11
Реализация в Adobe FrameMaker............................................................................................. 11
Технология DocLine....................................................................................................................... 12
Язык DRL/PR............................................................................................................................... 12
Инструмент для Eclipse............................................................................................................. 18
Обзор средств интеграции с Adobe FrameMaker....................................................................... 19
Структурное приложение......................................................................................................... 19
FDK.............................................................................................................................................. 21
Глава 2. Проект DocLineFM.............................................................................................................. 22
Представление DRL‐документации в Adobe FrameMaker......................................................... 22
Структурное приложение DocLine............................................................................................... 23
Архитектура плагина..................................................................................................................... 24
Модуль DocLine......................................................................................................................... 24
Модуль сервисных функций.................................................................................................... 25
Java‐модуль................................................................................................................................ 26
XSL‐преобразования.................................................................................................................. 26
3
Описание функциональности плагина........................................................................................ 26
Глава 3. Архитектурные решения.................................................................................................... 28
Адаптация языка DRL/PR для Adobe FrameMaker...................................................................... 28
Импортирование........................................................................................................................... 29
Экспортирование.......................................................................................................................... 32
Глава 4. Повышение скорости работы и обеспечение стабильности.......................................... 34
Повышение скорости работы плагина........................................................................................ 34
Повышение стабильности работы плагина................................................................................ 36
Заключение....................................................................................................................................... 38
Список литературы........................................................................................................................... 38
Приложение 1. Глоссарий................................................................................................................ 40
4
Введение
Во всех областях в современном мире применяется различное программное обеспечение – от огромных информационных систем до небольших скриптов, автоматизирующих какие‐ либо действия. И если приложение не пишется одним разработчиком для собственного использования, оно требует наличия документации. Для небольшого продукта документацию можно представить в виде простого текстового файла, прилагающегося вместе с программой. Но для более крупных проектов это будет уже неудобно. Для создания документации можно использовать распространенные текстовые редакторы, такие как Microsoft Word. Последний предоставляет довольно большие возможности для редактирования оформления текста и при этом не требует почти никакого специального обучения – Microsoft Word умеет пользоваться практически любой человек. Но, начиная с какого‐то объема документации, Microsoft Word уже не может полноценно использоваться для создания технической документации. И проблема не столько в недостатке какой‐либо функциональности, сколько в его непредсказуемой и нестабильной
Введение............................................................................................................................................. 5
Постановка задачи.............................................................................................................................. 7
Глава 1. Обзор предметной области................................................................................................ 8
Продукт Adobe FrameMaker........................................................................................................... 8
Структурный режим.................................................................................................................... 8
Книга........................................................................................................................................... 10
Технология DocBook..................................................................................................................... 10
Реализация в Adobe FrameMaker............................................................................................. 10
Технология DITA............................................................................................................................ 11
Реализация в Adobe FrameMaker............................................................................................. 11
Технология DocLine....................................................................................................................... 12
Язык DRL/PR............................................................................................................................... 12
Инструмент для Eclipse............................................................................................................. 18
Обзор средств интеграции с Adobe FrameMaker....................................................................... 19
Структурное приложение......................................................................................................... 19
FDK.............................................................................................................................................. 21
Глава 2. Проект DocLineFM.............................................................................................................. 22
Представление DRL‐документации в Adobe FrameMaker......................................................... 22
Структурное приложение DocLine............................................................................................... 23
Архитектура плагина..................................................................................................................... 24
Модуль DocLine......................................................................................................................... 24
Модуль сервисных функций.................................................................................................... 25
Java‐модуль................................................................................................................................ 26
XSL‐преобразования.................................................................................................................. 26
3
Описание функциональности плагина........................................................................................ 26
Глава 3. Архитектурные решения.................................................................................................... 28
Адаптация языка DRL/PR для Adobe FrameMaker...................................................................... 28
Импортирование........................................................................................................................... 29
Экспортирование.......................................................................................................................... 32
Глава 4. Повышение скорости работы и обеспечение стабильности.......................................... 34
Повышение скорости работы плагина........................................................................................ 34
Повышение стабильности работы плагина................................................................................ 36
Заключение....................................................................................................................................... 38
Список литературы........................................................................................................................... 38
Приложение 1. Глоссарий................................................................................................................ 40
4
Введение
Во всех областях в современном мире применяется различное программное обеспечение – от огромных информационных систем до небольших скриптов, автоматизирующих какие‐ либо действия. И если приложение не пишется одним разработчиком для собственного использования, оно требует наличия документации. Для небольшого продукта документацию можно представить в виде простого текстового файла, прилагающегося вместе с программой. Но для более крупных проектов это будет уже неудобно. Для создания документации можно использовать распространенные текстовые редакторы, такие как Microsoft Word. Последний предоставляет довольно большие возможности для редактирования оформления текста и при этом не требует почти никакого специального обучения – Microsoft Word умеет пользоваться практически любой человек. Но, начиная с какого‐то объема документации, Microsoft Word уже не может полноценно использоваться для создания технической документации. И проблема не столько в недостатке какой‐либо функциональности, сколько в его непредсказуемой и нестабильной
Характеристики курсовой работы
Список файлов
Интеграция технологии DocLine в Adobe FrameMaker.doc