Файл: Разработать справочную систему по стандартным функциям выбранного языка программирования ( С++).pdf
Добавлен: 01.04.2023
Просмотров: 192
Скачиваний: 3
Остальной набор стандартных функций остался без изменений по сравнению с предыдущей версией, перечень самих функций реализован в справочной системе и представлен в виде приложения А.
2.ТЕХНОЛОГИЯ СОЗДАНИЯ СПРАВОЧНОГО РУКОВОДСТВА
При помощи Dr.Explain вы можете легко создавать документацию как для обычных, так и онлайн-приложений, написанных на любом языке программирования, в любой среде разработки, с применением любого фреймворка
Dr.Explain захватывает окна запущенных приложений или загруженных сайтов и автоматически распознает контролы. Программа автоматически создает аннотированные скриншоты с нумерованными выносками и метками. По сравнению с другими инструментами создания справок, эта уникальная технология позволяет гораздо быстрее создавать документацию для приложений со сложными интерфейсами.
С легкостью управляет текстами, техническими иллюстрациями и аннотированными скриншотами. Задает гибкую структуру документа, контента и разделов. Встраивает поддержку индексов ключевых слов и возможность полнотекстового поиска без программирования или создания скриптов на стороне сервера. Связывает разделы с модулями приложений для создания контекстно-зависимых справок.
Dr.Explain поддерживает множество форматов вывода для единого источника.
Использует один источник и один инструмент для создания файлов помощи, онлайн-руководств или готовой к печати документации для любого программного обеспечения. Генерирует онлайн-руководства со встроенным поиском без использования программирования, баз данных или скриптов. Компилирует файлы помощи в формате Microsoft HTML в формат CHM для включения их в пакет поставки ПО. Создает готовую к печати кроссплатформенную документацию в форматах RTF и PDF.
2.1 Настройка программы для создания справки
Для создания справочного руководства необходимо запустить приложение Dr.Explain удобным способом. При каждом запуске Dr.Explain автоматически показывается стартовый диалог, который позволяет начать новый проект, импортировать существующий документ или открыть недавний файл проекта
Рисунок 2.1 – Стартовое окно приложения
-
- Создать локальный проект - начать работу над новым локальным проектом
- Создать новый общий проект - создать новый общий проект на сервере tiwri.com.
- Забрать общий проект - Забрать общий проект с сервера tiwri.com.
- Создать локальный проект - Руководство пользователя по ГОСТ 34
Используя эту кнопку, можно создать руководство пользователя в соответствии с требованиями ГОСТ.
Начиная с версии 5.5.1100, программа для создания пользовательской документации Dr.Explain предлагает функцию автоматизированной поддержки ГОСТ в проектах.
При включенном режиме поддержки ГОСТ для проекта соответствующие настройки для печатаемых форматов RTF\DOC и PDF автоматически перекрываются программой, что гарантирует полное соответствие параметров выходных документов требованиям стандартов.
-
- Создать общий проект на tiwri.com - Руководство пользователя по ГОСТ 34
Используя эту кнопку, можно создать руководство пользователя в соответствии с требованиями ГОСТ. Будет создан новый общий проект на сервере tiwri.com.
6. Открыть существующий проект – позволяет открыть ранее созданный проект из папки сохранения проектов
7.Импорт – позволяет выбрать формат для готового проекта из предложенных
Рисунок 2.2 – Окно импорта проекта
После выбора исходного формата в списке вам будет предложено выбрать исходный файл или папку для импорта.
8. Список проектов - этот раздел содержит список недавних проектов. Общие проекты отмечены синим цветом.
Рисунок 2.3- Окно списка проектов
Для настройки приложения для удачной работы необходимо задать основные настройки. Для этого нужно выполнить команду главного меню «Настройки –Настройки приложения»
Рисунок 2.4 - Окно настроек приложения
При помощи данного окна настраиваются минимальные и достаточные свойства приложения для эффективной работы над проектом: указывается настройка стартового окна, автосохранение проекта, место для хранения готового проекта, каталог захвата сценариев и настраивается ассистент для работы с SWING-приложениями java.
Для настройки самого проекта и его свойств используют другое окно настроек.
Настройки проекта позволяют изменять параметры только текущего проекта.
Диалог настроек проекта можно открыть тремя способами:
- нажав кнопку на панели инструментов приложения;
- с помощью сочетания клавиш Ctrl+Alt+P;
- перейдя в меню «Настройки» и выбрав пункт «Настройки проекта».
Рисунок 2.5- Окно настроек проекта
В разделе «Настройки проекта» разрешено настраивать следующие параметры:
Общие настройки
В разделе общих настроек можно включить автоматическую поддержку требований ГОСТ 19 и ГОСТ 34, а также задать алгоритм именования новых разделов.
- Автоматическая поддержка требований ГОСТ 19 и ГОСТ 34
Включив эту опцию, можно создать руководство пользователя в соответствии с требованиями ГОСТ.
- Обозначение документа для верхнего колонтитула
Заполнив текст, который выводится в верхнем колонтитуле каждой страницы документа, созданного в режиме поддержки ГОСТ.
- Генерировать имена файлов по относительной нумерации
Выбрав эту опцию, имена файлов генерируются с использованием относительной нумерации (как в старых версиях программы Dr.Explain).
- Генерировать имена файлов по заголовкам разделов
Выбрав эту опцию, программа генерирует имена файлов согласно их заголовкам.
- Автоматическая нумерация разделов
Установив этот флаг, можно включить автоматическую нумерацию для разделов проекта.
- Исключить нумерацию из контента
Установив этот параметр, можно показывать номера разделов только в оглавлении, в списках разделов и в результатах поиска.
- Уровень вложенности разделов
Нажатием на кнопки с номерами определяете уровень вложенности разделов, который хотите настроить.
- Тип нумерации
В раскрывающемся списке выбирается тип нумерации для выбранного уровня вложенности разделов.
- Тип разделителя
В раскрывающемся списке указывается тип разделителя для выбранного уровня вложенности разделов
- Скрывать разделитель в конце номера
Используя этот параметр, можно включить или отключить знак разделителя в конце номера для выбранного уровня вложенности разделов.
- Присоединение предыдущего уровня
Сняв этот флаг, возможно исключить номер родительского уровня из номера текущего уровня
- Предварительный просмотр
Область предварительного просмотра отображает стиль нумерации всех уровней одновременно. Текущий выбранный уровень окрашен в черный цвет.
При каждом запуске Dr.Explain автоматически показывается стартовый диалог, который позволяет начать новый проект, импортировать существующий документ или открыть недавний файл проекта.
Главное окно программы Dr.Explain позволяет управлять элементами проекта. Здесь вы можете создавать новые проекты, добавлять новые элементы, а также изменять настройки программы и проекта.
Рисунок 2.6- Главное окно работы над проектом
На главном окне работы над проектом расположены:
- Главное меню;
- Панель инструментов;
- Панель закладок
Главная панель инструментов Dr.Explain обеспечивает быстрый доступ к ключевым функциям программы.
Панель инструментов главного окна имеет вид (см. рисунок 2.7)
Рисунок 2.7- панель инструментов главного окна
где
•
— создать новый проект.
•
— открыть существующий проект.
•
— сохранить текущий проект.
•
— зафиксировать все изменения на сервере при совместной работе над проектом.
•
— обновить проект и получить изменения с сервера при совместной работе над проектом.
•
— главная кнопка программы Dr.Explain. Нажав на нее для захвата нового окна, обработки его структуры и добавления нового скриншота окна и всех его контролов в проект. Выпадающее меню позволяет добавлять скриншот из сохраненного на диске графического файла или буфера обмена.
•
— вставить новый раздел или импортировать в проект внешние файлы.
•
— вырезать выбранный элемент из дерева разделов проекта и скопировать его в буфер обмена.
•
— скопировать выбранный элемент дерева разделов проекта или текст в буфер обмена.
•
— вставить элемент из буфера обмена в дерево разделов проекта или редактор контента.
•
— экспортировать текущий проект в HTML-справку.
•
— экспортировать текущий проект в файл CHM.
•
— экспортировать текущий проект в файл RTF.
•
— экспортировать текущий проект в файл PDF.
•
— настроить параметры текущего проекта. Для получения дополнительной информации обратитесь к разделу Настройки проекта.
•
— показать информацию о программе Dr.Explain и регистрации продукта.
Закладки позволяют быстро переключаться между режимами редактирования и предпросмотра.
Рисунок 2.8 – Панель закладок
Редактор контента -это основная рабочая область в Dr.Explain. Редактор позволяет редактировать контент разделов в стиле WYSIWYG.
Дерево разделов - отображает структуру проекта и позволяет быстро переключаться между его элементами: разделами и страницами анотированных экранов.
Используйте контекстное меню для добавления новых разделов в проект, переименования, удаления, отключения или перераспределения разделов.
Используйте сочетания клавиш Ctrl+Up и Ctrl+Down для изменения порядка дочерних элементов раздела.
Панель свойств раздела и ключевых слов - эта панель позволяет управлять свойствами раздела и ключевыми словами.
Панель статуса - показывает статус и прогресс по текущим операциям. Панель статуса также отображает подсказки при наведении курсора на кнопки в панели инструментах или пункты меню.
Чтобы создать новый проект, необходимо выполнить один из вариантов действий:
- использовать стартовый диалог;
- нажать кнопку на панели инструментов;
- перейти в меню «Файл» и выбрать команду «Создать»;
- использовать комбинацию Ctrl+N
После этого вы можете добавлять новые разделы и страницы со скриншотами в проект.
После добавления всех разделов не забудьте сохранить проект.
Тексты в Dr.Explain можно редактировать так же, как в любом текстовом редакторе. Вы можете либо редактировать формат (шрифт, размер, цвет) вручную, либо настроить стили для вашего проекта.
Создание или добавление разделов – это наиболее частое действие, с которым придется столкнуться при работе с оглавлением. Оно похоже на создание новых документов в обычных текстовых редакторах. После создания раздела можете добавлять в него текст и прочие материалы, а также перемещать его в пределах оглавления.
Чтобы добавить новый раздел на текущем уровне, наведите курсор на раздел более высокого уровня и выберите его. Если выберете произвольный раздел и создадите новый, то новый будет создан как подраздел выбранного раздела.